ListSites - List sites | ESA API - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Queries the list of sites under the current user, including site names, statuses, and configurations.

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.
SiteSearchType	string	No	The search matching mode for the site name. Default is exact match. Valid values: prefix: prefix match. suffix: suffix match. exact: exact match. fuzzy: fuzzy match.
PageNumber	integer	No	The page number for paging. The value must be greater than or equal to 1.
PageSize	integer	No	The number of entries per page for paging. Valid values: 1 to 500.
TagFilter	array<object>	No	The tag filter rules.
	object	No
Key	string	No	The tag key. Used as a filter condition for the query.
Value	string	No	The tag value. Used as a filter condition for the query.
ResourceGroupId	string	No	The resource group ID. Used as a filter condition for the query.
Status	string	No	The site status. Used as a filter condition for the query.
OnlyEnterprise	boolean	No	Specifies whether to query only Enterprise Edition sites. Set this parameter to true to query only Enterprise Edition sites.
PlanSubscribeType	string	No	The plan subscription type. Valid values: basicplan: Basic Edition. standardplan: Standard Edition. advancedplan: Premium Edition. enterpriseplan: Enterprise Edition.
Coverage	string	No	The acceleration region. Valid values: domestic: the Chinese mainland only. global: global. overseas: global (excluding the Chinese mainland).
AccessType	string	No	The access type. Valid values: NS: NS-based access. CNAME: CNAME-based access.
OrderBy	string	No	The sort field. By default, results are sorted by creation time. Valid values: gmtCreate: site creation time. visitTime: site access time.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.
PageNumber	integer	The page number of the returned data.
PageSize	integer	The number of sites displayed per page.
TotalCount	integer	The total number of sites.
Sites	array<object>	The list of queried site information.
	array<object>
AccessType	string	The site access type. Valid values: NS: NS-based access. CNAME: CNAME-based access.
CnameZone	string	The CNAME suffix of the site. For sites that use CNAME-based access, this is the CNAME suffix that needs to be configured for records.
Coverage	string	The acceleration region of the site. Valid values: domestic: the Chinese mainland only. global: global. overseas: global (excluding the Chinese mainland).
CreateTime	string	The creation time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
UpdateTime	string	The update time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
InstanceId	string	The instance ID of the plan attached to the site.
NameServerList	string	The list of name servers assigned to the site. Multiple values are separated by commas (,).
PlanName	string	The plan name.
PlanSpecName	string	The specification name of the site plan.
ResourceGroupId	string	The resource group ID.
SiteId	integer	The site ID.
SiteName	string	The site name.
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 superseded.
Tags	object	The site tags.
VerifyCode	string	The site ownership verification code. When a site uses CNAME-based access, this TXT verification code must be configured.
VisitTime	string	The access time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
OfflineReason	string	The reason why the site is disabled. Valid values: expiration_ arrears: The subscription plan has expired or the account has an overdue payment. internally_disabled: The site is disabled by the system. missing_icp: The domain name does not have an ICP filing. content_violation: Content violation. proactively_disabled: You proactively disabled the site or the site is disabled because the usage cap you configured is reached.

Examples

Success response

JSON format

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "Sites": [
    {
      "AccessType": "",
      "CnameZone": "",
      "Coverage": "",
      "CreateTime": "",
      "UpdateTime": "",
      "InstanceId": "",
      "NameServerList": "",
      "PlanName": "",
      "PlanSpecName": "",
      "ResourceGroupId": "",
      "SiteId": 0,
      "SiteName": "",
      "Status": "",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "VerifyCode": "",
      "VisitTime": "",
      "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.