すべてのプロダクト
Search

このプロダクト

    :GetRole

    ドキュメントセンター

    :GetRole

    最終更新日:Aug 20, 2026

    ロールの情報を取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ram:GetRole

    get

    *Role

    acs:ram:*:{#accountId}:role/{#RoleName}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RoleName

    string

    任意

    ロールの名前。

    名前は 1～64 文字で、英数字、ピリオド (.)、ハイフン (-) を使用できます。

    ECSAdmin

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Role

    object

    ロールの情報。

    AssumeRolePolicyDocument

    string

    ロールの偽装権限を指定するアクセスポリシー。

    { "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
    UpdateDate

    string

    ロールが最後に更新された時間。時間は YYYY-MM-DDThh:mm:ssZ フォーマットの協定世界時 (UTC) です。

    2015-01-23T12:33:18Z
    Description

    string

    ロールの説明。

    ECS 管理ロール
    MaxSessionDuration

    integer

    ロールのセッション期間の最大値。

    3600
    RoleName

    string

    ロールの名前。

    ECSAdmin
    CreateDate

    string

    ロールが作成された時間。時間は YYYY-MM-DDThh:mm:ssZ フォーマットの協定世界時 (UTC) です。

    2015-01-23T12:33:18Z
    RoleId

    string

    ロールの ID。

    901234567890****
    Arn

    string

    ロールのリソース記述子。

    acs:ram::123456789012****:role/ECSAdmin
    AllowConsoleLogin

    boolean

    RAM ロールのコンソールログインが許可されているかどうかを示します。

    true
    IsServiceLinkedRole

    boolean

    ロールがサービスリンクロールであるかどうかを示します。

    true
    RolePrincipalName

    string

    ドメイン名サフィックスが付加されたロールの名前。

    ECSAdmin@role.123456.onaliyunservice.com
    LatestDeletionTask

    object

    最新の削除タスクの情報。

    CreateDate

    string

    削除タスクが作成された時間。時間は YYYY-MM-DDThh:mm:ssZ フォーマットの協定世界時 (UTC) です。

    2018-10-23T12:33:18Z
    DeletionTaskId

    string

    削除タスクの ID。

    task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436
    RequestId

    string

    リクエスト ID。

    04F0F334-1335-436C-A1D7-6C044FE73368

    例

    成功レスポンス

    JSONJSON

    {
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "ECS 管理ロール。",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin。",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "901234567890****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin",
    "AllowConsoleLogin": true,
    "IsServiceLinkedRole": true,
    "RolePrincipalName": "ECSAdmin@role.123456.onaliyunservice.com",
    "LatestDeletionTask": {
      "CreateDate": "2018-10-23T12:33:18Z",
      "DeletionTaskId": "task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436"
    }
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

    エラーコード

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

    変更履歴

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