API で RocketMQ インスタンスアカウントを一覧表示 - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

指定されたインスタンスのアクセスアカウントを取得します。

今すぐお試しください

この 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:ListInstanceAccount

list

*Instance

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

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	RocketMQ インスタンスの ID です。	rmq-cn-7e22ody****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
pageNumber	integer	任意	ページ番号です。最初のページは 1 です。	1
pageSize	integer	任意	1 ページあたりのエントリ数です。	10
username	string	任意	アカウントのユーザー名です。	test
accountType	string	任意	アカウントの種類です。列挙値: CUSTOMER : カスタムアカウント DEFAULT : デフォルトアカウント	CUSTOMER
accountStatus	string	任意	アカウントのステータスです。列挙値: DISABLE : 無効 ENABLE : 有効	ENABLE

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスオブジェクトです。
requestId	string	リクエスト ID です。	C115601B-8736-5BBF-AC99-7FEAE1245A80
success	boolean	リクエストが成功したかどうかを示します。	true
data	object	返されたデータです。
pageNumber	integer	現在のページ番号です。	1
pageSize	integer	ページサイズです。	10
totalCount	integer	エントリの総数です。	24
list	array<object>	現在のページのエントリリストです。
	object	アカウント情報です。
regionId	string	リージョン ID です。	cn-hangzhou
instanceId	string	インスタンス ID です。	rmq-cn-7e22ody****
username	string	ユーザー名です。	test
accountType	string	アカウントの種類です。列挙値: CUSTOMER : カスタムアカウント DEFAULT : デフォルトアカウント	CUSTOMER
accountStatus	string	アカウントのステータスです。列挙値: DISABLE : 無効 ENABLE : 有効	ENABLE
remark	string	備考です。	test
code	string	エラーコードです。	MissingInstanceId
message	string	エラーメッセージです。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP ステータスコードです。	200
dynamicCode	string	動的エラーコードです。	InstanceId
dynamicMessage	string	動的エラーメッセージです。	instanceId
accessDeniedDetail	string	アクセス拒否の詳細です。このパラメーターは、RAM 権限が不十分なためにリクエストが拒否された場合にのみ返されます。	xxx

例

成功レスポンス

JSONJSON

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "username": "test",
        "accountType": "CUSTOMER",
        "accountStatus": "ENABLE",
        "remark": "test"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

エラーコード

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

変更履歴

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