DeleteSecret - 删除用户凭证

更新时间: 2023-09-26 15:11:10

调用DeleteSecret接口删除Data API用户凭证。

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
ClientTokenstring

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

ETnLKlblzczshOTUbOCz*****
RegionIdstring

地域ID,可通过调用DescribeSecrets接口获取该参数的值。

cn-hangzhou
SecretArnstring

已创建的Data API账号的用户凭证,可通过调用createSecret接口获取该参数的值。

说明 SecretName和本参数必须传入其一。
acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****
SecretNamestring

用户凭证名称。

说明
  • SecretArn和本参数必须传入其一。
  • 本参数需要和DbInstanceId一起传入。
  • Foo
    Enginestring

    数据库类型。

    说明 该参数当前仅支持传入MySQL值。
    MySQL
    DbInstanceIdstring

    实例ID。可调用DescribeDBInstances获取。

    说明 本参数需要和SecretName一起传入。
    rm-sfjdlsjxxxxx
    ResourceGroupIdstring

    资源组ID。可调用DescribeDBInstanceAttribute获取。

    rg-acfmy****

    返回参数

    名称类型描述示例值
    object

    返回参数如下。

    RequestIdstring

    请求ID。

    DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF
    SecretArnstring

    Data API账号的用户凭证。

    acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****
    SecretNamestring

    用户凭证的名称。

    Foo
    Successboolean

    请求是否成功,返回值如下:

    • true:请求成功。
    • false:请求失败。
    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF",
      "SecretArn": "acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****",
      "SecretName": "Foo",
      "Success": true
    }

    错误码

    HTTP status code错误码错误信息描述
    404SecretNotFoundSpecified rds data api secret is not foundDataAPI 凭证未找到

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

    变更历史

    变更时间变更内容概要操作
    2023-07-25OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
    入参OpenAPI 入参发生变更
      新增入参:ResourceGroupId
    2022-08-01新增 OpenAPI看变更集
    阿里云首页 云数据库 RDS 相关技术圈