Querying Endpoints in an Endpoint Group
Function
This API is used to query endpoints in an endpoint group.
Calling Method
For details, see Calling APIs.
URI
GET /v1/endpoint-groups/{endpoint_group_id}/endpoints
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
endpoint_group_id |
Yes |
String |
Specifies the endpoint group ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the number of resources on each page. If this parameter is not specified, the default value is 500. |
marker |
No |
String |
Specifies the ID of the resource from which pagination query starts, that is, the ID of the last resource on the previous page. If the parameter is not specified, only resources on the first page are queried. This parameter must be used together with limit. |
page_reverse |
No |
Boolean |
Specifies the page direction. The value can be true or false, and the default value is false. The last page in the list requested with page_reverse set to false will not contain the "next" link, and the last page in the list requested with page_reverse set to true will not contain the "previous" link. |
id |
No |
String |
Specifies the resource ID. |
status |
No |
String |
Specifies the resource status. The value can be one of the following:
|
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
endpoints |
Array of EndpointDetail objects |
Specifies the endpoints. |
page_info |
PageInfo object |
Specifies the pagination query information. |
request_id |
String |
Specifies the request ID. |
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 |
Specifies the endpoint type. |
status |
String |
Specifies the provisioning status. The value can be one of the following:
|
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:
|
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. |
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:
|
Example Requests
Querying endpoints in an endpoint group
GET https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007/endpoints
Example Responses
Status code: 200
Operation succeeded.
{ "endpoints" : [ { "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" ] } } ], "page_info" : { "next_marker" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
Status Codes
Status Code |
Description |
---|---|
200 |
Operation succeeded. |
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