获取资源列表

最近更新时间:2019-11-22 11:06:37

1. 接口描述

接口请求域名: dayu.tencentcloudapi.com 。

获取资源列表

默认接口请求频率限制:10次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeResourceList
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(bgp表示独享包;bgp-multip表示共享包;bgpip表示高防IP;net表示高防IP专业版;shield表示棋牌)
RegionList.N Array of String 地域码搜索,可选,当不指定地域时空数组,当指定地域时,填地域码。例如:["gz", "sh"]
Line.N Array of Integer 线路搜索,可选,只有当获取高防IP资源列表是可以选填,取值为[1(BGP线路),2(南京电信),3(南京联通),99(第三方合作线路)],当获取其他产品时请填空数组;
IdList.N Array of String 资源ID搜索,可选,当不为空数组时表示获取指定资源的资源列表;
Name String 资源名称搜索,可选,当不为空字符串时表示按名称搜索资源;
IpList.N Array of String IP搜索列表,可选,当不为空时表示安装IP搜索资源;
Status.N Array of Integer 资源状态搜索列表,可选,取值为[0(运行中), 1(清洗中), 2(封堵中)],当填空数组时不进行状态搜索;
Expire Integer 即将到期搜索;可选,取值为[0(不搜索),1(搜索即将到期的资源)]
OderBy.N Array of OrderBy 排序字段,可选
Limit Integer 一页条数,填0表示不分页
Offset Integer 页起始偏移,取值为(页码-1)*一页条数
CName String 高防IP专业版资源的CNAME,可选,只对高防IP专业版资源列表有效;
Domain String 高防IP专业版资源的域名,可选,只对高防IP专业版资源列表有效;

3. 输出参数

参数名称 类型 描述
Total Integer 总记录数
ServicePacks Array of KeyValueRecord 资源记录列表
Business String 大禹子产品代号(bgp表示独享包;bgp-multip表示共享包;bgpip表示高防IP;net表示高防IP专业版;shield表示棋牌)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取资源列表

输入示例

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
&<公共请求参数>

输出示例

{
  "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": "多少"
          },
          {
            "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. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码