查询指定的基础型加速器终端节点信息ListBasicEndpoints--全球加速-火山引擎

文档中心

立即注册

导航

查询指定的基础型加速器终端节点信息ListBasicEndpoints

最近更新时间：2024.09.29 17:02:48首次发布时间：2024.09.29 15:03:38

本接口用于查询指定的基础型加速器终端节点信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListBasicEndpoints&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListBasicEndpoints`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	否	查询的基础型加速器 ID。	`accinstance-basic-xxxx`
EndpointGroupId	String	否	查询的终端节点所属终端节点组的ID。	`endpointgroup-basic-xxxx`
PageSize	Integer	否	分页查询时每页的行数。默认值：10。最大值：100。	`10`
PageNum	Integer	否	列表的页码，默认值为1。	`1`

返回参数

参数名称	数据类型	参数说明	示例
Endpoints	Object[]	终端节点列表	`-`
TotalCount	Integer	列表条目数。	`100`
PageSize	Integer	分页查询时每页的行数。	`10`
PageNum	Integer	列表的页码。	`1`

请求示例

POST https://open.volcengineapi.com?Action=ListBasicEndpoints&Version=2022-03-01
{
    "AcceleratorId": "accinstance-basic-xxxx",
    "EndpointGroupId": "endpointgroup-basic-xxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListBasicEndpoints",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "Endpoints": [
            {
                "AccelerateIPs": [
                    {
                        "AccelerateIP": "1.1.1.1",
                        "ISP": "BGP",
                        "State": "active"
                    }
                ],
                "AcceleratorId": "accinstance-basic-xxxx",
                "EdgeNodeAlias": "节点1",
                "EndpointAddress": "1.1.1.1",
                "EndpointGroupId": "endpointgroup-basic-xxxx",
                "EndpointId": "endpoint-basic-xxxx",
                "Type": "ECS",
                "EdgeNodeName ": "node-1"
            }
        ],
        "TotalCount": 1,
        "PageSize": 10,
        "PageNum": 1
    }
}