请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | DescribeAccountList | 系统规定参数。取值为DescribeAccountList。 |
DBInstanceName | String | 是 | pxc-**************** | 实例ID。 说明 您可以调用DescribeDBInstances接口查看目标地域下所有实例的详情,包括实例ID。 |
RegionId | String | 是 | cn-hangzhou | 实例所在地域ID。 说明 您可以调用DescribeRegions接口查看PolarDB-X支持的地域详情,包括地域ID。 |
AccountName | String | 否 | test | 账号名称。 说明 该参数值为空时表示查询目标实例下的所有账号。 |
AccountType | String | 否 | 2 | 账号类型,允许一次查询多个类型的账号,多个账号类型间用英文逗号(,)分隔。取值范围如下:
说明 若该参数留空,将返回目标实例下所有类型的账号信息。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
Data | Array of Account | 账号信息。 |
|
Message | String | **** | 请求返回消息。 说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。 |
RequestId | String | 9190A9EB-E866-4EE6-BD2C-B7EC46****** | 请求ID。 |
Success | Boolean | true | 请求是否成功。 |
示例
请求示例
http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeAccountList &DBInstanceName=pxc-**************** &RegionId=cn-hangzhou &<公共请求参数>
正常返回示例
XML
格式
<Message/> <RequestId>9190A9EB-E866-4EE6-BD2C-B7EC46******</RequestId> <Data> <AccountPrivilege>ReadWrite,ReadWrite</AccountPrivilege> <DBName>db1,db2</DBName> <AccountType>0</AccountType> <AccountName>testname</AccountName> <DBInstanceName>pxc-****************</DBInstanceName> <GmtCreated>2021-03-03 11:47:16</GmtCreated> </Data> <Data> <AccountDescription>test</AccountDescription> <AccountType>1</AccountType> <AccountName>testname2</AccountName> <DBInstanceName>pxc-****************</DBInstanceName> </Data> <Success>true</Success>
JSON
格式
{ "Message": "", "RequestId": "9190A9EB-E866-4EE6-BD2C-B7EC46******", "Data": [{ "AccountPrivilege": "ReadWrite,ReadWrite", "DBName": "db1,db2", "AccountType": "0", "AccountName": "testname", "DBInstanceName": "pxc-****************", "GmtCreated":"2021-03-03 11:47:16" }, { "AccountDescription": "test", "AccountType": "1", "AccountName": "testname2", "DBInstanceName": "pxc-****************" }], "Success": true }