ModifyCertificate

Last updated: 2019-12-05 17:23:04

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (ModifyCertificate) is used to modify a domain name certificate of a listener. domain name certificate. This API is only applicable to connections of version 3.0.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyCertificate
Version Yes String Common parameter. The value used for this API: 2018-05-29
Region No String Common parameter. This parameter is not required for this API.
ListenerId Yes String Listener instance ID
Domain Yes String Domain name whose certificate needs to be modified
CertificateId Yes String New server certificate ID:
If CertificateId=default, using the listener certificate.
ClientCertificateId No String New client certificate ID:
If ClientCertificateId=default, using the listener certificate.
This parameter is required only when the mutual authentication is adopted.
PolyClientCertificateIds.N No Array of String List of new IDs of multiple client certificates, where:
This parameter or the ClientCertificateId parameter is required for mutual authentication only.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the Certificate of a Domain Name

Input Example

https://gaap.tencentcloudapi.com/?Action=ModifyCertificate
&ListenerId=listener-xxx
&Domain=www.test.com
&CertificateId=cert-12345678
&ClientCertificateId=cert-abcdefgh
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed
FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
FailedOperation.ProxyVersionNotSupport This version of connection is not supported.
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable
UnknownParameter Unknown parameter error