ListServiceControlPolicies - 获取管控策略列表--企业组织-火山引擎

文档中心

立即注册

导航

ListServiceControlPolicies - 获取管控策略列表

最近更新时间：2025.06.23 10:37:25首次发布时间：2024.01.11 17:42:36

获取管控策略列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListServiceControlPolicies	要执行的操作，取值：ListServiceControlPolicies。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
SortBy	String	否	CreateDate	排序依据，CreateDate \| UpdateDate
SortOrder	String	否	Desc	排序顺序，Desc \| Asc
PolicyType	String	否	System	策略类型，System: 系统策略\|Custom: 自定义策略
Query	String	否	your_policy_name	查询字符串策略名称或备注模糊匹配
PageSize	Integer	否	10	分页大小，默认 10，最大 100
PageNumber	Integer	否	1	页数，默认 1

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageSize	Integer	10	分页大小
PageNumber	Integer	1	页数
TotalCount	Integer	100	总数
ServiceControlPolicies	Array of Object		控制策略详情

请求示例

GET /?Action= ListServiceControlPolicies&Version=2022-01-01

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202205191150550102252431470183A0D5",
        "Action":"",
        "Version":"2020-01-01",
        "Service":"organization"
    },
    "Result":{
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 20,
        "ServiceControlPolicies": [
            {
                "PolicyID": "",
                "PolicyName": "",
                "PolicyType": "Custom",
                "CreateDate": "2021-08-16T09:48:19Z",
                "UpdateDate": "2021-08-16T09:48:19Z",
                "Description": ""
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	PermissionError	No permission to perform action[%s] on resource %s	无权限，没有对该资源进行该操作的权限
400	InvalidParam	The parameter %v[%v] is invalid.	参数不合法
500	InternalError	Unknown internal error: %v	未知错误，根据错误信息判断详情