查询接入点列表 - ListAccessSites

功能介绍

查询接入点列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{domain_id}/geip/access-sites

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	租户账号ID，获取租户账号ID请参见租户账号ID 最小长度：5 最大长度：32

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	每页条数最小值：0 最大值：2000
offset	否	Integer	分页查询起始的资源序号
marker	否	String	功能说明：上一页最后一条记录的ID 使用说明：必须与limit一起使用输入的值必须为有效的ID值
page_reverse	否	Boolean	翻页方向
fields	否	Array of strings	功能说明：查询指定的字段，格式为fields=A&fields=B&fields=C&...... 支持的字段： id name proxy_region en_name cn_name created_at updated_at
sort_key	否	Array of strings	按照sort_key指定的字段排序
sort_dir	否	Array of strings	功能说明：排序方向取值范围：asc（升序）、desc（降序）
id	否	Array of strings	根据ID过滤，支持多值查询，查询条件格式：id=xxx&id=xxx。
name	否	Array of strings	根据名称过滤，支持多值查询，查询条件格式：name=xxx&name=xxx。
proxy_region	否	Array of strings	根据proxy_region过滤
iec_az_code	否	Array of strings	根据iec_az_code过滤

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户的Token，如何获取用户Token请参见获取用户Token

响应参数

状态码：200

表4 响应Header参数
参数	参数类型	描述
X-Request-Id	String	本次请求编号

表5 响应Body参数
参数	参数类型	描述
request_id	String	本次请求的编号
access_sites	Array of ListAccessSites objects	接入点列表
page_info	page_info object	分页页码信息

表6 ListAccessSites
参数	参数类型	描述
id	String	接入点的ID
name	String	功能说明：接入点名称取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）最小长度：1 最大长度：64
proxy_region	String	pop站点托管的region(id)
iec_az_code	String	边缘站点az
en_name	String	英文名称
cn_name	String	中文名称
created_at	String	创建时间
updated_at	String	更新时间

表7 page_info
参数	参数类型	描述
next_marker	String	翻页时，作为后一页的marker取值
previous_marker	String	翻页时，作为前一页的marker取值
current_count	Integer	当前页的数据总数

请求示例

查询接入点列表

GET https://{Endpoint}/v3/{domain_id}/geip/access-sites

响应示例

状态码：200

{
  "request_id" : "d224afc0e7add65c715707dbadd3004a",
  "access_sites" : [ {
    "name" : "cn-south-odin",
    "id" : "1529948f-b902-4669-a7f7-15892d64e162",
    "created_at" : "2023-03-30T07:08:52Z",
    "updated_at" : "2023-05-09T06:36:50Z",
    "cn_name" : "贵安奥丁一",
    "en_name" : "CN-South-Odin",
    "proxy_region" : "cn-southwest-242",
    "iec_az_code" : null
  }, {
    "name" : "cn-south-test",
    "id" : "2d6ffa48-3904-4b40-8602-9fc943994a4e",
    "created_at" : "2023-08-18T08:24:41Z",
    "updated_at" : "2023-08-18T08:59:10Z",
    "cn_name" : "test",
    "en_name" : "test",
    "proxy_region" : "cn-southwest-242",
    "iec_az_code" : "dddddadasd"
  } ],
  "page_info" : {
    "previous_marker" : "1529948f-b902-4669-a7f7-15892d64e162",
    "current_count" : 2
  }
}