接口介绍
获取策略列表
接口约束
支持的线上资源池 :合肥2、西安5
URI
GET /v4/oss/list-policies
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
keyword | 否 | String | 模糊查询策略名,不区分大小写 | po |
pageSize | 否 | Integer | 单页数量,取值范围 1~50,默认值为10 | 6 |
page | 否 | Integer | 页码, 若与参数 pageNo 同时存在,以 pageNo 为准,默认值为1 | 1 |
pageNo | 否 | Integer | 页码,默认值为1 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
returnObj | Object | 响应对象 | 见下级对象 |
description | String | 状态描述,一般为中文 | 成功 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
totalCount | Integer | 总数 | 3 |
currentCount | Integer | 当前页记录数 | 20 |
fuser_last_updated | String | 最近更新时间 | 2023-03-31T06:42:44Z |
policy_document | String | 策略 | 见响应示例 |
note | String | 策略备注 | policy_note1 |
created_time | String | 策略创建时间 | 2023-03-31T06:28:24Z |
policy_name | String | 策略名 | policy1 |
请求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"pageSize": 3,
"page":1,
"pageNo":1,
"keyword": "plicy"
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800,
"returnObj": {
"totalCount": 3,
"currentCount": 10,
"result": [
{
"fuser_last_updated": "2023-03-31T06:28:24Z",
"policy_document": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Action\":[\"s3:ListAllMyBuckets\",\"s3:PutObject\",\"s3:GetObject\"],\"Resource\":[\"arn:aws:s3:::bucket-zs-1/*\"],\"Effect\":\"Allow\"}}",
"note": "",
"created_time": "2023-03-31T06:28:24Z",
"policy_name": "policy1"
},
{
"fuser_last_updated": "2023-04-23T11:18:16Z",
"policy_document": "{\"Version\":\"2012-10-17\",\"Id\":\"policy1\",\"Statement\":{\"Effect\":\"Allow\",\"Sid\":\"policy1\",\"Action\":[\"s3:*\"],\"Principal\":{\"AWS\":[\"arn:aws:iam:::*\"]},\"Resource\":\"arn:aws:s3:::*\"}}",
"note": "",
"created_time": "2023-04-23T11:18:15Z",
"policy_name": "policy2"
},
{
"fuser_last_updated": "2023-04-03T14:44:06Z",
"policy_document": "{\"Version\":\"2012-10-17\",\"Id\":\"DrqfDo\",\"Statement\":{\"Effect\":\"Allow\",\"Sid\":\"DrqfDo\",\"Action\":[\"s3:*\"],\"Principal\":{\"AWS\":[\"arn:aws:iam:::6b670413-5ebf-593a-a985-76d598374df7\"]},\"Condition\":{\"NotIpAddress\":{\"aws:SourceIp\":\"54.240.143.0/24\"}},\"Resource\":\"arn:aws:s3:::bucket-20230322-3/*\"}}",
"note": "",
"created_time": "2023-04-03T14:44:05Z",
"policy_name": "policy3"
}
]
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表