DescribeInstanceRamRole - 查詢執行個體被授予的RAM角色 - Elastic Compute Service

本介面具備兩個主要功能，支援依據執行個體 ID 來查詢一台或多台 ECS 執行個體所被授予的實RAM角色，同時也允許通過執行個體 RAM 角色名稱來查詢被授予了該特定角色的執行個體情況。

介面說明

通過阿里雲 CLI 調用 API 時，不同資料類型的請求參數取值必須遵循格式要求。更多資訊，請參見 CLI 參數格式說明。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeInstanceRamRole

get

Instance

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

Role

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

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	查詢介面返回資源資訊列表的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁展示響應資訊時設定的每頁行數，單位：行。最大值：50。預設值：10。	10
RegionId	string	是	執行個體 RAM 角色所在的地區。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
InstanceIds	string	否	指定查詢的執行個體 ID 的集合。最多支援一次查詢 50 台執行個體。說明 `InstanceIds`與`RamRoleName`參數必須至少填寫一個。	["i-bp67acfmxazb1p**", "i-bp67acfmxazb2p", "bp67acfmxazb3p**"…]
RamRoleName	string	否	查詢賦予了某一執行個體 RAM 角色的所有 ECS 執行個體。您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。說明 `InstanceIds`與`RamRoleName`參數必須至少填寫一個。	EcsServiceRole-EcsDocGuideTest

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返回的執行個體數量。	1
RegionId	string	執行個體所在的地區。	cn-hangzhou
InstanceRamRoleSets	object
InstanceRamRoleSet	array<object>	由執行個體 ID 和 RAM 角色名稱（InstanceRamRoleSet）組成的資訊集。
	object
RamRoleName	string	執行個體 RAM 角色名稱。	EcsServiceRole-EcsDocGuideTest
InstanceId	string	執行個體 ID。	i-bp67acfmxazb4p****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "InstanceRamRoleSets": {
    "InstanceRamRoleSet": [
      {
        "RamRoleName": "EcsServiceRole-EcsDocGuideTest",
        "InstanceId": "i-bp67acfmxazb4p****"
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", 
    "HostId": "ecs.aliyuncs.com",
    "Code": "IncompleteSignature",
    "Message": "The request signature does not conform to Aliyun standards."
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidInstanceIds.Malformed	The specified instanceIds are not valid.	指定的多個 InstanceId 不合法。
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidNetworkType.MismatchRamRole	Ram role cannot be applied to instances of Classic network type.	執行個體 RAM 角色不能被用於傳統網路類型的執行個體，RAM 角色只能使用在 VPC 類型的執行個體上。
403	InvalidParameter.AllEmpty	%s	您沒有輸入任何參數，請輸入必要的參數。
404	InvalidInstanceId.NotFound	The specified instanceId does not exist	指定的執行個體不存在，請您檢查執行個體 ID 是否正確。

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

變更歷史

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