Queries a list of endpoint groups.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ga:ListEndpointGroups | List |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou. | cn-hangzhou |
| PageNumber | integer | No | The number of the page to return. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Maximum value: 50. Default value: 10. | 10 |
| AcceleratorId | string | Yes | The ID of the GA instance. | ga-bp1odcab8tmno0hdq**** |
| ListenerId | string | No | The ID of the listener. | lsr-bp1bpn0kn908w4nbw**** |
| EndpointGroupType | string | No | The type of the endpoint group. Valid values:
| virtual |
| AccessLogSwitch | string | No | Specifies whether the access logging feature is enabled. Default value: off. Valid values:
| on |
| EndpointGroupId | string | No | The ID of the endpoint group. | epg-bp16jdc00bhe97sr5**** |
| Tag | object [] | No | The tag of the endpoint group. | |
| Key | string | No | The tag key of the endpoint group. It cannot be an empty string. The tag key can be up to 64 characters in length and cannot contain You can specify up to 20 tag keys. | test-key |
| Value | string | No | The tag value of the endpoint group. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain You can specify up to 20 tag values. | test-value |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"PageSize": 10,
"RequestId": "A052D49E-CCC2-41DB-816C-DC3381503194\t",
"PageNumber": 1,
"EndpointGroups": [
{
"EndpointGroupId": "epg-bp16jdc00bhe97sr5****",
"EndpointGroupIpList": [
"47.1.XX.XX"
],
"EndpointGroupUnconfirmedIpList": [
"47.1.XX.XX"
],
"State": "active",
"HealthCheckPath": "/healthcheck",
"EndpointGroupRegion": "cn-hangzhou",
"HealthCheckIntervalSeconds": 3,
"TrafficPercentage": 20,
"HealthCheckProtocol": "tcp",
"ThresholdCount": 3,
"ListenerId": "lsr-bp1bpn0kn908w4nbw****",
"AcceleratorId": "ga-bp1odcab8tmno0hdq****",
"EndpointConfigurations": [
{
"Type": "Ip",
"EnableClientIPPreservation": false,
"Weight": 20,
"ProbeProtocol": "tcp",
"Endpoint": "47.1.XX.XX",
"ProbePort": 80,
"EndpointId": "ep-bp1d2utp8qqe2a44t****",
"SubAddress": "172.168.XX.XX"
}
],
"PortOverrides": [
{
"ListenerPort": 443,
"EndpointPort": 80
}
],
"ForwardingRuleIds": [
"frule-bp19a3t3yzr21q3****"
],
"EndpointGroupType": "default",
"EndpointRequestProtocol": "HTTP",
"Description": "group1",
"Name": "group1",
"HealthCheckPort": 10,
"HealthCheckEnabled": true,
"ServiceId": "ALB",
"ServiceManaged": true,
"ServiceManagedInfos": [
{
"Action": "Update",
"ChildType": "Listener",
"IsManaged": false
}
],
"Tags": [
{
"Key": "test-key",
"Value": "test-value"
}
]
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | NoPermission | No permissions. | No permissions. |
| 500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | An error occurred while the request was being processed. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-09-14 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-08-15 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-07-20 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-04-27 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2021-04-27 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||
|