调用本接口更新一个SSL证书实例的配置。
您可以调用本接口修改证书备注、启用或禁用证书到期告警。
请求频率:同一个租户每秒最多允许请求20次。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CertificateUpdateInstance | 要执行的操作,取值:CertificateUpdateInstance。 |
Version | String | 是 | 2024-10-01 | API的版本,取值:2024-10-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
InstanceId | String | 是 | cert-76c529256aba4a66bedd1d2ec862**** | 要操作的证书实例的ID。
|
Tag | String | 否 | doc-test | 为证书设置备注。 |
Options | Object | 否 | 操作选项。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST /?Action=CertificateUpdateInstance&Version=2024-10-01 HTTP/1.1 Host: a.volcengine.com Content-Type: application/json; charset=UTF-8 X-Date: 20241202T061433Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241202/cn-beijing/certificate_service/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "InstanceId": "cert-76c529256aba4a66bedd1d2ec862****", "Tag": "doc-test", "Options": { "ExpiredNotice": "Enabled" } }
{ "ResponseMetadata": { "RequestId": "202412021414390371772231360F755C", "Action": "CertificateUpdateInstance", "Version": "2024-10-01", "Service": "certificate_service", "Region": "cn-beijing" }, "Result": {} }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | MalformedRequest | 请求参数格式不合法。 |
400 | SystemBusy | 系统繁忙,请稍后重试。 |
400 | MissingParameter | 缺少必填参数。 |
400 | InvalidParameter | 指定的参数值无效。 |
400 | Expired.Certificate | 不支持对过期证书进行操作。 |
400 | NotFound.CertificateInstance | 未找到指定的证书。 |
400 | InvalidStatus.Instance | 当前证书状态不支持进行该操作。 |
400 | Revoked.Certificate | 证书已吊销,不支持该操作。 |
400 | AlreadyDisabled.ExpireNotice | 证书到期提醒已禁用。请勿重复操作。 |
400 | AlreadyEnabled.ExpireNotice | 证书到期提醒已开启。请勿重复操作。 |
500 | InternalError | 未知错误。 |