文档

UpdateSecret

更新时间:

调用UpdateSecret接口更新凭据的元数据。

本文将提供一个示例,更新名为secret001凭据的元数据,将其描述信息Description更新为datainfo

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateSecret

要执行的操作。取值:UpdateSecret

SecretName String secret001

凭据名称或凭据资源名称(ARN)。

说明 访问其他阿里云账号下的凭据时,必须输入凭据ARN。凭据ARN的格式为acs:kms:${region}:${account}:secret/${secret-name}
Description String datainfo

凭据的描述信息。

ExtendedConfig.CustomData Map {"DBName":"app1","Port":"3306"}

拓展配置中的自定义数据。

说明
  • 如果指定该参数,将会更新凭据已有的拓展配置。
  • 通用凭据不支持设置该参数。

关于公共请求参数的详情,请参见公共参数

返回数据

名称

类型

示例值

描述

SecretName String secret001

凭据名称。

RequestId String 5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateSecret
&SecretName=secret001
&Description=datainfo
&公共请求参数

正常返回示例

XML格式

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

<UpdateSecretResponse>
    <SecretName>secret001</SecretName>
    <RequestId>5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47</RequestId>
</UpdateSecretResponse>

JSON格式

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

{
  "SecretName" : "secret001",
  "RequestId" : "5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47"
}

错误码

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