DescribeDBAccounts--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBAccounts

最近更新时间：2025.02.13 18:05:45首次发布时间：2023.02.02 17:41:21

调用 DescribeDBAccounts 接口查看账号列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-r3xq0zdl****	实例 ID。
AccountName	String	否	testuser1	数据库账号名称，支持模糊查询。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。

返回参数

参数	类型	示例值	描述
Accounts	Object[]	[ { "AccountName": "tester", "AccountPrivileges": null, "AccountStatus": "Available", "AccountDesc":"这是一段账号 tester 的描述信息", "AccountType": "Super", "Host": "%" } ]	账号列表。
Total	Integer	1	账号列表总数。

示例

请求示例

POST /?Action=DescribeDBAccounts&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-4674157d****",
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023011020222366CD533BB55250E27C28",
        "Action": "DescribeDBAccounts",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Accounts": [
            {
                "AccountDesc": "这是一段账号 tester 的描述。",
                "AccountName": "tester",
                "AccountPrivileges": null,
                "AccountStatus": "Available",
                "AccountType": "Super",
                "Host": "%"
            }
        ],
        "Total": 1
    }
}

错误码

更多详情，请参见错误码。