客戶端承接策略
更新時間 2025-06-11 14:55:31
最近更新時間: 2025-06-11 14:55:31
分享文章
接口介紹
客戶端承接策略
接口約束
支持的線上資源池 ：合肥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 枚舉值，見錯誤碼總表
