本接口具備兩個(gè)主要功能,支持依據(jù)實(shí)例 ID 來查詢一臺(tái)或多臺(tái) ECS 實(shí)例所被授予的實(shí)RAM角色,同時(shí)也允許通過實(shí)例 RAM 角色名稱來查詢被授予了該特定角色的實(shí)例情況。
接口說明
通過阿里云 CLI 調(diào)用 API 時(shí),不同數(shù)據(jù)類型的請(qǐng)求參數(shù)取值必須遵循格式要求。更多信息,請(qǐng)參見 CLI 參數(shù)格式說明。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ecs:DescribeInstanceRamRole | get | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} *Role acs:ram:{#regionId}:{#accountId}:role/{#roleName} |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 查詢接口返回資源信息列表的頁碼。 起始值:1。 默認(rèn)值:1。 | 1 |
PageSize | integer | 否 | 分頁展示響應(yīng)信息時(shí)設(shè)置的每頁行數(shù),單位:行。 最大值:50。 默認(rèn)值:10。 | 10 |
RegionId | string | 是 | 實(shí)例 RAM 角色所在的地域。您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
InstanceIds | string | 否 | 指定查詢的實(shí)例 ID 的集合。最多支持一次查詢 50 臺(tái)實(shí)例。 說明
InstanceIds 與RamRoleName 參數(shù)必須至少填寫一個(gè)。
| ["i-bp67acfmxazb1p****", "i-bp67acfmxazb2p****", "bp67acfmxazb3p****"…] |
RamRoleName | string | 否 | 查詢賦予了某一實(shí)例 RAM 角色的所有 ECS 實(shí)例。您可以使用 RAM API ListRoles 查詢您已創(chuàng)建的實(shí)例 RAM 角色。 說明
InstanceIds 與RamRoleName 參數(shù)必須至少填寫一個(gè)。
| EcsServiceRole-EcsDocGuideTest |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"InstanceRamRoleSets": {
"InstanceRamRoleSet": [
{
"RamRoleName": "EcsServiceRole-EcsDocGuideTest",
"InstanceId": "i-bp67acfmxazb4p****"
}
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidInstanceIds.Malformed | The specified instanceIds are not valid. | 指定的多個(gè) InstanceId 不合法。 |
403 | InvalidNetworkType.MismatchRamRole | Ram role cannot be applied to instances of Classic network type. | 實(shí)例 RAM 角色不能被用于經(jīng)典網(wǎng)絡(luò)類型的實(shí)例,RAM 角色只能使用在 VPC 類型的實(shí)例上。 |
403 | InvalidParameter.AllEmpty | %s | 您沒有輸入任何參數(shù),請(qǐng)輸入必要的參數(shù)。 |
404 | InvalidInstanceId.NotFound | The specified instanceId does not exist | 指定的實(shí)例不存在,請(qǐng)您檢查實(shí)例 ID 是否正確。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內(nèi)部錯(cuò)誤,請(qǐng)重試。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-12-17 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |