文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 查询组织合规规则部署状态
更新时间:2024-10-22 GMT+08:00

查询组织合规规则部署状态

功能介绍

查询组织合规规则部署状态。

调用方法

请参见如何调用API

URI

GET /v1/resource-manager/organizations/{organization_id}/policy-assignment-statuses

表1 路径参数

参数

是否必选

参数类型

描述

organization_id

String

组织ID。

最大长度:34

表2 Query参数

参数

是否必选

参数类型

描述

organization_policy_assignment_id

String

组织合规规则ID

最大长度:32

organization_policy_assignment_name

String

组织合规规则名称。

最大长度:60

limit

Integer

最大的返回数量。

最小值:1

最大值:200

缺省值:200

marker

String

分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。

最小长度:4

最大长度:400

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

value

Array of OrganizationPolicyAssignmentStatusResponse objects

组织合规规则部署状态结果列表。

page_info

PageInfo object

分页对象。

表5 OrganizationPolicyAssignmentStatusResponse

参数

参数类型

描述

organization_policy_assignment_id

String

组织合规规则ID。

organization_policy_assignment_name

String

组织合规规则名称。

organization_policy_assignment_status

String

组织合规规则部署状态。

error_code

String

当创建或更新组织合规规则失败时错误码。

error_message

String

当创建或更新组织合规规则失败时错误信息。

created_at

String

创建时间。

updated_at

String

更新时间。

表6 PageInfo

参数

参数类型

描述

current_count

Integer

当前页的资源数量。

最小值:0

最大值:200

next_marker

String

下一页的marker。

最小长度:4

最大长度:400

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

响应示例

状态码: 200

操作成功。

{
  "value" : [ {
    "organization_policy_assignment_id" : "9642977cef864971b3b00ad56621a15f",
    "organization_policy_assignment_name" : "allowed-images-by-id",
    "organization_policy_assignment_status" : "CREATE_SUCCESSFUL",
    "error_code" : "null,",
    "error_message" : "null,",
    "created_at" : "2023-01-17T09:38:26.165Z",
    "updated_at" : "2023-01-17T09:38:26.165Z"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESIGQwMmI3ZmE5ZDVhNzRlNjM4YzE0MDJkMDg2OGY3MWZkGgTnpS5u"
  }
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户认证失败或无操作权限。

500

服务器内部错误。

错误码

请参见错误码