Queries the information about websites in your account, such as the name, status, and configuration of each website.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| esa:ListSites | get | *All Resources * |
| none |
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:
| 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 |
| Coverage | string | No | The service location. Valid values:
| global |
| AccessType | string | No | The DNS setup. Valid values:
| NS |
Response parameters
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"
}
]
}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 |
|---|---|---|
| 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 |