Domain name for API request: waf.tencentcloudapi.com.
Query detailed information of all user domains
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeDomains. |
Version | Yes | String | Common Params. The value used for this API: 2018-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul. |
Offset | Yes | Integer | Paging offset, a multiple of limit. The minimum value is 0, and the maximum value is Total/Limit rounded up. |
Limit | Yes | Integer | Number of returned domains |
Filters.N | No | Array of FiltersItemNew | Filter array |
Parameter Name | Type | Description |
---|---|---|
Total | Integer | Total number |
Domains | Array of DomainInfo | Domain list Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query detailed information of all user instances
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomains
<Common request parameters>
{
"Offset": 1,
"Limit": 20,
"Filters": [
{
"Name": "Edition",
"Values": [
"sparta_waf"
],
"ExactMatch": true
},
{
"Name": "InstanceId",
"Values": [
"waf_000000002"
],
"ExactMatch": true
}
]
}
{
"Response": {
"Total": 1,
"Domains": [
{
"Domain": "abc",
"DomainId": "abc",
"InstanceId": "abc",
"Cname": "abc",
"Edition": "abc",
"Region": "abc",
"InstanceName": "abc",
"ClsStatus": 1,
"FlowMode": 1,
"Status": 1,
"Mode": 1,
"Engine": 1,
"CCList": [
"abc"
],
"RsList": [
"abc"
],
"Ports": [
{
"NginxServerId": 1,
"Port": "abc",
"Protocol": "abc",
"UpstreamPort": "abc",
"UpstreamProtocol": "abc"
}
],
"LoadBalancerSet": [
{
"ListenerId": "abc",
"ListenerName": "abc",
"LoadBalancerId": "abc",
"LoadBalancerName": "abc",
"Protocol": "abc",
"Region": "abc",
"Vip": "abc",
"Vport": 1,
"Zone": "abc",
"NumericalVpcId": 0,
"LoadBalancerType": "abc"
}
],
"AppId": 1,
"State": 0,
"CreateTime": "abc",
"Ipv6Status": 0,
"BotStatus": 0,
"Level": 0,
"PostCLSStatus": 0,
"PostCKafkaStatus": 0,
"CdcClusters": "abc",
"ApiStatus": 0,
"AlbType": "abc",
"SgState": 0,
"SgDetail": "abc"
}
],
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AuthFailure | CAM signature/authentication error. |
DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Parameter error. |
InvalidParameter.InvalidCertificate | Invalid certificate content. |
InvalidParameter.QueryCertBySSLIDFailed | Failed to query certificate by ID. |
InvalidParameterValue | Invalid parameter value. |
LimitExceeded | The quota limit is exceeded. |
MissingParameter | Parameters are missing |
OperationDenied | Operation denied. |
RequestLimitExceeded | Too frequent requests |
ResourceInUse | Resources are occupied. |
ResourceInsufficient | Insufficient resources. |
ResourceNotFound | Resources do not exist. |
ResourceUnavailable | Resources are unavailable. |
ResourcesSoldOut | Resources are sold out. |
UnauthorizedOperation | Unauthorized operation. |
UnknownParameter | Unknown parameter. |
UnsupportedOperation | The operation is not supported. |
Was this page helpful?