开发者社区 问答 正文

API参考 - API参考 -   账号管理 -DescribeAccounts



描述


该接口用于查找指定实例、指定DB的帐户列表信息或某个指定账号的信息。

请求参数

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述ActionString是系统规定参数,取值为DescribeAccounts。DBInstanceIdString是实例名。AccountNameString否账号名。

返回参数

[tr=rgb(51, 205, 229)][td]名称 类型描述<公共返回参数>详见公共参数。AccountsList<DBInstanceAccount>由Account组成的数组。

DBInstanceAccount参数

[tr=rgb(51, 205, 229)][td]名称 类型描述DBInstanceIdString账号所属实例名称。AccountNameStringDB操作账号名称。AccountStatusString账号状态:
  • Unavailable:不可用
  • Available:可用
AccountDescriptionString账号备注信息。DatabasePrivilegesList<DatabasePrivilege>由DatabasePrivilege组成的数组。AccountTypeString取值为:
  • Normal:普通账号,默认为 Normal。
  • Super:超级账号


DatabasePrivilege参数

[tr=rgb(51, 205, 229)][td]名称 类型描述DBNameString数据库名称。AccountPrivilegeStringDB操作账号名称。

请求示例https://rds.aliyuncs.com/?Action=DescribeAccounts
&DBInstanceId=rdsubauieubauie
&<公共请求参数>





返回示例


XML格式 <DescribeAccountsResponse>
         <RequestId>2603CA96-B17D-4903-BC04-61A2C829CD94</RequestId>
           <Accounts>
               <DBInstanceAccount>
                  <AccountName>MySQL</AccountName>
                  <DBInstanceId>testdb</DBInstanceId>
                  <AccountStatus>utf8</AccountStatus>
                  <AccountDescription></AccountDescription>
                  <DatabasePrivileges>
      <DatabasePrivilege></DatabasePrivilege>
</DatabasePrivileges>
               <DBInstanceAccount>
           </Accounts>
</DescribeAccountsResponse>


JSON格式 {
    "Accounts": {
      "DBInstanceAccount": [
        {
          "AccountDescription": "",
          "DBInstanceId": "rdsubauieubauie",
          "DatabasePrivileges": {
            "DatabasePrivilege": []
          },
          "AccountStatus": "Unavailable",
          "AccountName": "testaccount"
        }
      ]
    },
    "RequestId": "8D9A9689-F108-43B4-9D2E-0A52FF42B008"
  }

展开
收起
梨好橙 2018-09-13 00:00:11 1218 分享 版权
阿里云 AI 助理回答

要查询指定实例或数据库的账户列表信息,您可以使用DescribeAccounts接口。此接口支持针对不同数据库类型(如Cassandra、RDS MySQL、PostgreSQL、SQL Server、MariaDB及AnalyticDB等)的实例进行操作。以下是调用该接口时涉及的主要请求参数与返回参数详情:

请求参数

  • Action: String 类型,必须。固定值DescribeAccounts,表示要调用的操作。
  • ClusterId/DBInstanceId: String 类型,必须。根据您查询的实例类型而定,如果是Cassandra实例,则使用ClusterId;如果是RDS实例或其他类型,则使用DBInstanceId来标识实例的唯一ID。
  • AccountName: String 类型,可选。如果您需要查询特定账号的信息,可以提供账号名称。
  • PageSize: Integer 类型,可选。每页返回的结果数量,默认值因接口版本而异,通常为30。
  • PageNumber: Integer 类型,可选。用于分页查询,指定查询的页码,默认值一般为1。

针对特定数据库类型的特殊参数

  • 对于AnalyticDB查询,可能还需要DBClusterIdAccountType参数。

返回参数

  • RequestId: String 类型。每次请求的唯一标识符,用于问题排查。
  • AccountsList/Accounts/AccountList: 根据响应格式不同,可能是数组或对象形式,包含以下字段:
    • Name/AccountName: 账户名称。
    • AccountStatus: 账户状态,如Available(可用)、Unavailable(不可用)等。
    • AccountDescription: 账户的描述或备注信息。
    • AccountType: 账户类型,如Normal(普通账号)、Super(超级账号)。
  • DatabasePrivilegesList: (部分接口返回)包含数据库权限信息的数组,每个元素包含数据库名称(DBName)和账号对该数据库的权限(AccountPrivilege)。

示例请求

https://[ServiceEndpoint]/?Action=DescribeAccounts
&DBInstanceId=[YourInstanceID]
&AccountName=[OptionalAccountName]
&<其他公共请求参数>

请注意,实际调用时需替换[ServiceEndpoint][YourInstanceID]以及任何适用的可选参数,并确保遵循对应服务的API文档中关于公共请求参数的要求。

通过上述参数配置,您可以灵活地查询不同数据库实例下的账户列表及其详细信息。如果在调用过程中遇到问题,建议检查请求参数是否正确、用户权限是否足够,并参考阿里云错误中心获取详细的错误码解释。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答