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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
ClientToken String 否 ETnLKlblzczshOTUbOCz*****

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。
AcceptLanguage String 否 en-US

指定返回的语言。取值如下：

  • zh-CN：中文
  • en-US：英文
说明 默认值：en-US。
Action String 是 DescribeSecrets

系统规定参数。取值：DescribeSecrets。

RegionId String 是 cn-hangzhou

地域ID，您可调用DescribeDBInstanceAttribute接口查看实例所在地域ID。

DbInstanceId String 否 rm-xjkljjxxxxx

实例ID。可调用DescribeDBInstances获取。

Engine String 是 MySQL

数据库类型。

说明 该参数当前仅支持传入MySQL值。
PageNumber Long 是 1

查询分页的页码，取值：大于0且不超过Integer的最大值。

说明 默认值：1。
PageSize Long 是 10

每页记录数。

返回数据

名称 类型 示例值 描述
RequestId String DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF

请求ID。
PageSize Long 10

每页记录数。
PageNumber Long 1

查询分页的页码。
Secrets Array of Secrets

返回凭证详情列表。
AccountId String 1266348003******

阿里云账号ID。
SecretName String Foo

用户凭证名称。
RegionId String cn-hangzhou

地域ID。
SecretArn String acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****

创建的Data API账号的用户凭证。
Description String test

用户对凭证的说明。
Username String user_jack

数据库用户名。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeSecrets
&RegionId=cn-hangzhou
&Engine=MySQL
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSecretsResponse>
    <RequestId>DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Secrets>
        <SecretName>Foo</SecretName>
        <RegionId>cn-hangzhou</RegionId>
        <SecretArn>acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****</SecretArn>
    </Secrets>
</DescribeSecretsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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