接口介绍
创建角色
接口约束
支持的线上资源池 :合肥2、西安5。
URI
POST /v4/oss/create-role
请求参数
请求体 JSON Body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域ID | 332232eb-63aa-465e-9028-52e5123866f0 |
roleName | 是 | String | 角色名称,在资源池区域内唯一 | role1 |
path | 是 | String | 角色地址,必须以/开始和结尾 | / |
assumeName | 是 | String | 被授权客户端,目前仅支持sts | sts |
policyDocument | 否 | String | JSON 文档形式的角色承接策略,默认:"{"Version": "2012-10-17", "Statement": {"Action": ["sts:AssumeRole"], "Effect": "Allow", "Principal": {"AWS": ["arn:aws:iam:::user/{oss_uid}"]}}}"。 | "{"Version": "2012-10-17", "Statement": {"Action": ["sts:AssumeRole"], "Effect": "Allow", "Resource": "arn:aws:s3:::bucket-name/*", "Principal": {"AWS": ["arn:aws:iam:::user/logservice-user"]}}}" |
note | 否 | String | 备注 | some notes |
maxSessionDuration | 否 | Integer | 最大会话时间,单位秒,取值范围:3600-43200秒,即1-12小时,默认 3600 | 3600 |
表 policyDocument
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
Version | 是 | String | 当前支持"2012-10-17" | 2012-10-17 |
Id | 否 | String | 桶策略ID,桶策略的唯一标识 | policy1 |
Statement | 是 | Array of Objects | 桶策略描述,定义完整的权限控制。每条桶策略的Statement可由多条描述组成,每条描述是一个dict,每条描述可包含以下字段: Sid Effect Principal Action ReSource Condition | 见下级对象 |
表 Statement
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
Sid | 否 | String | 本条桶策略描述的ID | S3PolicyId1 |
Effect | 是 | String | 桶策略的效果,即指定本条桶策略描述的权限是接受请求还是拒绝请求。 接受请求:配置为“Allow”, 拒绝请求:配置为“Deny” | Deny |
Action | 是 | String or Array of string | 操作,即指定本条桶策略描述所作用的oss操作。以列表形式表示,可配置多条操作,以逗号间隔。支持通配符”“,表示该资源能进行的所有操作。常用的Action有"s3:GetObject","s3:PutObject","s3: "等 | s3:* |
Condition | 否 | Object | 条件语句,指定本条桶策略所限制的条件。可以通过Condition对oss资源各种策略 | {"NotIpAddress": {"aws:SourceIp": "54.240.143.0/24"}} |
Resource | 是 | String or Array of string | 此条策略所作用的资源,如桶、对象等 | ["arn:aws:s3:::DOC-EXAMPLE-BUCKET", "arn:aws:s3:::DOC-EXAMPLE-BUCKET/*"] |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
returnObj | Object | 响应对象 | 见下级对象 |
description | String | 状态描述,一般为中文 | 成功 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
arn | String | 角色arn | arn:aws:iam::123456789012:role/Test-Role |
请求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"roleName": "role1",
"path": "/",
"assumeName": "sts",
"policyDocument": "{\"Version\": \"2012-10-17\", \"Statement\": {\"Action\": [\"sts:AssumeRole\"], \"Effect\": \"Allow\", \"Resource\": \"arn:aws:s3:::bucket-name/*\", \"Principal\": {\"AWS\": [\"arn:aws:iam:::user/logservice-user\"]}}}"
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800,
"returnObj": {"arn": "arn:aws:iam::123456789012:role/Test-Role"}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表