接口介绍
创建角色
接口约束
支持的线上资源池 :合肥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 |
note | 否 | String | 备注 | some notes |
maxSessionDuration | 否 | Integer | 最大会话时间,单位秒,取值范围:3600-43200秒,即1-12小时,默认 3600 | 3600 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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"
}
响应示例
{
"message":"SUCCESS",
"description":"成功",
"statusCode":800,
"returnObj":{
"arn":"arn:aws:iam:::role/role1"
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表