接口介绍
获取策略详情
接口约束
支持的线上资源池 :合肥2、西安5
URI
GET /v4/oss/policy/detail
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
policyName | 是 | String | 策略名称 | policy1 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
returnObj | Object | 响应对象 | 见下级对象 |
description | String | 状态描述,一般为中文 | 成功 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
note | String | 策略备注 | policy_note1 |
policy_document | String | 策略详情 | 见响应示例 |
policy_role | Array of Objects | 该策略绑定的角色列表 | 见下级对象 |
policy_name | String | 策略名称 | policy1 |
表 policy_role
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
note | String | 角色备注 | note_role |
role_name | String | 角色名称 | role1 |
bind_date | String | 该策略与该角色绑定时间 | 2023-05-17T05:57:05Z |
请求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"policyName": "policy1"
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800,
"returnObj": {
"note": "",
"policy_document": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Action\":[\"s3:GetObject\",\"s3:PutObject\",\"s3:DeleteObject\",\"s3:DeleteObjectVersion\",\"s3:RestoreObject\"],\"Resource\":\"arn:aws:s3:::bucket-515/*\",\"Effect\":\"Allow\"}}",
"policy_role": [
{
"note": "",
"role_name": "role1",
"bind_date": "2023-05-17T05:57:05Z"
}
],
"policy_name": "policy1"
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表