ListSites - 查询站点列表_边缘安全加速(ESA)-阿里云帮助中心

用于查询当前用户下的站点列表，包括站点的名称、状态、配置等信息。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
esa:ListSites	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SiteName	string	否	站点名称。用于查询的过滤条件。	example.com
SiteSearchType	string	否	站点名称的搜索匹配模式。默认为精确匹配，取值： prefix：前缀匹配。 suffix：后缀匹配。 exact：精确匹配。 fuzzy：模糊匹配。	fuzzy
PageNumber	integer	否	页码。默认值：1。	1
PageSize	integer	否	分页大小。默认值：500。	20
TagFilter	array<object>	否	标签过滤规则。
	object	否
Key	string	否	标签键，用于查询的过滤条件。	tag1
Value	string	否	标签值，用于查询的过滤条件。	aaa
ResourceGroupId	string	否	资源组 ID。用于查询的过滤条件。	rg-aekzd3styujvyei
Status	string	否	站点状态。用于查询的过滤条件。	pending
OnlyEnterprise	boolean	否	仅企业版，传 true 时代表仅查询企业版的站点。	false
PlanSubscribeType	string	否	套餐订阅类型。取值： basicplan: 基础版。 standardplan：标准版。 advancedplan：高级版。 enterpriseplan：企业版。	basicplan
Coverage	string	否	加速区域。取值： domestic：仅中国内地。 global：全球。 overseas：全球（不包含中国内地）。	global
AccessType	string	否	接入类型。取值： NS：通过 NS 托管接入。 CNAME：通过 CNAME 接入。	NS
OrderBy	string	否	排序字段，默认按照创建时间排序，支持 gmtCreate：站点创建时间 visitTime：站点访问时间	visitTime

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	返回数据的页码。	1
PageSize	integer	每页显示的站点个数。	20
TotalCount	integer	总共站点数量。	40
Sites	array<object>	查询到的站点信息列表。
pageData	object
AccessType	string	站点接入类型。取值： NS：通过 NS 接入。 CNAME：通过 CNAME 接入。	NS
CnameZone	string	站点的 CNAME 后缀。通过 CNAME 方式接入的站点，记录所需要配置 CNAME 的后缀。	example.cname.com
Coverage	string	站点加速区域。取值： domestic：仅中国内地。 global：全球。 overseas：全球（不包含中国内地）。	domestic
CreateTime	string	站点的创建时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-12-24T02:01:11Z
UpdateTime	string	站点的更新时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-12-24T02:01:11Z
InstanceId	string	站点绑定的套餐实例 ID。	onBvtlmIyeXLbiDw81F9
NameServerList	string	站点分配的 NS 列表。使用半角逗号（,）分隔。	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	套餐名称。	plan-168656498****
PlanSpecName	string	站点套餐的规格名称。	normal
ResourceGroupId	string	资源组 ID。	rg-aek26g6i6se6pna
SiteId	long	站点 ID。	123456789****
SiteName	string	站点名称。	example.com
Status	string	站点状态。取值： pending：站点待配置。 active：站点已激活。 offline：站点已下线。 moved：站点已被顶替。	pending
Tags	object	站点标签。	{"tag1":"value1"}
VerifyCode	string	站点归属校验码。当站点通过 CNAME 接入时，需要配置的 TXT 校验码。	verify_d516cb3740f81f0cef77d162edd1****
VisitTime	string	站点的访问时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-12-24T02:01:11Z

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 40,
  "Sites": [
    {
      "AccessType": "NS",
      "CnameZone": "example.cname.com",
      "Coverage": "domestic",
      "CreateTime": "2023-12-24T02:01:11Z",
      "UpdateTime": "2023-12-24T02:01:11Z",
      "InstanceId": "onBvtlmIyeXLbiDw81F9",
      "NameServerList": "male1-1.ialicdn.com,female1-1.ialicdn.com",
      "PlanName": "plan-168656498****",
      "PlanSpecName": "normal",
      "ResourceGroupId": "rg-aek26g6i6se6pna",
      "SiteId": 0,
      "SiteName": "example.com",
      "Status": "pending",
      "Tags": {
        "tag1": "value1"
      },
      "VerifyCode": "verify_d516cb3740f81f0cef77d162edd1****",
      "VisitTime": "2023-12-24T02:01:11Z"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

变更时间	变更内容概要	操作
2024-11-28	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-09-23	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情