ListSites - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the information about websites in your account, such as the name, status, and configuration of each website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SiteName	string	No	The website name. This parameter specifies a filter condition for the query.	example.com
SiteSearchType	string	No	The match mode to search for the website name. Default value: exact. Valid values: prefix: match by prefix. suffix: match by suffix. exact: exact match. fuzzy: fuzzy match.	fuzzy
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 500.	20
TagFilter	array<object>	No	The tag filtering rule.
	object	No
Key	string	No	The tag key. This parameter specifies a filter condition for the query.	tag1
Value	string	No	The tag value. This parameter specifies a filter condition for the query.	aaa
ResourceGroupId	string	No	The ID of the resource group. This parameter specifies a filter condition for the query.	rg-aekzd3styujvyei
Status	string	No	The website status. This parameter specifies a filter condition for the query.	pending
OnlyEnterprise	boolean	No	Specifies whether to query only websites on Enterprise plans. Valid values: true and false.	false
PlanSubscribeType	string	No	The plan type. Valid values: basicplan: Entrance standardplan: Pro advancedplan: Premium enterpriseplan: Enterprise	basicplan
Coverage	string	No	The service location. Valid values: domestic: the Chinese mainland global: global overseas: outside the Chinese mainland	global
AccessType	string	No	The DNS setup. Valid values: NS CNAME	NS
OrderBy	string	No	Sorting field. By default, it sorts by creation time, supporting the following options: gmtCreate: website creation time visitTime: website visit time	visitTime

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	The page number.	1
PageSize	integer	The number of websites per page.	20
TotalCount	integer	The total number of websites.	40
Sites	array<object>	The queried websites.
pageData	object
AccessType	string	The DNS setup for the website. Valid values: NS CNAME	NS
CnameZone	string	The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.	example.cname.com
Coverage	string	The service location for the website. Valid values: domestic: the Chinese mainland global: global overseas: outside the Chinese mainland	domestic
CreateTime	string	The time when the website was added. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-12-24T02:01:11Z
UpdateTime	string	The time when the website was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-12-24T02:01:11Z
InstanceId	string	The ID of the plan associated with the website.	onBvtlmIyeXLbiDw81F9
NameServerList	string	The nameservers assigned to the website domain, which are separated by commas (,).	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	The plan name.	plan-168656498****
PlanSpecName	string	The plan associated with the website.	normal
ResourceGroupId	string	The ID of the resource group.	rg-aek26g6i6se6pna
SiteId	long	The website ID.	123456789****
SiteName	string	The website name.	example.com
Status	string	The website status. Valid values: pending: The website is to be configured. active: The website is active. offline: The website is suspended. moved: The website has been added and verified by another Alibaba Cloud account.	pending
Tags	object	The tags of the website.	{"tag1":"value1"}
VerifyCode	string	The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.	verify_d516cb3740f81f0cef77d162edd1****
VisitTime	string	The website visit time is represented in the ISO 8601 date format using UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ.	2023-12-24T02:01:11Z

Examples

Sample success responses

JSONformat

{
  "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",
      "OfflineReason": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-18	The Error code has changed. The response structure of the API has changed	View Change Details
2024-11-28	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-09-23	The Error code has changed. The request parameters of the API has changed	View Change Details