用於查詢目前使用者下的網站列表 ,包括網站的名稱、狀態、配置等資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
esa:ListSites |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| SiteName |
string |
否 |
網站名稱。用於查詢的過濾條件。 |
example.com |
| SiteSearchType |
string |
否 |
網站名稱的搜尋匹配模式。預設為精確匹配,取值:
|
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 |
| Coverage |
string |
否 |
加速地區。取值:
|
global |
| AccessType |
string |
否 |
接入類型。取值:
|
NS |
| OrderBy |
string |
否 |
排序欄位,預設按照建立時間排序,支援
枚舉值:
|
visitTime |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
04F0F334-1335-436C-A1D7-6C044FE73368 |
| PageNumber |
integer |
返回資料的頁碼。 |
1 |
| PageSize |
integer |
每頁顯示的網站個數。 |
20 |
| TotalCount |
integer |
總共網站數量。 |
40 |
| Sites |
array<object> |
查詢到的網站資訊列表。 |
|
|
array<object> |
|||
| AccessType |
string |
網站接入類型。取值:
|
NS |
| CnameZone |
string |
網站的 CNAME 尾碼。通過 CNAME 方式接入的網站,記錄所需要配置 CNAME 的尾碼。 |
example.cname.com |
| Coverage |
string |
網站加速地區。取值:
|
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 |
integer |
網站 ID。 |
123456789**** |
| SiteName |
string |
網站名稱。 |
example.com |
| Status |
string |
網站狀態。取值:
|
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 |
| OfflineReason |
string |
網站停用原因。取值:
|
expiration_ arrears |
樣本
正常返回樣本
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",
"OfflineReason": "expiration_ arrears"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 調用服務失敗,請稍後重試或聯絡客服諮詢詳情。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。