ListSites - List sites | ESA API - Edge Security Acceleration

Queries a list of sites for the current user, including information such as the site name, status, and configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListSites

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SiteName	string	No	The site name. Used as a filter condition for the query.	example.com
SiteSearchType	string	No	The search match mode for the site name. Default value: exact. Valid values: prefix: prefix match suffix: suffix match exact: exact match fuzzy: fuzzy match	fuzzy
PageNumber	integer	No	The page number Settings for paging in a paged query. The value must be greater than or equal to 1.	1
PageSize	integer	No	The number of entries per page for paging in a paged query. Valid values: 1 to 500.	20
TagFilter	array<object>	No	The tag filter rules.
	object	No
Key	string	No	The tag key. Used as a filter condition for the query.	tag1
Value	string	No	The tag value. Used as a filter condition for the query.	aaa
ResourceGroupId	string	No	The resource group ID. Used as a filter condition for the query.	rg-aekzd3styujvyei
Status	string	No	The site status. Used as a filter condition for the query.	pending
OnlyEnterprise	boolean	No	Specifies whether to query only Enterprise Edition sites. If you set this parameter to true, only Enterprise Edition sites are queried.	false
PlanSubscribeType	string	No	The subscription plan type. Valid values: basicplan: basic edition standardplan: standard edition advancedplan: advanced edition enterpriseplan: enterprise edition	basicplan
Coverage	string	No	The acceleration region. Valid values: domestic: the Chinese mainland global: global overseas: global (excluding the Chinese mainland)	global
AccessType	string	No	The access type. Valid values: NS: NS hosting access CNAME: CNAME access	NS
OrderBy	string	No	The sort field. By default, sites are sorted by creation time. Valid values: gmtCreate: site creation time visitTime: site access time	visitTime

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	The page number of the returned data.	1
PageSize	integer	The number of sites displayed per page.	20
TotalCount	integer	The total number of sites.	40
Sites	array<object>	The list of queried sites.
	array<object>
AccessType	string	The site access type. Valid values: NS: NS access CNAME: CNAME access	NS
CnameZone	string	The CNAME suffix of the site. For sites accessed through CNAME, this records the CNAME suffix that needs to be configured.	example.cname.com
Coverage	string	The site acceleration region. Valid values: domestic: the Chinese mainland global: global overseas: global (excluding the Chinese mainland)	domestic
CreateTime	string	The creation time of the site. The time is displayed in UTC and formatted in accordance with ISO 8601 in the yyyy-MM-ddTHH:mm:ssZ format.	2023-12-24T02:01:11Z
UpdateTime	string	The update time of the site. The time is displayed in UTC and formatted in accordance with ISO 8601 in the yyyy-MM-ddTHH:mm:ssZ format.	2023-12-24T02:01:11Z
InstanceId	string	The instance ID of the plan that you attach to the site.	onBvtlmIyeXLbiDw81F9
NameServerList	string	The list of name servers assigned to the site. Multiple name servers are separated by commas (,).	male1-1.ialicdn.com,female1-1.ialicdn.com
PlanName	string	The plan name.	plan-168656498****
PlanSpecName	string	The specification name of the site plan.	normal
ResourceGroupId	string	The resource group ID.	rg-aek26g6i6se6pna
SiteId	integer	The site ID.	123456789****
SiteName	string	The site name.	example.com
Status	string	The site status. Valid values: pending: The site is pending configuration. active: The site is activated. offline: The site is offline. moved: The site has been replaced.	pending
Tags	object	The site tags.	{"tag1":"value1"}
VerifyCode	string	The site ownership verification code. When a site is accessed through CNAME, this is the TXT verification code that needs to be configured.	verify_d516cb3740f81f0cef77d162edd1****
VisitTime	string	The access time of the site. The time is displayed in UTC and formatted in accordance with ISO 8601 in the yyyy-MM-ddTHH:mm:ssZ format.	2023-12-24T02:01:11Z
OfflineReason	string	The reason why the site is disabled. Valid values: expiration_ arrears: The plan you subscribe to has expired or the account has an overdue payment. internally_disabled: The site is disabled by the system. missing_icp: The domain name lacks an ICP filing. content_violation: The site is disabled due to a content violation. proactively_disabled: You proactively disabled the site or the site is disabled because it reached the usage cap Settings.	expiration_ arrears

Examples

Success response

JSON format

{
  "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": "expiration_ arrears"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.