更新保密信息

更新时间:2023-04-28 22:46:28

适用产品

CDN Pro

接口描述

使用该接口更新保密信息。如果您修改了保密信息的名称,则以原有名称引用保密信息的加速项目版本将无法通过验证。此类加速项目版本必须移除对该保密信息的引用或者采用更新后的名称重新引用,才能通过验证。如果修改了保密信息存放的内容,则使用到该保密信息的加速项目在重新部署前必须进行重新验证。在保密信息更新后,在已部署加速项目中已引用的保密信息不会自动被更新。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Path 参数

参数名称描述
*secretIdString
保密信息id。

Body 参数

参数名称描述
nameString
取值范围: [ 1 .. 30 ] 字符 ^[A-Za-z0-9_.-]+ 保密信息的名称。可以由字母、数字、连字符、下划线和句点组成。在边缘逻辑中使用$SECRET(secretName) 语法引用。如果您修改了保密信息的名称,那么以原有名称引用保密信息的加速项目版本将无法通过验证。
descriptionString
取值范围: <= 250 字符 保密信息的描述。
secretString
取值范围: [ 8 .. 3599 ] 字符 保密信息存放的敏感内容。可以包含可打印的ASCII字符、制表符(0x09)、换行符(0x0a) 和回车符(0x0d)。保密信息更新后,在已部署加速项目中已引用的保密信息不会自动被更新。如果您修改了保密信息存放的内容,必须重新验证并部署,加速项目才能使用到最新的值。

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidNameThe name is missing or contains invalid characters or longer than 30 characters.400name参数未指定,包含无效字符,或长度超过30个字符。
InvalidSecretValueThe secret is too long, too short, or contains invalid characters.400secret参数太长,太短,或包含无效字符。
AccessDeniedPlease enter valid credentials.403鉴权失败。
InvalidSecretIdThe specified secret ID does not exist.404指定的secret ID不存在。
DuplicateNameThe name already exists.409已存在相同名称的保密信息。

示例

400
403
404
409
400
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/cdn/secrets/{secretID}" \
-X "PATCH" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"name": "newName"}'
返回示例
复制代码 复制成功
{
    "code": "InvalidName",
    "message": "The name is missing or contains invalid characters or longer than 30 characters."
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!