调用DescribeSecrets查询用户凭证_云数据库 RDS-阿里云帮助中心

调用DescribeSecrets接口查询Data API用户凭证。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。	ETnLKlblzczshOTUbOCz*****
AcceptLanguage	string	否	指定返回的语言。取值如下： zh-CN：中文 en-US：英文说明默认值：en-US。	en-US
RegionId	string	是	地域ID，您可调用DescribeDBInstanceAttribute接口查看实例所在地域ID。	cn-hangzhou
DbInstanceId	string	否	实例ID。可调用DescribeDBInstances获取。	rm-xjkljjxxxxx
Engine	string	是	数据库类型。说明该参数当前仅支持传入MySQL值。	MySQL
PageNumber	long	是	查询分页的页码，取值：大于0且不超过Integer的最大值。说明默认值：1。	1
PageSize	long	是	每页记录数。	10

返回参数

名称	类型	描述	示例值
	object	返回参数如下。
RequestId	string	请求ID。	DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF
PageSize	long	每页记录数。	10
PageNumber	long	查询分页的页码。	1
Secrets	object []	返回凭证详情列表。
AccountId	string	阿里云账号ID。	1266348003******
SecretName	string	用户凭证名称。	Foo
RegionId	string	地域ID。	cn-hangzhou
SecretArn	string	创建的Data API账号的用户凭证。	acs:rds:cn-hangzhou:1335786*:dbInstance/rm-bp1m7l3j63**
Description	string	用户对凭证的说明。	test
Username	string	数据库用户名。	user_jack

示例

正常返回示例

JSON格式

{
  "RequestId": "DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF",
  "PageSize": 10,
  "PageNumber": 1,
  "Secrets": [
    {
      "AccountId": "1266348003******",
      "SecretName": "Foo",
      "RegionId": "cn-hangzhou",
      "SecretArn": "acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****",
      "Description": "test",
      "Username": "user_jack"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-08-01	新增 OpenAPI	看变更集