创建保密信息

更新时间:2023-04-28 22:47:41

适用产品

CDN Pro

接口描述

创建“保密信息”来存放敏感内容,避免敏感内容直接暴露在加速项目的边缘逻辑中。在边缘逻辑中使用$SECRET(secretName)语法来引用保密信息。

推荐使用 Open API在线调试

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

请求参数

Body 参数

参数名称描述
*nameString
取值范围: [ 1 .. 30 ] 字符 ^[A-Za-z0-9_.-]+ 保密信息的名称。可以由字母、数字、连字符、下划线和句点组成。在边缘逻辑中使用$SECRET(secretName) 语法来引用。
descriptionString
取值范围: <= 250 字符 保密信息的描述。
*secretString
取值范围: [ 8 .. 3599 ] 字符 需要被保护的敏感内容。当部署加速项目时,将对边缘逻辑中的 $SECRET(secretName)进行解析,提取出敏感内容。支持可打印的ASCII字符、制表符(0x09)、换行符(0x0a) 和回车符(0x0d)。

返回参数

响应头

参数名称描述
LocationString
通过Location响应头返回新建的保密信息的URL。URL中包含保密信息的ID,可使用该ID调用‘获取保密信息详请’接口来查看保密信息的详请。URL示例:Location: https://openapi.chinanetcenter.com/cdn/secrets/60d6707cca3e387d2a28fc9e

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidSecretValueThe secret is too long, too short, or contains invalid characters.400secret参数的值太长,太短,或包含无效字符。
InvalidNameThe name is missing or contains invalid characters or longer than 30 characters.400name参数未指定,包含无效字符,或长度超过30个字符。
TooManySecretsThe number of secrets exceeded the account maximum.403保密信息数量已超过上限。
AccessDeniedYou are not allowed to perform this action.403鉴权失败。
DuplicateNameThe name already exists.409已存在相同名称的保密信息。

示例

400
403
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" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"name": "theCredential", "description": "password used to authenticate to our origin server", "secret": "abcdefghijklmnopqrstuvwxz"}'
返回示例
复制代码 复制成功
{
    "code": "InvalidSecretValue",
    "message": "The secret is too long, too short, or contains invalid characters."
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!