Documentation|Tencent Cloud

Recent Pages

ModifyHTTPSListenerAttribute

Last updated: 2020-07-24 15:09:15

1. API Description

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

This API (ModifyHTTPSListenerAttribute) is used to modify HTTPS listener configurations. It currently do not support connection groups and connections of version 1.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 parameter. The value used for this API: ModifyHTTPSListenerAttribute.
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 ID
ProxyId	No	String	Connection ID. This field is required if using a single connection listener.
ListenerName	No	String	New listener name
ForwardProtocol	No	String	Type of the protocol used in the forwarding from connections to origin servers
CertificateId	No	String	New listener server certificate ID
ClientCertificateId	No	String	New listener client certificate ID
PolyClientCertificateIds.N	No	Array of String	Client certificate ID of the listener after modification, which is a new field.

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 HTTPS Listener Configuration

Modify the HTTPS listener configuration.

Input Example

https://gaap.tencentcloudapi.com/?Action=ModifyHTTPSListenerAttribute
&InstanceId=link-3d85gh
&ListenerId=listener-o0f3at99
&ListenerName=test-2
&ForwardProtocol=HTTP
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
  }
}

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.

API 3.0 Explorer

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.GroupStatusNotInRuning	Unable to operate: the connection group is not running.
FailedOperation.InstanceStatusNotInRuning	Unable to operate: the connection is not running.
FailedOperation.ListenerHasTask	The listener is in operation. Do not repeat the operation.
FailedOperation.NotSupportOldVersionProxy	Only connections of Version 2.0 are supported.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
MissingParameter	Parameter missing
ResourceNotFound	Resource does not exist
UnauthorizedOperation	Unauthorized operation