Adding a Listener
Function
This API is used to add a listener.
Calling Method
For details, see Calling APIs.
URI
POST /v1/listeners
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
listener |
Yes |
CreateListenerOption object |
Specifies the detailed information about adding a listener. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Specifies the listener name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. |
description |
No |
String |
Specifies the information about the listener. The value can contain 0 to 255 characters. The following characters are not allowed: <> |
protocol |
Yes |
String |
Specifies the protocol used by the listener to forward requests. |
port_ranges |
Yes |
Array of PortRange objects |
Specifies the port range used by the listener. |
client_affinity |
No |
String |
Specifies the client affinity. The value can be one of the following:
|
accelerator_id |
Yes |
String |
Specifies the ID of the global accelerator associated with the listener. |
tags |
No |
Array of ResourceTag objects |
Specifies the tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
from_port |
Yes |
Integer |
Specifies the start port number. |
to_port |
Yes |
Integer |
Specifies the end port number. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Specifies the tag key. The key must meet the following requirements:
|
value |
Yes |
String |
Specifies the tag value. The value must meet the following requirements:
|
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
listener |
ListenerDetail object |
Specifies the detail of a listener. |
request_id |
String |
Specifies the request ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the listener ID. |
name |
String |
Specifies the listener name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. |
description |
String |
Specifies the information about the listener. The value can contain 0 to 255 characters. The following characters are not allowed: <> |
protocol |
String |
Specifies the protocol used by the listener to forward requests. |
status |
String |
Specifies the provisioning status. The value can be one of the following:
|
port_ranges |
Array of PortRange objects |
Specifies the port range used by the listener. |
client_affinity |
String |
Specifies the client affinity. The value can be one of the following:
|
accelerator_id |
String |
Specifies the ID of the global accelerator associated with the listener. |
created_at |
String |
Specifies when the listener was added. |
updated_at |
String |
Specifies when the listener was updated. |
domain_id |
String |
Specifies the tenant ID. |
frozen_info |
FrozenInfo object |
Specifies the frozen details of cloud services or resources. |
tags |
Array of ResourceTag objects |
Specifies the tags. |
Parameter |
Type |
Description |
---|---|---|
from_port |
Integer |
Specifies the start port number. |
to_port |
Integer |
Specifies the end port number. |
Parameter |
Type |
Description |
---|---|---|
status |
Integer |
Specifies the status of a cloud service or resource. The value can be one of the following:
|
effect |
Integer |
Specifies the status of the resource after being frozen. The value can be one of the following:
|
scene |
Array of strings |
Specifies the service scenario. The value can be one of the following:
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The key must meet the following requirements:
|
value |
String |
Specifies the tag value. The value must meet the following requirements:
|
Example Requests
Creating a listener whose protocol is TCP, start port is 4000, end port is 4200, and client affinity is source IP address
POST https://{ga_endpoint}/v1/listeners { "listener" : { "name" : "listenerName", "description" : "listener description", "protocol" : "TCP", "port_ranges" : [ { "from_port" : 4000, "to_port" : 4200 } ], "client_affinity" : "SOURCE_IP", "accelerator_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8", "tags" : [ { "key" : "tagKey", "value" : "tagValue" } ] } }
Example Responses
Status code: 201
Listener added.
{ "listener" : { "id" : "1b11747a-b139-492f-9692-2df0b1c87193", "name" : "listenerName", "description" : "listener description", "protocol" : "TCP", "status" : "ACTIVE", "port_ranges" : [ { "from_port" : 4000, "to_port" : 4200 } ], "client_affinity" : "SOURCE_IP", "accelerator_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8", "created_at" : "2019-01-08T01:21:37.151Z", "updated_at" : "2019-01-08T01:21:37.151Z", "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24", "frozen_info" : { "status" : 2, "effect" : 1, "scene" : [ "ARREAR", "POLICE" ] }, "tags" : [ { "key" : "tagKey", "value" : "tagValue" } ] }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
Status Codes
Status Code |
Description |
---|---|
201 |
Listener added. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot