ApsaraDB for Redis インスタンスのすべてのアカウントまたは指定されたアカウントを照会するには、この API を呼び出します。

注 ApsaraDB for Redis インスタンスのエンジンバージョンは、Redis 4.0 以上である必要があります。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストパラメーター

パラメーター タイプ 必須項目 例 説明
Action String 必須 DescribeAccounts

実行する操作。 このパラメーターを DescribeAccounts に設定します。
InstanceId String 必須 r-bp1xxxxxxxxxxxxx

アカウントが属するインスタンスの ID。
AccessKeyId String 任意 Lxxxxxxxxxxxxxxw

サービスにアクセスするため、Alibaba Cloud がユーザーに提供する AccessKey ID。
AccountName String 任意 demoaccount

アカウントの名前。 名前は小文字で始まる必要があります。小文字、数字、アンダースコア (_) を含めることができます。 名前の長さは 1〜16 文字です。

レスポンスパラメーター

パラメーター タイプ 例 説明
Accounts

照会されたアカウント。
└AccountDescription String this is a test account

アカウントの説明。
└AccountName String demoaccount

アカウントの名前。
└AccountStatus String Available

アカウントのステータス。 有効値:

  • Unavailable
  • Available
└AccountType String Normal

アカウントのタイプ。 有効値:

  • Normal
  • Super
└DatabasePrivileges

アカウントの権限。
└AccountPrivilege String RoleReadWrite

アカウントの権限。 有効値:

  • RoleReadOnly
  • RoleReadWrite (既定値)
  • RoleRepl
注 ApsaraDB for Redis インスタンスのデータの読み取りと書き込みに加えて、RoleRepl 権限を持つアカウントは SYNC および PSYNC コマンドを実行することができます。
└InstanceId String r-bp1xxxxxxxxxxxxx

インスタンスの ID。
RequestId String 6C9E114C-217C-4118-83C0-B40702221161

リクエストの ID。

例

リクエスト例


https://r-kvstore.aliyuncs.com/
? Action=DescribeAccounts
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

通常のレスポンス例

XML 形式 

<DescribeAccountsResponse>
  <Accounts>
    <Account>
      <DatabasePrivileges>
        <DatabasePrivilege>
          <AccountPrivilege>RoleReadWrite</AccountPrivilege>
        </DatabasePrivilege>
      </DatabasePrivileges>
      <AccountStatus>Available</AccountStatus>
      <InstanceId>r-bp1xxxxxxxxxxxxx</InstanceId>
      <AccountName>r-bp1xxxxxxxxxxxxx</AccountName>
      <PrivExceeded>0</PrivExceeded>
      <AccountType>Normal</AccountType>
    </Account>
  </Accounts>
  <RequestId>6C9E114C-217C-4118-83C0-B40702221161</RequestId>
</DescribeAccountsResponse>

JSON 形式 

{
	"Accounts":{
		"Account":[
			{
				"AccountStatus":"Available",
				"DatabasePrivileges":{
					"DatabasePrivilege":[
						{
							"AccountPrivilege":"RoleReadWrite"
						}
					]
				},
				"InstanceId":"r-bp1xxxxxxxxxxxxx",
				"AccountName":"r-bp1xxxxxxxxxxxxx",
				"PrivExceeded":"0",
				"AccountType":"Normal"
			}
		]
	},
	"RequestId":"6C9E114C-217C-4118-83C0-B40702221161"
}

エラーコード

エラーコードの表示。