すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetInstanceAccount

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetInstanceAccount

    最終更新日:Apr 27, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:GetInstanceAccount

    get

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /instances/{instanceId}/account HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-20p36ja4m0y

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    username

    string

    任意

    ユーザー名。

    このパラメーターを指定しない場合、システムはデフォルトアカウントの詳細を返します。

    test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディ。

    requestId

    string

    リクエストの一意な ID。この ID を使用して問題をトラブルシューティングできます。

    B5C59E80-FCFC-5796-ABE4-D39EAAE578E4
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    レスポンスデータ。

    username

    string

    ユーザー名。

    xxx
    password

    string

    アカウントパスワード。

    *************
    accountStatus

    string

    アカウントステータス。

    列挙値:

    • DISABLE :

      無効

    • ENABLE :

      有効

    ENABLE
    remark

    string

    備考。

    test
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    The instance cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    ConsumerGroupId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "B5C59E80-FCFC-5796-ABE4-D39EAAE578E4",
  "success": true,
  "data": {
    "username": "xxx",
    "password": "*************",
    "accountStatus": "ENABLE",
    "remark": "test"
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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