接口介绍
创建策略
接口约束
支持的线上资源池 ：合肥2、西安5
URI
POST /v4/oss/create-policy
请求参数
请求体 JSON Body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| policyName | 是 | String | 策略名称 | policy1 |
| policyDocument | 是 | String | JSON 文档形式的策略 | - |
| note | 否 | String | 备注 | some notes |
表 policyDocument
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| Version | 是 | String | 当前支持"2012-10-17" | 2012-10-17 |
| Statement | 是 | Array of Objects | 桶策略描述，定义完整的权限控制。每条桶策略的Statement可由多条描述组成，每条描述是一个dict，每条描述可包含以下字段： Sid Effect Principal Action ReSource Condition | 见下级对象 |
表 Statement
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| Sid | 否 | String | 本条桶策略描述的ID | S3PolicyId1 |
| Effect | 是 | String | 桶策略的效果，即指定本条桶策略描述的权限是接受请求还是拒绝请求。 接受请求：配置为“Allow”， 拒绝请求：配置为“Deny” | Deny |
| Action | 是 | String | 操作，即指定本条桶策略描述所作用的oss操作。以列表形式表示，可配置多条操作，以逗号间隔。支持通配符”“，表示该资源能进行的所有操作。常用的Action有"s3:GetObject"，"s3:PutObject"，"s3: "等 | s3:* |
| Condition | 否 | String | 条件语句，指定本条桶策略所限制的条件。可以通过Condition对oss资源各种策略。 | {"NotIpAddress": {"aws:SourceIp": "54.240.143.0/24"}} |
| Resource | 是 | String | 此条策略所作用的资源，如桶、对象等。根据需要本参数也可使用Array of Strings类型 | ["arn:aws:s3:::DOC-EXAMPLE-BUCKET", "arn:aws:s3:::DOC-EXAMPLE-BUCKET/*"] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Long | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| returnObj | Object | 响应对象 | 见下级对象 |
| description | String | 状态描述，一般为中文 | 成功 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
| error | String | 业务细分码（大驼峰形式，仅失败时具有此参数），为 Product.Module.Code 三段式码 | Openapi.UserPermission.AccessFailed |
请求示例
{
"regionID":"332232eb-63aa-465e-9028-52e5123866f0",
"policyName":"policy1",
"policyDocument":"
{
\"Version\": \"2012-10-17\",
\"Statement\":
[
{
\"Action\":
[
\"s3:GetObject\",
\"s3:PutObject\",
\"s3:AbortMultipartUpload\",
\"s3:DeleteObject\",
\"s3:DeleteObjectVersion\",
\"s3:RestoreObject\"
],
\"Resource\": \"arn:aws:s3:::YOUR-BUCKET-NAME/*\",
\"Effect\": \"Allow\"
}
]
}
"
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
