查询策略集详情
功能介绍
查询策略集详情。
URI
GET /v1/policy-engines/{policy_engine_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| policy_engine_id | 是 | String | 参数解释: 策略集ID,系统自动生成的唯一标识符。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字及"-"、"_"组成,长度为12~59个字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_engine | PolicyEngine object | 参数解释: 策略集对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policy_engine_id | String | 参数解释: 策略集ID,系统自动生成的唯一标识符。 取值范围: 只能由英文字母、数字及"-"、"_"组成,长度为12~59个字符。 |
| name | String | 参数解释: 策略集名称,由用户指定且不可变。 取值范围: 只能以英文字母开头,由英文字母、数字及"_"组成,长度为1~48个字符。 |
| type | String | 参数解释: 策略集类型,用于按类型过滤策略集。不指定时返回所有类型的策略集。 取值范围: |
| description | String | 参数解释: 策略集的可读描述。 取值范围: 长度为1~4096个字符。 |
| urn | String | 参数解释: 策略集的统一资源名称(URN)。 取值范围: 长度为1~1024个字符。 |
| tags | Array of Tag objects | 参数解释: 自定义标签列表。 取值范围: 不涉及。 |
| created_at | String | 参数解释: UTC时间戳,记录资源的创建或更新时间。 取值范围: 使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。 |
| updated_at | String | 参数解释: UTC时间戳,记录资源的创建或更新时间。 取值范围: 使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键,用于标识标签的名称。 取值范围: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,长度为1~128个字符。 |
| value | String | 参数解释: 标签值,用于标识标签的具体内容。 取值范围: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"、"&"符号的任意组合,可以是空字符串,长度为0~255个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 加密后的认证失败信息,可以通过STS5解密接口进行解密。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 加密后的认证失败信息,可以通过STS5解密接口进行解密。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
{
"policy_engine" : {
"policy_engine_id" : "285624f5-5958-4f36-b171-168303615bce",
"name" : "my_policy_engine",
"type" : "GATEWAY",
"description" : "Example policy engine",
"urn" : "agentIdentity:<region>:<account-id>:policyEngine:<policy-engine-id>",
"tags" : [ {
"key" : "environment",
"value" : "production"
}, {
"key" : "team",
"value" : "platform"
} ],
"created_at" : "2025-01-01 00:00:00",
"updated_at" : "2025-01-02 00:00:00"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求体异常。 |
| 404 | 未找到相应的资源。 |
错误码
请参见错误码。