UpdateSecret - 更新凭据的元数据

更新凭据的元数据。

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制

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

调试

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

授权信息

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

请求参数

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

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

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

凭据的描述信息。

datainfo
ExtendedConfig.CustomDataobject

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

说明
  • 如果指定该参数,将会更新凭据已有的拓展配置。
  • 通用凭据不支持设置该参数。
  • {"DBName":"app1","Port":"3306"}

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

    返回参数

    名称类型描述示例值
    object
    SecretNamestring

    凭据名称。

    secret001
    RequestIdstring

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

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

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    400InvalidParametersome of the specified parameters "\" is not valid
    403Forbidden.NoPermissionThis operation is forbidden by permission system
    404Forbidden.ResourceNotFoundResource not found
    409Rejected.ResourceExistThe request was rejected becasue key already exsit
    409Rejected.ResourceInDeleteWindowsecret in delete peroid
    500InternalFailureInternal Failure

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