全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeCloudResourceAccessPortDetails

    文件中心

    Web Application Firewall：DescribeCloudResourceAccessPortDetails

    更新時間：Jul 13, 2026

    查詢已接入 WAF 的雲端產品執行個體連接埠詳細資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeCloudResourceAccessPortDetails

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

    您可以呼叫 DescribeInstance ，檢視目前 WAF 執行個體的 ID。

    waf-cn-tl32ast****
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q
    ResourceInstanceId

    string

    是

    資源的執行個體 ID。

    lb-2zeugkfj81jvo****4tqm
    Port

    string

    否

    接入 WAF 的雲端產品連接埠。

    443
    Protocol

    string

    否

    通訊協定類型。

    枚舉值：

    • http :

      表示 HTTP 通訊協定。

    • https :

      表示 HTTPS 通訊協定。

    https
    PageNumber

    integer

    否

    列表的頁碼。預設值為 1。

    1
    PageSize

    integer

    否

    分頁查詢時，每頁的列數。預設值為 10。

    10
    ResourceProduct

    string

    否

    雲端產品類型。取值：

    • clb4：表示四層 CLB 產品。

    • clb7：表示七層 CLB 產品。

    • ecs：表示 ECS 產品。

    • nlb：表示 NLB 產品。

    clb7
    RegionId

    string

    否

    WAF 執行個體所屬地域。取值：

    • cn-hangzhou：表示中國內地。

    • ap-southeast-1：表示非中國內地。

    cn-hangzhou

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    2EFCFE18-78F8-5079-B312-07***48B
    TotalCount

    integer

    返回結果的總數。

    10
    AccessPortDetails

    array<object>

    已接入 WAF 的雲端產品連接埠詳細資訊。

    array<object>

    已接入 WAF 的雲端產品連接埠詳細資訊。

    Protocol

    string

    通訊協定類型。取值：

    • http：表示 HTTP 通訊協定。

    • https：表示 HTTPS 通訊協定。

    https
    Port

    integer

    接入 WAF 的雲端產品連接埠。

    443
    Certificates

    array<object>

    已接入雲端產品連接埠的憑證清單。

    object

    已接入雲端產品連接埠的憑證資訊。

    CertificateName

    string

    認證名稱。

    cert-name1
    CertificateId

    string

    已添加的認證的 ID。

    123-cn-hangzhou
    AppliedType

    string

    HTTPS 協議的認證類型。取值：

    • default：表示預設認證。

    • extension：表示拓展認證。

    default
    XffHeaderMode

    integer

    WAF 取得用戶端真實 IP 的方式。取值：

    • 0：表示用戶端存取流量到 WAF 前沒有經過其他七層代理轉送。

    • 1：表示 WAF 讀取請求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。

    • 2：表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP。

    0
    XffHeaders

    array

    設定用於取得用戶端 IP 的自訂欄位清單，使用 ["header1","header2",……] 格式表示。

    說明

    僅在 XffHeaderMode 取值為 2（表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定此參數。

    string

    設定用於取得用戶端 IP 的自訂欄位清單，使用 ["header1","header2",……] 格式表示。

    說明

    僅在 XffHeaderMode 取值為 2（表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定此參數。

    header1
    LogHeaders

    array<object>

    網域的流量標記欄位和值，用於標記經過 WAF 處理的流量。

    說明

    僅當網域開啟了流量標記功能時，返回此參數。

    object

    網域的流量標記欄位和值，用於標記經過 WAF 處理的流量。

    說明

    僅當網域開啟了流量標記功能時，返回此參數。

    Key

    string

    指定的自訂要求標頭部欄位。

    key1
    Value

    string

    指定的自訂要求標頭部欄位設定的值。

    value1
    Status

    integer

    網域狀態。取值：

    • 1：表示連接埠處於正常狀態。

    • 2：表示連接埠建立中。

    • 3：表示連接埠修改中。

    • 4：表示連接埠釋放中。

    1
    TLSVersion

    string

    TLS 的版本。取值：

    • tlsv1

    • tlsv1.1

    • tlsv1.2

    tlsv1
    EnableTLSv3

    boolean

    是否支援 TLS 1.3 版本。取值：

    • true：表示支援 TLS 1.3 版本。

    • false：表示不支援 TLS 1.3 版本。

    true
    CipherSuite

    integer

    加密套件類型。取值：

    • 1：表示新增全部加密套件。

    • 2：表示新增強加密套件。

    • 99：表示新增自訂加密套件。

    1
    CustomCiphers

    array

    要新增的具體自訂加密套件。僅 CipherSuite 設定為 99 時，使用此參數。

    string

    自訂加密套件。

    ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384
    ReadTimeout

    integer

    讀取逾時時長，單位：秒。 取值範圍：1~3600。

    5
    WriteTimeout

    integer

    寫入逾時時長，單位：秒。 取值範圍：1~3600。

    1
    Keepalive

    boolean

    是否保持長連線。取值：

    • true（預設）：表示保持長連線。

    • false：表示不保持長連線。

    true
    KeepaliveRequests

    integer

    複用長連線的請求個數。取值範圍：60~1000，單位：個。

    說明

    開啟長連線後，複用多少個長連線。

    1000
    KeepaliveTimeout

    integer

    閒置長連線逾時時間，取值範圍：10~3600，預設 15，單位：秒。

    說明

    複用的長連線閒置多久後釋放。

    10
    Http2Enabled

    boolean

    是否開啟 HTTP/2。取值：

    • true：表示開啟 HTTP/2。

    • false：表示不開啟 HTTP/2。

    True
    XffProto

    boolean

    X-Forward-For-Proto 傳遞 WAF 的通訊協定。取值：

    • true（預設）：表示傳遞 WAF 的通訊協定。

    • false：表示不傳遞 WAF 的通訊協定。

    true
    OwnerUserId

    string

    雲端產品資源歸屬 UID。

    123
    SubStatus

    string

    防護異常狀態。取值：

    • InvalidCert：表示無效憑證。

    • ClientCertOpend：表示開啟雙向認證。

    • NetworkConfigLost：表示雲端產品網路設定異常。

    InvalidCert
    SubStatusDetails

    array<object>

    防護異常狀態具體原因，僅在 SubStatus 為 InvalidCert 時有值。

    object

    防護異常狀態具體原因，僅在 SubStatus 為 InvalidCert 時有值。

    CertName

    string

    SSL 憑證中心的認證名稱。

    test-name
    Domain

    string

    認證綁定的網域名稱。

    test.aliyun.com
    CertId

    string

    SSL 憑證中心的認證 ID。

    123-cn-hangzhou
    AppliedType

    string

    HTTPS 協議的認證類型。取值：

    • default：表示預設認證。

    • extension：表示拓展認證。

    default
    ProductCertName

    string

    雲產品儲存的認證名稱。

    test-name
    ProductCertId

    string

    雲產品儲存的認證 ID。

    123
    CommonName

    string

    通用名稱（CN）

    test.aliyun.com
    ReasonCode

    string

    防護異常狀態的具體原因。取值：

    • UserUploadCert：表示手工上傳認證。

    • CertNotExistInCertCenter：表示在認證 SSL 憑證中心不存在。

    • CertExpired：表示雲認證已到期。

    • EmptyCertCN：表示認證的 CN 為空白。

    CertNotExistInCertCenter
    ExpireTime

    integer

    認證的到期時間，格式為 Unix 時間戳記，單位：秒。

    1746328456000
    CloudResourceId

    string

    接入的資源 ID，由 WAF 自動產生。

    i-bp1**************7ey-80-ecs
    MaxBodySize

    integer

    最大請求主體大小。取值範圍：2~10，預設值：2，單位：G。

    2

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "TotalCount": 10,
  "AccessPortDetails": [
    {
      "Protocol": "https",
      "Port": 443,
      "Certificates": [
        {
          "CertificateName": "cert-name1",
          "CertificateId": "123-cn-hangzhou",
          "AppliedType": "default"
        }
      ],
      "XffHeaderMode": 0,
      "XffHeaders": [
        "header1"
      ],
      "LogHeaders": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Status": 1,
      "TLSVersion": "tlsv1",
      "EnableTLSv3": true,
      "CipherSuite": 1,
      "CustomCiphers": [
        "ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384"
      ],
      "ReadTimeout": 5,
      "WriteTimeout": 1,
      "Keepalive": true,
      "KeepaliveRequests": 1000,
      "KeepaliveTimeout": 10,
      "Http2Enabled": true,
      "XffProto": true,
      "OwnerUserId": "123",
      "SubStatus": "InvalidCert",
      "SubStatusDetails": [
        {
          "CertName": "test-name",
          "Domain": "test.aliyun.com",
          "CertId": "123-cn-hangzhou",
          "AppliedType": "default",
          "ProductCertName": "test-name",
          "ProductCertId": "123",
          "CommonName": "test.aliyun.com",
          "ReasonCode": "CertNotExistInCertCenter",
          "ExpireTime": 1746328456000
        }
      ],
      "CloudResourceId": "i-bp1**************7ey-80-ecs",
      "MaxBodySize": 2
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Waf.Instance.ValidFaild WAF instance check failed. Check whether the instance ID is correct. WAF 執行個體檢查失敗，請確認執行個體 ID 是否正確。
    400 Waf.Pullin.CloudProductParamEmpty The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance. 雲端產品接入 WAF 的資源 ID 為空，或雲端產品名稱、連接埠、雲端產品執行個體等 3 個輸入參數中存在空值。
    400 Waf.Pullin.CloudResourceInvalid CloudResourceId parameter is illegal. CloudResourceId 參數不合法。

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

    變更歷史

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