Documentation|Tencent Cloud

Recent Pages

ModifyHTTPListenerAttribute

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

1. API Description

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

This API (ModifyHTTPListenerAttribute) is used to modify the HTTP listener configuration information of a connection. Currently only supports modifying listener name.
Note: Grouped connections currently do not support HTTP/HTTPS listeners.

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: ModifyHTTPListenerAttribute.
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 to be modified
ListenerName	Yes	String	New listener name
ProxyId	No	String	Connection ID

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

Modify the HTTP listener configuration.

Input Example

https://gaap.tencentcloudapi.com/?Action=ModifyHTTPListenerAttribute
&InstanceId=link-3d85gh
&ListenerId=listener-o0f3at99
&ListenerName=‘test-2’
&<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.ListenerStatusError	The listener does not support this operation in current status.
FailedOperation.NotSupportOldVersionProxy	Only connections of Version 2.0 are supported.
FailedOperation.NotSupportProxyGroup	This operation is not supported for connection groups.
InternalError	Internal error
InvalidParameter	Parameter error
InvalidParameterValue	Parameter value error
MissingParameter	Parameter missing
ResourceNotFound	Resource does not exist