DescribeResourceList

Last updated: 2020-07-31 10:09:15

1. API Description

Domain name for API request: dayu.tencentcloudapi.com.

This API is used to get the resource list.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: DescribeResourceList.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Business Yes String Anti-DDoS service type. bgp: Anti-DDoS Pro (single IP), bgp-multip: Anti-DDoS Pro (multi-IP), bgpip: Anti-DDoS Advanced, net: Anti-DDoS Ultimate)
RegionList.N No Array of String Region code search, which is optional. If no regions are to be specified, enter an empty array. If a region is to be specified, enter a region code, such as ["gz", "sh"]
Line.N No Array of Integer Line search. This field can be optionally entered only when getting the list of Anti-DDoS Advanced resources. Valid values: [1 (BGP line), 2 (Nanjing Telecom), 3 (Nanjing Unicom), 99 (third-party partner line)]. Please enter an empty array when getting other products;
IdList.N No Array of String Resource ID search, which is optional. If this field is not an empty array, it means to get the resource list of a specified resource;
Name No String Resource name search, which is optional. If this field is not an empty string, it means to search for resources by name;
IpList.N No Array of String IP search list, which is optional. If this field is not empty, it means to search for resources by IP;
Status.N No Array of Integer Resource status search list, which is optional. Valid values: [0 (running), 1 (cleansing), 2 (blocking)]. No status search will be performed if an empty array is entered;
Expire No Integer Expiring resource search, which is optional. Valid values: [0 (no search), 1 (search for expiring resources)]
OderBy.N No Array of OrderBy Sort by field, which is optional
Limit No Integer Number of entries per page. A value of 0 means no pagination
Offset No Integer Page start offset, whose value is (page number - 1) * number of entries per page
CName No String CNAME of Anti-DDoS Ultimate resource, which is optional and only valid for the Anti-DDoS Ultimate resource list;
Domain No String Domain name of Anti-DDoS Ultimate resource, which is optional and only valid for the Anti-DDoS Ultimate resource list;

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of records
ServicePacks Array of KeyValueRecord Resource record list. Valid values of key:
"Key": "CreateTime" - resource instance purchase time
"Key": "Region" - resource instance region
"Key": "BoundIP" - IP bound to single IP instance
"Key": "Id" - resource instance ID
"Key": "CCEnabled" - CC protection status of resource instance
"Key": "DDoSThreshold" - DDoS cleansing threshold of resource instance
"Key": "BoundStatus" - IP binding status of single IP instance or multi-IP instance (binding or bound)
"Key": "Type" - this field has been disused
"Key": "ElasticLimit" - elastic protection value of resource instance
"Key": "DDoSAI" - DDoS AI protection status of resource instance
"Key": "Bandwidth" - base protection value of resource instance
"Key": "OverloadCount" - number of attacks to the resource instance that exceed the elastic protection value
"Key": "Status" - resource instance status (idle: running, attacking: attacking, blocking: blocking, isolate: isolating)
"Key": "Lbid" - this field has been disused
"Key": "ShowFlag" - this field has been disused
"Key": "Expire" - resource instance expiration time
"Key": "CCThreshold" - CC protection triggering threshold of resource instance
"Key": "AutoRenewFlag" - auto-renewal flag of resource instance
"Key": "IspCode" - line of single IP instance or multi-IP instance (0: China Telecom, 1: China Unicom, 2: China Mobile, 5: BGP)
"Key": "PackType" - package type
"Key": "PackId" - package ID
"Key": "Name" - resource instance name
"Key": "Locked" - this field has been disused
"Key": "IpDDoSLevel" - protection level of resource instance (low: loose, middle: normal, high: strict)
"Key": "DefendStatus" - DDoS protection status of resource (enabled or temporarily disabled)
"Key": "UndefendExpire" - end time of temporary disablement of DDoS protection for resource instance
"Key": "Tgw" - whether the resource instance is a new resource
Business String Anti-DDoS service type. bgp: Anti-DDoS Pro (single IP), bgp-multip: Anti-DDoS Pro (multi-IP), bgpip: Anti-DDoS Advanced, net: Anti-DDoS Ultimate)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting resource list.

Input Example

https://dayu.tencentcloudapi.com/?Action=DescribeResourceList
&Business=bgpip
&RegionList.0=gz
&Line.0=1
&IdList.0=bgpip-000000001
&IpList.0=3.3.3.3
&Name=""
&Status.0=0
&Status.1=1
&Status.2=2
&Expire=0
&OderBy0.Field=bandwidth
&OderBy0.Order=DESC
&Limit=30
&Offset=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "8466d9e1-70a9-4575-8e02-df15bd50bc49",
    "Business": "bgpip",
    "ServicePacks": [
      {
        "Record": [
          {
            "Key": "Id",
            "Value": "net-0000000v"
          },
          {
            "Key": "DdosMax",
            "Value": "20000"
          },
          {
            "Key": "ElasticLimit",
            "Value": "0"
          },
          {
            "Key": "AutoRenewFlag",
            "Value": "0"
          },
          {
            "Key": "DDoSLevel",
            "Value": "middle"
          },
          {
            "Key": "RuleLimit",
            "Value": "60"
          },
          {
            "Key": "DdosThreshold",
            "Value": "0"
          },
          {
            "Key": "CurrentRegion",
            "Value": "bj"
          },
          {
            "Key": "DdosOverload",
            "Value": "0"
          },
          {
            "Key": "CCMax",
            "Value": "40000"
          },
          {
            "Key": "CName",
            "Value": "17fa9bb3.dayugslb.com"
          },
          {
            "Key": "CreateTime",
            "Value": "2018-09-26 21:39:55"
          },
          {
            "Key": "IsolateTime",
            "Value": "0000-00-00 00:00:00"
          },
          {
            "Key": "Name",
            "Value": "Quantity"
          },
          {
            "Key": "OriginRegion",
            "Value": "bj"
          },
          {
            "Key": "CurrentGroup",
            "Value": "100"
          },
          {
            "Key": "ReturnHour",
            "Value": "2"
          },
          {
            "Key": "Expire",
            "Value": "2018-10-26 21:39:55"
          },
          {
            "Key": "ServiceBandwidth",
            "Value": "100"
          },
          {
            "Key": "CCEnabled",
            "Value": "0"
          },
          {
            "Key": "AutoReturn",
            "Value": "1"
          },
          {
            "Key": "CCThreshold",
            "Value": "0"
          },
          {
            "Key": "Status",
            "Value": "idle"
          },
          {
            "Key": "TransRules",
            "Value": "0"
          }
        ]
      }
    ],
    "Total": 1
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help