1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
查询单个saaswaf域名详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDomainDetailsSaas。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
Domain | 是 | String | 域名 示例值:randy.qcloudwaf.com |
DomainId | 是 | String | 域名id 示例值:7d58ebf3db7e5f7e8f91eb047c6a7b32 |
InstanceId | 是 | String | 实例id 示例值:waf_2kw31jgy0928e5j1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DomainsPartInfo | DomainsPartInfo | 域名详情 示例值:{"Domain":"randygz2.qcloudwaf.com","DomainId":"7d58ebf3db7e5f7e8f91eb017c6a7b31","InstanceId":"waf_2kw60zgy0908e8j3","Edition":"sparta-waf","InstanceName":"广州双栈集群企业版","Cert":"","CertType":2,"Cls":1,"CreateTime":"2024-07-18 10:46:12","Cname":"dae1cae7d48ec31c7727a86a8cda2a62.qcloudzygj.com","Engine":1,"GrayAreas":[""],"HttpsRewrite":0,"HttpsUpstreamPort":"80","IsKeepAlive":1,"IsCdn":1,"IsGray":0,"IsHttp2":0,"IsWebsocket":0,"LoadBalance":0,"Mode":1,"PrivateKey":"","SSLId":"H0LMTjmj","UpstreamDomain":"","UpstreamScheme":"http","UpstreamType":0,"SrcList":["114.132.246.237"],"Weights":[],"Ports":[{"NginxServerId":231056,"Port":"80","Protocol":"http","UpstreamPort":"80","UpstreamProtocol":"http"},{"NginxServerId":321607,"Port":"443","Protocol":"https","UpstreamPort":"80","UpstreamProtocol":"http"}],"ActiveCheck":0,"TLSVersion":3,"Ciphers":[],"CipherTemplate":2,"ProxyReadTimeout":10,"ProxySendTimeout":300,"SniType":1,"SniHost":"","IpHeaders":[],"XFFReset":0,"Note":"22222","Level":"200","UpstreamHost":"","ProxyBuffer":1,"ProbeStatus":1,"GmType":0,"GmCertType":0,"GmCert":"","GmPrivateKey":"","GmEncCert":"","GmEncPrivateKey":"","GmSSLId":"","Labels":[""]} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询单个saaswaf域名详情
查询单个saaswaf域名详情
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainDetailsSaas
<公共请求参数>
{
"Domain": "jackysaas010.qcloudwaf.com",
"DomainId": "eca17401f4e55f4b946aa37a2212b729",
"InstanceId": "waf_2kzew5sy0qzrn81b"
}
输出示例
{
"Response": {
"RequestId": "4552f857-a877-4ab1-b2f3-9d31930b7f4a",
"DomainsPartInfo": {
"Domain": "jackysaas010.qcloudwaf.com",
"DomainId": "eca17401f4e55f4b946aa37a2212b729",
"InstanceId": "waf_2kzew5sy0qzrn81b",
"Edition": "sparta-waf",
"InstanceName": "test010",
"Cert": "-----BEGIN CERTIFICATE----- customer cert -----END CERTIFICATE-----",
"CertType": 0,
"Cls": 1,
"CreateTime": "2024-06-05 11:23:08",
"Cname": "dc1f8442749285feb56b39ac57049213.qcloudcjgj.com",
"Engine": 1,
"HttpsRewrite": 0,
"HttpsUpstreamPort": "80",
"IsKeepAlive": 1,
"IsCdn": 0,
"IsGray": 0,
"IsHttp2": 0,
"IsWebsocket": 0,
"LoadBalance": 0,
"Mode": 1,
"PrivateKey": "-----BEGIN RSA PRIVATE KEY----- customer key -----END RSA PRIVATE KEY-----",
"SSLId": "cnKsi3a",
"UpstreamDomain": "jack.upstream.com",
"UpstreamScheme": "http",
"UpstreamType": 0,
"SrcList": [
"143.26.159.6",
"143.26.159.8"
],
"Weights": [
"10",
"10"
],
"Ports": [
{
"NginxServerId": 235574,
"Port": "80",
"Protocol": "http",
"UpstreamPort": "80",
"UpstreamProtocol": "http"
}
],
"ActiveCheck": 0,
"TLSVersion": 3,
"Ciphers": [],
"CipherTemplate": 1,
"ProxyReadTimeout": 300,
"ProxySendTimeout": 300,
"SniType": 2,
"SniHost": "jack.sni.com",
"IpHeaders": [
"x-real-ip"
],
"XFFReset": 0,
"Note": "jack domain",
"Level": "300",
"UpstreamHost": "jack.upstream.com",
"ProxyBuffer": 1,
"GmType": 0,
"GmCertType": 0,
"Labels": [
"jack label"
]
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBErr | DBErr |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidCertificate | 证书内容非法。 |
InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |