接口介绍
客户端承接策略
接口约束
支持的线上资源池 :合肥2、西安5
URI
POST /v4/oss/role-undertake
请求参数
请求体 JSON Body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
arn | 是 | String | 策略名称 | arn:aws:iam:::role/role-xxx |
roleSessionName | 是 | String | 会话名称 | session1 |
durationSeconds | 是 | Integer | 承接时长,单位秒 。取值范围:1-12小时。如果指定的值高于创建角色时指定的最大会话时长,则操作将失败。例如,如果您将会话持续时间指定为 12 小时,但创建角色时会话持续时间设置为 6 小时,则操作将失败。 | 7200 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
returnObj | Object | 响应对象 | 见下级对象 |
description | String | 状态描述,一般为中文 | 成功 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
assumedRoleUser | Object | 授权角色 | 见下级对象 |
credentials | Object | 临时授权证书详情 | 见下级对象 |
表assumedRoleUser
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
arn | String | 承接角色操作返回的临时安全凭证的ARN | arn:aws:sts:::assumed-role/role1/session1 |
表credentials
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
secretAccessKey | String | 临时授权sk | xxx |
accessKeyId | String | 临时授权ak | xxx |
expiration | String | 临时证书到期时间 | 2023-05-17T06:38:42Z |
sessionToken | String | 临时会话token 信息 | xxxx |
请求示例
{
"regionID": "332232eb-63aa-465e-9028-52e5123866f0",
"arn": "arn:aws:iam:::role/role1",
"roleSessionName": "session1",
"durationSeconds": 3600
}
响应示例
{
"message": "SUCCESS",
"description": "成功",
"statusCode": 800,
"returnObj": {
"result": {
"assumedRoleUser": {
"arn": "arn:aws:sts:::assumed-role/role1/session1"
},
"credentials": {
"secretAccessKey": "xxxxxxxx",
"accessKeyId": "xxxxxxx",
"expiration": "2023-05-17T06:38:42Z",
"sessionToken": "xxxxx"
}
}
}
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表