You need to enable JavaScript to run this app.
文档中心
全球加速

全球加速

复制全文
下载 pdf
基础型加速器-终端节点组和终端节点接口
查询指定的基础型加速器终端节点组的信息 DescribeBasicEndpointGroup
复制全文
下载 pdf
查询指定的基础型加速器终端节点组的信息 DescribeBasicEndpointGroup

查询指定基础型加速器终端节点组的网络类型、区域、状态和组内终端节点,并返回组内是否存在已绑定加速 IP 的终端节点。

请求说明

  • 请求方式:POST
  • 请求地址:https://ga.volcengine-api.com?Action=DescribeBasicEndpointGroup&Version=2022-03-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数
类型
是否必填
示例值
描述
Action
String
是
DescribeBasicEndpointGroup
要执行的操作,取值:DescribeBasicEndpointGroup。
Version
String
是
2022-03-01
API 的版本,取值:2022-03-01。

Body

参数
类型
是否必填
示例值
描述
AcceleratorId
String
是
accinstance-basic-UKBfMXboZLwxFGNkiR****
指定目标终端节点组所属的加速器 ID。可通过调用 ListBasicAccelerators 接口获取账号下的加速器 ID。
EndpointGroupId
String
是
endpointgroup-basic-e8QPGGCbk2fr32Dd3y****
指定要查询的终端节点组 ID。可通过调用 ListBasicEndpointGroups 接口获取指定加速器下的终端节点组 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
AcceleratorId
String
accinstance-basic-UKBfMXboZLwxFGNkiR****
终端节点组所属加速器的 ID。
EndpointGroupId
String
endpointgroup-basic-e8QPGGCbk2fr32Dd3y****
终端节点组 ID。
EndpointType
String
public
终端节点组的网络类型。取值:
  • public:公网。
  • private:私网。
Endpoints
Object[]
终端节点组内的终端节点列表。
ExistBoundEndpoint
Boolean
true
终端节点组是否包含已绑定到加速 IP 的终端节点。
Name
String
GA-endgroup
终端节点组名称。
Region
String
CN_East
终端节点组所在区域。取值:
  • CN_North:华北。
  • CN_East:华东。
  • CN_South:华南。
  • CN_NorthEast:东北。
  • CN_Central:华中。
  • CN_NorthWest:西北。
  • CN_SouthWest:西南。
  • AP1:亚太 1。
State
String
active
终端节点组的状态。取值:
  • active:运行中。
  • deploying:配置中。

请求示例

POST https://ga.volcengine-api.com?Action=DescribeBasicEndpointGroup&Version=2022-03-01
{
  "AcceleratorId": "accinstance-basic-UKBfMXboZLwxFGNkiR****",
  "EndpointGroupId": "endpointgroup-basic-e8QPGGCbk2fr32Dd3y****"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104201234100232280022D31",
    "Action": "DescribeBasicEndpointGroup",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "AcceleratorId": "accinstance-basic-UKBfMXboZLwxFGNkiR****",
    "EndpointGroupId": "endpointgroup-basic-e8QPGGCbk2fr32Dd3y****",
    "EndpointType": "public",
    "Endpoints": [
      {
        "EndpointId": "endpoint-basic-NhQyqd6KKsBWpcC5AE****",
        "Type": "ECS",
        "EndpointAddress": "veen150012501042xxxxxxxxxxxx",
        "EdgeNodeName": "bdcdn-gdguangzhou-mp01"
      }
    ],
    "ExistBoundEndpoint": true,
    "Name": "GA-endgroup",
    "Region": "CN_East",
    "State": "active"
  }
}

错误码

本接口无专用错误码。公共错误码请参见公共错误码。

最近更新时间:2026.09.23 16:20:53
这个页面对您有帮助吗?
有用
有用
无用
无用