Help Center/ Global Accelerator/ API Reference/ API/ Endpoint/ Adding an Endpoint

Updated on 2025-11-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Adding an Endpoint

Function

This API is used to add an endpoint.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ga:endpoint:create	Write	endpoint *	-	-	-
ga:endpoint:create	Write	-	ga:RequestResourceType ga:RequestResourceId ga:RequestIpAddress ga:RequestDomainName	-	-

URI

POST /v1/endpoint-groups/{endpoint_group_id}/endpoints

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
endpoint_group_id	Yes	String	Specifies the endpoint group ID.

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
endpoint	Yes	CreateEndpointOption object	Specifies the detailed information about adding an endpoint.

**Table 4** CreateEndpointOption
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Specifies the endpoint ID, for example, EIP ID.
resource_type	Yes	String	The endpoint type. Value range: EIP: EIPs in your account ECS: ECSs on a private network in your account ELB: Load balancers on a private network in your account CUSTOM_IP: Public IP addresses outside the cloud CUSTOM_DOMAIN_NAME: Public domain names outside the cloud CUSTOM_EIP: EIPs in the current region
weight	No	Integer	Specifies the weight of the endpoint based on which the listener distributes traffic.
ip_address	Yes	String	Specifies the IP address of the endpoint.

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
endpoint	EndpointDetail object	Specifies the detail of the endpoint.
request_id	String	Specifies the request ID.

**Table 6** EndpointDetail
Parameter	Type	Description
id	String	Specifies the endpoint ID.
resource_id	String	Specifies the endpoint ID.
endpoint_group_id	String	Specifies the endpoint group ID.
resource_type	String	The endpoint type. Value range: EIP: EIPs in your account ECS: ECSs on a private network in your account ELB: Load balancers on a private network in your account CUSTOM_IP: Public IP addresses outside the cloud CUSTOM_DOMAIN_NAME: Public domain names outside the cloud CUSTOM_EIP: EIPs in the current region
status	String	Specifies the provisioning status. The value can be one of the following: ACTIVE: The resource is running. PENDING: The status is to be determined. ERROR: Failed to create the resource. DELETING: The resource is being deleted.
weight	Integer	Specifies the weight of the endpoint based on which the listener distributes traffic.
health_state	String	Specifies the health check result of the endpoint. The value can be one of the following: INITIAL: Initial HEALTHY: Healthy UNHEALTHY: Unhealthy NO_MONITOR: Not monitored
created_at	String	Specifies when the endpoint was added.
updated_at	String	Specifies when the endpoint was updated.
domain_id	String	Specifies the tenant ID.
ip_address	String	Specifies the IP address of the endpoint.
frozen_info	FrozenInfo object	Specifies the frozen details of cloud services or resources.

**Table 7** FrozenInfo
Parameter	Type	Description
status	Integer	Specifies the status of a cloud service or resource. The value can be one of the following: 0: unfrozen/normal (The cloud service will recover after being unfrozen.) 1: frozen (Resources and data will be retained, but the cloud service cannot be used.) 2: deleted/terminated (Both resources and data will be cleared.)
effect	Integer	Specifies the status of the resource after being frozen. The value can be one of the following: 1 (default): The resource is frozen and can be released. 2: The resource is frozen and cannot be released. 3: The resource is frozen and cannot be renewed.
scene	Array of strings	Specifies the service scenario. The value can be one of the following: ARREAR: The cloud service is in arrears, including expiration of yearly/monthly resources and fee deduction failure of pay-per-use resources. POLICE: The cloud service is frozen for public security. ILLEGAL: The cloud service is frozen due to violation of laws and regulations. VERIFY: The cloud service is frozen because the user fails to pass the real-name authentication. PARTNER: A partner freezes their customer's resources.

Example Requests

Creating an endpoint whose type is EIP, weight is 10, and IP address is 208.182.11.121

POST https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007/endpoints

{
  "endpoint" : {
    "resource_id" : "08155cd2-5897-49be-933f-eec757fd4010",
    "resource_type" : "EIP",
    "weight" : 10,
    "ip_address" : "208.182.11.121"
  }
}

Example Responses

Status code: 201

Endpoint added.

{
  "endpoint" : {
    "id" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d",
    "resource_id" : "08155cd2-5897-49be-933f-eec757fd4010",
    "endpoint_group_id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "resource_type" : "EIP",
    "status" : "ACTIVE",
    "weight" : 10,
    "health_state" : "HEALTHY",
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "ip_address" : "208.182.11.121",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}