DescribeCloudResourceAccessPortDetails - 查询已接入WAF的云产品实例端口详情

查询已接入WAF的云产品实例端口详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeCloudResourceAccessPortDetails

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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 的云产品端口详情
	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	是否支持 TLS1.3 版本。取值： true：表示支持 TLS1.3 版本。 false：表示不支持 TLS1.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	是否开启 HTTP2。取值： true：表示开启 HTTP2。 false：表示不开启 HTTP2。	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

示例

正常返回示例

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
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Waf.Instance.ValidFaild	WAF instance check failed. Check whether the instance ID is correct.	WAF实例检查失败，请确认实例ID是否正确

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。