Querying the Policy List, Only CN Southwest-Guiyang1 Is Supported
Function
This API is used to query the policy list.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v5/{project_id}/ai/policy
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID, which can be obtained from My Credentials. Constraints Mandatory Range The value can contain 1 to 256 characters. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| policy_group_id | Yes | String | Definition Policy group ID. Constraints N/A Range The value can contain 1 to 20 characters. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| data_list | Array of AiPolicyInfo objects | Definition AI policy list. Range The value ranges from 0 to 200 objects. |
| Parameter | Type | Description |
|---|---|---|
| policy_id | String | Definition Policy ID. Range The value can contain 1 to 20 characters. |
| policy_name | String | Definition Policy Name Range |
| enabled | Boolean | Definition Whether to enable Range |
| policy_group_id | String | Definition Policy group ID. Range The value can contain 1 to 20 characters. |
| content | String | Definition Policy details Range The value can contain 0 to 65,535 characters. |
| description | String | Definition Policy description. Range The value can contain 1 to 256 characters. |
| create_time | Integer | Definition Creation time. Range The value range is 0 to 9,223,372,036,854,775,807. |
| update_time | Integer | Definition Creation time. Range The value range is 0 to 9,223,372,036,854,775,807. |
Example Requests
Query the policy list.
GET https://{endpoint}/v5/{project_id}/ai/policy?policy_group_id=xxx Example Responses
Status code: 200
{
"data_list" : [ {
"policy_id" : "2058436565955923968",
"policy_name" : "policy_name",
"enabled" : false,
"policy_group_id" : "2058436565955923961",
"content" : null,
"description" : "description1",
"create_time" : 1778874953990,
"update_time" : 1778874953990
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot