AttachInstanceRamRole - 為執行個體授予RAM角色 - Elastic Compute Service

本介面用於為一台或多台ECS執行個體授予RAM角色。

介面說明

您可以通過 DescribeInstanceRamRole 查詢執行個體被授予的執行個體 RAM 角色。

說明

如果執行個體已存在被授予的執行個體 RAM 角色，則報錯提示您不能授予新的角色。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:AttachInstanceRamRole

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

*Role

acs:ram:{#regionId}:{#accountId}:role/{#roleName}

無

ram:PassRole

請求參數

名稱	類型	必填	描述	樣本值
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"}

返回參數

名稱	類型	描述	樣本值
	object
RamRoleName	string	執行個體 RAM 角色的名稱。	testRamRoleName
RequestId	string	請求 ID。	D9553E4C-6C3A-4D66-AE79-9835AF705639
TotalCount	integer	授予執行個體 RAM 角色的執行個體總個數。	1
FailCount	integer	授予執行個體 RAM 角色的執行個體失敗個數。	0
AttachInstanceRamRoleResults	object
AttachInstanceRamRoleResult	array<object>	由執行個體 RAM 角色類型（AttachInstanceRamRoleResult）組成的資訊集。
	object	執行個體 RAM 角色類型。
Code	string	判斷是否成功授予執行個體 RAM 角色。傳回值為 200 表示成功授予，返回其他值表示授予失敗，失敗原因參見錯誤碼。	200
Message	string	判斷是否成功授予執行個體 RAM 角色。傳回值為 Success 表示成功授予，返回其他值表示授予失敗，失敗原因參見錯誤碼。	success
InstanceId	string	執行個體 ID。	i-bp10ws62o04ubhvi****
Success	boolean	是否成功授予執行個體 RAM 角色。	true

樣本

正常返回樣本

JSON格式

{
  "RamRoleName": "testRamRoleName",
  "RequestId": "D9553E4C-6C3A-4D66-AE79-9835AF705639",
  "TotalCount": 1,
  "FailCount": 0,
  "AttachInstanceRamRoleResults": {
    "AttachInstanceRamRoleResult": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp10ws62o04ubhvi****",
        "Success": true
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "RequestId": "D9553E4C-6C3A-4D66-AE79-9835AF705639",
    "AttachInstanceRamRoleResults": {
        "AttachInstanceRamRoleResult": [
            {
                "Message": "success",
                "InstanceId": "i-instance1",
                "Code": "200"
            }
        ]
    },
    "TotalCount": 1,
    "FailCount": 0,
    "RamRoleName": "RamRoleTest"
}

錯誤碼

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.
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。