全部產品
Search

搜尋本產品

    Edge Security Acceleration：ListSites

    文件中心

    Edge Security Acceleration：ListSites

    更新時間：Jun 25, 2026

    用於查詢目前使用者下的站點列表，包括站點的名稱、狀態、配置等資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    esa:ListSites

    list

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SiteName

    string

    否

    站點名稱。用於查詢的篩選條件。

    SiteSearchType

    string

    否

    站點名稱的搜尋匹配模式。預設為精確匹配，取值：

    • prefix：前綴匹配。

    • suffix：後綴匹配。

    • exact：精確匹配。

    • fuzzy：模糊匹配。

    PageNumber

    integer

    否

    分頁查詢時設定的頁碼。取值大於等於 1。

    PageSize

    integer

    否

    分頁查詢時每頁的大小，取值範圍 1-500。

    TagFilter

    array<object>

    否

    標籤篩選規則。

    object

    否

    Key

    string

    否

    標籤鍵，用於查詢的篩選條件。

    Value

    string

    否

    標籤值，用於查詢的篩選條件。

    ResourceGroupId

    string

    否

    資源群組 ID。用於查詢的篩選條件。

    Status

    string

    否

    站點狀態。用於查詢的篩選條件。

    OnlyEnterprise

    boolean

    否

    僅企業版，傳 true 時代表僅查詢企業版的站點。

    PlanSubscribeType

    string

    否

    套餐訂閱類型。取值：

    • basicplan：基礎版。

    • standardplan：標準版。

    • advancedplan：高級版。

    • enterpriseplan：企業版。

    Coverage

    string

    否

    加速區域。取值：

    • domestic：僅中國內地。

    • global：全球。

    • overseas：全球（不包含中國內地）。

    AccessType

    string

    否

    接入類型。取值：

    • NS：透過 NS 託管接入。

    • CNAME：透過 CNAME 接入。

    OrderBy

    string

    否

    排序欄位，預設按照建立時間排序，支援

    • gmtCreate：站點建立時間

    • visitTime：站點訪問時間

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    PageNumber

    integer

    傳回資料的頁碼。

    PageSize

    integer

    每頁顯示的站點個數。

    TotalCount

    integer

    總共站點數量。

    Sites

    array<object>

    查詢到的站點資訊列表。

    array<object>

    AccessType

    string

    站點接入類型。取值：

    • NS：透過 NS 接入。

    • CNAME：透過 CNAME 接入。

    CnameZone

    string

    站點的 CNAME 後綴。透過 CNAME 方式接入的站點，記錄所需要設定 CNAME 的後綴。

    Coverage

    string

    站點加速區域。取值：

    • domestic：僅中國內地。

    • global：全球。

    • overseas：全球（不包含中國內地）。

    CreateTime

    string

    站點的建立時間，日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    UpdateTime

    string

    站點的更新時間，日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    InstanceId

    string

    站點綁定的套餐實例 ID。

    NameServerList

    string

    站點分配的 NS 列表。使用半形逗號（,）分隔。

    PlanName

    string

    套餐名稱。

    PlanSpecName

    string

    站點套餐的規格名稱。

    ResourceGroupId

    string

    資源群組 ID。

    SiteId

    integer

    站點 ID。

    SiteName

    string

    站點名稱。

    Status

    string

    站點狀態。取值：

    • pending：站點待設定。

    • active：站點已啟用。

    • offline：站點已下線。

    • moved：站點已被頂替。

    Tags

    object

    站點標籤。

    VerifyCode

    string

    站點歸屬驗證碼。當站點透過 CNAME 接入時，需要設定的 TXT 驗證碼。

    VisitTime

    string

    站點的訪問時間，日期格式按照 ISO8601 表示法，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    OfflineReason

    string

    站點停用原因。取值：

    • expiration_ arrears：訂閱套餐到期或帳號欠費。

    • internally_disabled：被系統內部停用。

    • missing_icp：網域缺少 ICP。

    • content_violation：內容違規。

    • proactively_disabled：您主動停用或您設定的用量封頂停用。

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InternalException Failed to call the service. Try again later or contact technical support.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。