You need to enable JavaScript to run this app.
文档中心
云数据库 SQL Server 版

云数据库 SQL Server 版

复制全文
下载 pdf
账号管理
DescribeDBAccounts - 查询账号
复制全文
下载 pdf
DescribeDBAccounts - 查询账号
调用 DescribeDBAccounts 接口查询数据库账号。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数
Action string 必选 示例值:DescribeDBAccounts
要执行的操作,取值:DescribeDBAccounts
Version string 必选 示例值:2022-01-01
API的版本,取值:2022-01-01
InstanceId string 必选 示例值:mssql-64504b******
实例 ID。
AccountName string 可选 示例值:test_user
账号名称。
PageSize string 可选 示例值:10
页面大小。
PageNumber string 可选 示例值:1
页面数量。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构
Total integer 示例值:4
账号总数。
Account object[] 示例值:[ { "AccountName": "test", "AccountPrivileges": [], "AccountStatus": "Available", "AccountType": "Super" } ]
账号信息。
AccountName string 示例值:test
账号名称。
AccountType string 示例值:Normal
账号类型。取值:
  • Normal:普通账号。
  • Super:高权限账号。
AccountStatus string 示例值:Available
账号状态。取值:
  • Available:可用状态。
  • Unavailable:不可用状态。
AccountPrivileges object[] 示例值:[ { "AccountPrivilege": "DBOwner", "AccountPrivilegeDetail": "db_owner", "DBName": "testaaaa" } ]
账号权限信息。
DBName string 示例值:test_db
数据库名称。
AccountPrivilege string 示例值:DBOwner
权限类型。取值:
  • DBOwner:数据库所有者权限,拥有该数据库的全部管理与操作权限。
  • ReadWrite:读写权限,支持数据查询、插入、更新、删除等操作。
  • ReadOnly:只读权限,仅允许查询数据,禁止写入、修改与删除操作。
AccountPrivilegeDetail string 示例值:db_owner
账号权限信息。
请求示例
POST /?Action= DescribeDBAccounts&Version=2022-01-01 HTTP/1.1
Host: rds-mssql.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260112T123840Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260112/cn-beijing/rds_mssql/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceId":"mssql-******"
"PageSize":10,
"PageNumber":1,
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260204175745FC249218BE5A4533EC0A-******",
"Action": "DescribeDBAccounts",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"Account": [
{
"AccountName": "userA",
"AccountPrivileges": [
{
"AccountPrivilege": "DBOwner",
"AccountPrivilegeDetail": "db_owner",
"DBName": "testaaaa"
}
],
"AccountStatus": "Available",
"AccountType": "Super"
},
{
"AccountName": "test",
"AccountPrivileges": [],
"AccountStatus": "Available",
"AccountType": "Normal"
}
],
"Total": 2
}
}
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码
错误码
错误信息
说明
400
InvalidParameter
The specified parameter %s is not valid.
参数 {parameter1} 值无效。
最近更新时间:2026.04.03 17:09:31
这个页面对您有帮助吗?
有用
有用
无用
无用