文档

GetBasicEndpointGroup - 查询指定基础型全球加速实例的终端节点组信息

更新时间:

调用GetBasicEndpointGroup接口查询指定基础型全球加速实例的终端节点组信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:GetBasicEndpointGroupRead
  • BasicEndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/{#BasicEndpointGroupId}

请求参数

名称类型必填描述示例值
RegionIdstring

基础型全球加速实例所在的地域 ID,仅取值cn-hangzhou

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstring

基础型全球加速实例的终端节点组 ID。

epg-bp1dmlohjjz4kqaun****

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
EndpointGroupIdstring

基础型全球加速实例的终端节点组 ID。

epg-bp1dmlohjjz4kqaun****
Namestring

基础型全球加速实例的终端节点组的名称。

group1
Descriptionstring

基础型全球加速实例的终端节点组描述信息。

BasicEndpointGroup
EndpointGroupRegionstring

基础型全球加速实例的终端节点组所在的地域 ID。

cn-shanghai
EndpointTypestring

终端节点类型。

  • ENI:阿里云弹性网卡。
  • SLB:阿里云 CLB 实例。
  • ECS:阿里云 ECS 实例。
  • NLB:阿里云 NLB 实例。
ENI
EndpointAddressstring

终端节点的地址。

eni-bp1a05txelswuj8g****
Statestring

基础型全球加速实例的终端节点组的状态。

  • init:初始化。

  • active:正常。

  • updating:更新中。

  • deleting:删除中。

active
EndpointSubAddressstring

终端节点辅助地址。

当终端节点类型为 ECSENINLB 时,返回该参数。

  • 当终端节点类型为 ECS 时,EndpointSubAddress 为主网卡的辅助私网 IP 或主网卡的主私网 IP。
  • 当终端节点类型为 ENI 时,EndpointSubAddress 为辅助网卡的辅助私网 IP 或辅助网卡的主私网 IP。
  • 当终端节点类型为 NLB 时,EndpointSubAddress 为 NLB 后端服务器的主私网 IP。
172.16.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Name": "group1",
  "Description": "BasicEndpointGroup",
  "EndpointGroupRegion": "cn-shanghai",
  "EndpointType": "ENI",
  "EndpointAddress": "eni-bp1a05txelswuj8g****",
  "State": "active",
  "EndpointSubAddress": "172.16.XX.XX"
}

错误码

HTTP status code错误码错误信息描述
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史