本接口用于為一臺或多臺ECS實例授予RAM角色。
接口說明
您可以通過 DescribeInstanceRamRole 查詢實例被授予的實例 RAM 角色。
說明
如果實例已存在被授予的實例 RAM 角色,則報錯提示您不能授予新的角色。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:AttachInstanceRamRole | update | *全部資源 * |
|
|
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
RamRoleName | string | 是 | 實例 RAM 角色名稱。您可以使用 RAM API ListRoles 查詢您已創建的實例 RAM 角色。 | testRamRoleName |
InstanceIds | string | 是 | 實例 ID 數組。數組長度:1~100。 | [“i-bp14ss25xca5ex1u****”, “i-bp154z5o1qjalfse****”, “i-bp10ws62o04ubhvi****] |
Policy | string | 否 | 額外權限策略。可以指定一個額外的權限策略,以進一步限制 RAM 角色的權限。更多信息,請參見權限策略概覽。長度為 1~1024 個字符。 | {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"} |
返回參數
示例
正常返回示例
JSON
格式
{
"RamRoleName": "testRamRoleName",
"RequestId": "D9553E4C-6C3A-4D66-AE79-9835AF705639",
"TotalCount": 1,
"FailCount": 0,
"AttachInstanceRamRoleResults": {
"AttachInstanceRamRoleResult": [
{
"Code": "200",
"Message": "success",
"InstanceId": "i-bp10ws62o04ubhvi****",
"Success": true
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceIds.Malformed | The specified instanceIds are not valid. | 指定的多個 InstanceId 不合法。 |
403 | InvalidNetworkType.MismatchRamRole | Ram role cannot be applied to instances of Classic network type. | 實例 RAM 角色不能被用于經典網絡類型的實例,RAM 角色只能使用在 VPC 類型的實例上。 |
403 | InvalidUser.PassRoleForbidden | The RAM user does not have the privilege to pass a RAM role. | 該 RAM 用戶無權傳遞 RAM 角色。 |
404 | InvalidInstanceId.NotFound | The specified instanceId does not exist. | 指定的實例ID未找到。 |
404 | InvalidRamRole.NotFound | The specified RAMRoleName does not exist. | 指定的 RamRoleName 不存在。 |
404 | InvalidRamRole.NotEcsRole | The specified ram role is not authorized for ecs, please check your role policy. | 指定的 RAM 角色無權使用 ECS,請檢查您的角色策略。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |