查询组织策略试运行的配置 - ShowDryRunConfig
功能介绍
查询组织策略试运行的配置。此操作只能由组织的管理或云服务委托管理员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:policies:getDryRunConfig
Read
root *
g:ResourceTag/<tag-key>
-
-
URI
GET /v1/organizations/dry-run-config
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| root_id | 是 | String | 参数解释: 根的唯一标识符(ID)。可通过调用列出根API获取。 约束限制: 不涉及 取值范围: 符合正则表达式:^r-[0-9a-z]{4,32}$ 最小长度6、最大长度34。 默认取值: 不涉及 |
| policy_type | 是 | String | 参数解释: 试运行策略的类型名称。service_control_policy:服务控制策略。 约束限制: 不涉及 取值范围: 枚举值:"service_control_policy"。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。通过IAM服务的获取临时访问密钥接口获取临时安全凭据。 约束限制: 不涉及 取值范围: 不涉及字符类型限制。 最小长度0、最大长度32768。 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| root | DryRunConfigDto object | 参数解释: 策略试运行的配置信息。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| root_id | String | 参数解释: 根的唯一标识符(ID)。 取值范围: 符合正则表达式:^r-[0-9a-z]{4,32}$ 最大长度34。 |
| status | String | 参数解释: 策略试运行的开启状态。enabled:启用;pending_enable:启用中;disabled:禁用;pending_disable:禁用中。 取值范围: 枚举值:"enabled"、"pending_enable"、"disabled"、"pending_disable"。 |
| bucket_name | String | 参数解释: 用户桶名称。 取值范围: 符合正则表达式:^[a-z0-9-.]*$ 最小长度0、最大长度64。 |
| region_id | String | 参数解释: 用户桶所在的region。 取值范围: 符合正则表达式:^[\w-]*$ 最小长度0、最大长度64。 |
| bucket_prefix | String | 参数解释: 用户桶的前缀。 取值范围: 符合正则表达式:^(?![./])(?!.//)(?!.[\:?"<>|\u201c\u201d\uff1f\uff0f\uff3c\uff02\uff1c\uff1e\uff1a\uff5c\uff0a])(.?)(?<![./])$。最小长度0、最大长度256。 |
| agency_name | String | 参数解释: 委托名称。Organizations服务通过此委托将试运行日志写入用户obs桶。 取值范围: 符合正则表达式:^[\w+=,.@-]*$。最小长度0、最大长度64。 |
| policy_type | String | 参数解释: 试运行策略的类型名称。service_control_policy:服务控制策略。 取值范围: 枚举值:"service_control_policy" |
| created_at | String | 参数解释: 策略试运行配置的开启时间。UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ,如2022-08-24T06:31:46Z。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 策略试运行配置的更新时间。UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ,如2022-08-24T06:31:46Z。 取值范围: 不涉及。 |
请求示例
查询组织策略试运行的配置
GET https://{endpoint}/v1/organizations/dry-run-config?root_id=r-o1qqtqfo7xl427v7g&policy_type=service_control_policy 响应示例
状态码:200
Successful.
{
"root" : {
"root_id" : "r-o1qqtqfo7xl427v7g",
"policy_type" : "service_control_policy",
"bucket_name" : "",
"region_id" : "",
"bucket_prefix" : "",
"agency_name" : "",
"status" : "disabled",
"created_at" : "2024-11-15T06:31:46Z",
"updated_at" : "2024-11-15T06:31:46Z"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful. |
错误码
请参见错误码。