tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyCertificate

Last updated: 2023-07-13 15:25:25

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: ModifyCertificate.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
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 domain name certificate

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCertificate
<Common request parameters>

{
    "Domain": "www.test.com",
    "CertificateId": "cert-12345678",
    "ClientCertificateId": "cert-abcdefgh",
    "ListenerId": "listener-xxx"
}

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.DomainStatusNotInRunning Operation unavailable: the domain name is not running.
FailedOperation.GroupStatusNotInRuning Unable to operate: the connection group is not running.
FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
FailedOperation.ProxyStatusNotInRuning Unable to add listeners: the connection is not running.
FailedOperation.ProxyVersionNotSupport This version of connection is not supported.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.CertificateNotMatchDomain The HTTP certificate does not match the domain name.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy