DescribeInstanceRamRole - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

インスタンス ID に基づいて Elastic Compute Service (ECS) インスタンスにアタッチされているインスタンス Resource Access Management (RAM) ロールを照会するか、インスタンス RAM ロールの名前に基づいて特定のインスタンス RAM ロールがアタッチされている ECS インスタンスを照会します。

操作説明

注意事項

Alibaba Cloud CLI を使用して API オペレーションを呼び出す場合、さまざまなデータ型のリクエストパラメーターの値を必要な形式で指定する必要があります。詳細については、「パラメーターの形式」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeInstanceRamRole

get

Instance

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

Role

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。有効値の範囲：1～50。デフォルト値：10。	10
RegionId	string	必須	インスタンス RAM ロールのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
InstanceIds	string	任意	ECS インスタンスの ID。 1 回のリクエストで最大 50 個のインスタンス ID を指定できます。説明 `InstanceIds` と `RamRoleName` から少なくとも 1 つのパラメーターを指定する必要があります。	["i-bp67acfmxazb1p**", "i-bp67acfmxazb2p", "bp67acfmxazb3p**"…]
RamRoleName	string	任意	インスタンス RAM ロールの名前。このパラメーターを指定すると、インスタンス RAM ロールがアタッチされているすべての ECS インスタンスが応答で返されます。 RAM の ListRoles 操作を呼び出して、利用可能なインスタンス RAM ロールの名前を照会できます。説明 `InstanceIds` と `RamRoleName` から少なくとも 1 つのパラメーターを指定する必要があります。	EcsServiceRole-EcsDocGuideTest

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返された ECS インスタンスの数。	1
RegionId	string	ECS インスタンスのリージョン ID。	cn-hangzhou
InstanceRamRoleSets	object
InstanceRamRoleSet	array<object>	ECS インスタンスの ID と、対応する RAM ロールの名前の配列。
	object
RamRoleName	string	RAM ロールの名前。	EcsServiceRole-EcsDocGuideTest
InstanceId	string	インスタンスの ID。	i-bp67acfmxazb4p****

例

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidInstanceIds.Malformed	The specified instanceIds are not valid.
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.
403	InvalidParameter.AllEmpty	%s
404	InvalidInstanceId.NotFound	The specified instanceId does not exist

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。