UploadCertificate--负载均衡-火山引擎

文档中心

立即注册

导航

UploadCertificate

最近更新时间：2024.06.04 19:12:46首次发布时间：2021.08.31 10:37:28

调用 UploadCertificate 接口，上传一张服务器证书。

使用说明

一个账号下每个区域最多可上传100个证书。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	UploadCertificate	要执行的操作，取值为UploadCertificate。
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
CertificateName	String	否	mycert1	证书的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。长度限制为1 ～ 128个字符。不填默认为证书ID。
PublicKey	String	是	pubkeycontent	证书的公钥内容。
PrivateKey	String	是	privatekeycontent	证书的私钥内容。
Description	String	否	mycert	证书的描述，默认值为空字符串。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个字符。
ProjectName	String	否	default	证书所属项目的名称。不填默认为default。
Tags.N.Key	String	否	Tags.1.Key=key1&Tags.2.Key=key2	用户标签的标签键。参数 - N：表示标签键的序号，取值范围：1～20。多个标签键之间用&分隔。不能以 `volc:`或`sys:`开头，包括任意大小写形式。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=value1&Tags.2.Value=value2	用户标签的标签值。参数 - N：表示标签值的序号，取值范围：1～20。多个标签值之间用&分隔。长度取值范围为0～256字符，不填默认为空。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。说明若传入该参数，则必须先传入`Tags.N.Key`。

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID。
CertificateId	String	cert-3tjuxoukkq3vj0ww****	证书ID。

请求示例

GET /?Action=UploadCertificate&Version=2020-04-01&CertificateName=mycert1&PublicKey=***&PrivateKey=*** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "UploadCertificate",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
     },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "CertificateId": "cert-3tjuxoukkq3vj0ww****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。说明其中，XXX表示缺少的参数名称。
400	InvalidCertificateDescription.Malformed	The specified CertificateDescription is malformed.	指定的 CertificateDescription 参数格式不合法。
400	InvalidCertificateLength.Malformed	The specified CertificateLength is malformed.	指定的 CertificateLength 参数格式不合法。
400	InvalidCertificateName.Malformed	The specified CertificateName is malformed.	指定的 CertificateName 参数格式不合法。
400	InvalidPrivateKey.Malformed	The specified PrivateKey is malformed.	指定的 PrivateKey 参数格式不合法。
400	InvalidPublicKey.Malformed	The specified PublicKey is malformed.	指定的 PublicKey 参数格式不合法。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.ServiceManagedTag	You've reached the limit on the number of service managed tags that you can create.	已达到单次可创建受管资源标签键值数量的上限。
400	LimitExceeded.TagOperation	You've reached the limit on the number of tags that you can operate at a time.	已达到单次可操作的标签条目数量上限。
400	QuotaExceed.CertificateNumber	You've reached the limit on the number of Certificate that you can create.	已达到可创建证书的数量的配额上限。
400	InvalidPublicKey.PrivateKeyMismatch	The PublicKey and PrivateKey are not matched.	指定的公钥与私钥不匹配。
400	InvalidProject.Malformed	The specified Project is malformed.	指定的 Project 参数格式不合法。
403	Forbidden	You are not authorized to perform operations on the service managed tag.	无权限对指定资源打上受管标签。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。