DescribeAccounts - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

指定された ApsaraDB for Tair (Redis® OSS-Compatible) データベースインスタンスのアカウント情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeAccounts

get

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	r-bp1zxszhcgatnx****
AccountName	string	任意	クエリするアカウントの名前。	demo_account
		任意	アカウント名のあいまい一致文字列。	test
		任意	ページ番号。	1
		任意	1 ページあたりのエントリ数。	100

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	6C9E114C-217C-4118-83C0-B4070222****
Accounts	object
Account	array<object>	インスタンスのアカウント情報リスト。
	array<object>	アカウントの詳細。
AccountDescription	string	アカウントの説明。	testdec
InstanceId	string	インスタンスの ID。	r-bp10noxlhcoim2****
AccountType	string	アカウントタイプ。有効な値: Normal: 標準アカウント。 Super: スーパーユーザアカウント。	Normal
AccountStatus	string	アカウントのステータス。有効な値: Unavailable: 利用不可。 Available: 利用可能。	Available
AccountName	string	アカウント名。	demo_account
DatabasePrivileges	object
DatabasePrivilege	array<object>	アカウントの特典クォータリスト。
	object	アカウントの特典クォータの詳細。
AccountPrivilege	string	アカウントの特典クォータ。有効な値: RoleReadOnly: 読み取り専用権限。 RoleReadWrite: 読み書き権限。これがデフォルト値です。	RoleReadWrite
Parameters	string	アカウントのパラメーター。	{"access-db-id":"1","cu-limit":"10"}
PageNumber	integer	ページ番号。	100
PageSize	integer	1 ページあたりのエントリ数。	1
TotalCount	integer	エントリの総数。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "6C9E114C-217C-4118-83C0-B4070222****",
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "testdec",
        "InstanceId": "r-bp10noxlhcoim2****",
        "AccountType": "Normal",
        "AccountStatus": "Available",
        "AccountName": "demoaccount",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "RoleReadWrite"
            }
          ]
        },
        "Parameters": "{\"access-db-id\":\"1\",\"cu-limit\":\"10\"}"
      }
    ]
  },
  "PageNumber": 100,
  "PageSize": 1,
  "TotalCount": 10
}

エラーコード

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

変更履歴

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