Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Organizational Policies/ Querying Organizational Policy Delivery Info
Updated on 2024-12-20 GMT+08:00

Querying Organizational Policy Delivery Info

Function

This API is used to query the organization policy delivery info of each account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

organization_policy_id

Yes

String

Organizational policy ID.

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

policies

Array of OrganizationPolicyStatus objects

Organization Policy Deployment Status List

count

Integer

Number of members in the organization policy status

limit

Integer

Number of records displayed on each page

offset

Integer

Offset where the query starts

Table 4 OrganizationPolicyStatus

Parameter

Type

Description

policy_id

String

Policy ID

domain_id

String

Account ID

project_id

String

Project ID

status

String

Status

Example Requests

Querying the organization policy delivery info of each account

GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

GET https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id}/policy-detail

Example Responses

Status code: 200

OK

{
  "policies" : [ {
    "policy_id" : "680032b4-493f-4486-81ab-1d068c92da6b",
    "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60",
    "project_id" : "ab994a04599c4c46a1e946c328b55ee2",
    "status" : "available",
    "error_msg" : null
  }, {
    "policy_id" : "556d25b7-f3c7-4f61-a096-be74bb797056",
    "domain_id" : "0ab4d110dc00d5ba0f5ac0103d5ebf60",
    "project_id" : "c5a1f68f1c664c9189c2cc2956138b9a",
    "status" : "available",
    "error_msg" : null
  } ],
  "count" : 2,
  "limit" : 1000,
  "offset" : 0
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.