调用ListEndpointGroups接口查询终端节点组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ga:ListEndpointGroups | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 全球加速实例所在的地域 ID，仅取值cn-hangzhou。 | cn-hangzhou |
| PageNumber | integer | 否 | 列表的页码，默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时每页的行数。最大值：50，默认值：10。 | 10 |
| AcceleratorId | string | 是 | 全球加速实例 ID。 | ga-bp1odcab8tmno0hdq**** |
| ListenerId | string | 否 | 监听实例 ID。 | lsr-bp1bpn0kn908w4nbw**** |
| EndpointGroupType | string | 否 | 终端节点组类型。取值：
| virtual |
| AccessLogSwitch | string | 否 | 是否开启访问日志。取值：
| on |
| EndpointGroupId | string | 否 | 终端节点组 ID。 | epg-bp16jdc00bhe97sr5**** |
| Tag | array<object> | 否 | 终端节点组的标签。 | |
| object | 否 | 终端节点组的标签。 | ||
| Key | string | 否 | 终端节点组的标签键。 一旦输入该值，则不允许为空字符串。 最多支持 64 个字符，不能以 最多支持输入 20 个标签键。 | test-key |
| Value | string | 否 | 终端节点组的标签值。一旦输入该值，可以为空字符串。 最多支持 128 个字符，不能以 最多支持输入 20 个标签值。 | test-value |
返回参数
示例
正常返回示例
JSON格式
{
"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": 100,
"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",
"EndpointProtocolVersion": "",
"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"
}
]
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | NoPermission | No permissions. | 无权限 |
| 500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 处理请求时出现错误，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-20 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-09-14 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-15 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-04-27 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2021-04-27 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |