查询加速项目列表-网宿科技

接口描述

该接口返回加速项目列表，包括每个加速项目的ID、最新版本号、注释、演练环境版本号、生产环境版本号，以及每个版本的最后更新时间等信息。可使用查询参数筛选加速项目。

调用URL： https://open.chinanetcenter.com/cdn/properties
调用方法：GET

请求参数

Params 参数

参数名称

描述

searchString

根据搜索关键字匹配每个加速项目的id、name、description以及hostnames字段进行过滤。例如，'domain.com'将匹配到加速域名'domain.com'和'abc.123domain.com'。可以使用'^'字符限定只匹配以搜索关键字开头的值。例如，'^domain'将匹配到加速域名'domain.com'和'domain123.com'，但不会匹配到'abc.123domain.com'。由于URI仅允许有限数量的字符，当search参数包含^符号时，必须将'^'编码为'%5E'。例如，curl -i --url 'https://openapi.wangsu.com/cdn/properties?search=%5Edomain' ... 。注意，该搜索关键字将会对加速项目的所有未删除的版本进行匹配。当通过ID搜索加速项目时，必须指定完整ID，不支持部分匹配。

legacyTypeString

服务类型，根据实际服务类型传wsapro，webpro，vodpro或者downloadpro，分别指全站加速，网页加速，点播加速，下载加速。

hasConfigString

通过hasConfig参数指定字段来过滤加速项目。支持使用加速项目版本的任何字段名，在字段名后跟上冒号和值（可选）进行过滤。例如：hasConfig=hasBeian:true。当指定冒号和值时，只返回匹配该字段值的加速项目。如果需要反向查询，可以在字段值前面加上感叹号'!'。例如：hasConfig=edgeLogic!sorted，这个查询将筛选出edgeLogic字段不包含值'sorted'的加速项目。查询数字或布尔类型字段的值时需要精确匹配，而字符串字段支持部分匹配。例如，hasConfig=hostnames:domain将返回加速域名包含字符串'domain'的所有加速项目，例如'mydomain.com'和'thedomains.com'。如果省略冒号和值，则将返回指定字段值为非空的所有加速项目。可以指定多个hasConfig参数使用多个条件进行查询。例如：hasConfig=hasBeian:true&hasConfig=realTimeLog，这个查询只返回与所有参数匹配的加速项目。如果一个加速项目有多个版本，只要该加速项目的任何版本与hasConfig参数匹配，则该加速项目将包含在该接口的响应中。可以使用点号作为分隔符来指定某个字段的子字段。如果要匹配的值带有空格或特殊字符，请在URL中对其进行编码。以下是一些示例：

值	描述
hasConfig=disableHttp2:true	返回禁用HTTP2的加速项目。
hasConfig=extraServicePorts.http:85	返回支持HTTP请求端口85的加速项目。
hasConfig=origins.servers:myorigin.com	返回使用myorigin.com作为源站的加速项目。

targetString

取值范围: all,staging,production 默认值: all 根据加速项目的部署环境过滤。该值可以是'all', 'staging', 或'production'，分别表示所有环境，演练环境和生产环境。

offsetInteger

默认值: 0 取值范围: >= 0 查询起始位置。

limitInteger

默认值: 100 取值范围: <= 200 每次查询的最大条数。

sortOrderString

取值范围: asc,desc 默认值: desc 返回结果的顺序。默认按最后更新时间降序。

sortByString

取值范围: creationTime,lastUpdateTime 默认值: lastUpdateTime 返回结果的排序依据。

返回参数

Body 参数

参数名称	描述
- propertiesList	加速项目列表。
idString	加速项目ID。
descriptionString	加速项目的描述。
nameString	加速项目名称。
creationTimeString	RFC 3339格式的日期，表示创建加速项目的时间。
lastUpdateTimeString	RFC 3339格式的日期，表示加速项目的最近更新时间。
latestVersionInteger	加速项目的最新版本。
legacyTypeString	取值范围: wsapro,webpro,vodpro,downloadpro 服务类型，即全站加速，网页加速，点播加速及下载加速。
- stagingVersionGetListOfPropertiesResponsePropertiesStagingVersion	描述部署到演练环境的加速项目版本。
versionInteger	部署到演练环境的加速项目版本号。
hostnamesList	加速域名。
- productionVersionGetListOfPropertiesResponsePropertiesProductionVersion	描述部署到生产环境的加速项目版本。
versionInteger	部署到生产环境的加速项目版本号。
hostnamesList	加速域名。
countInteger	取值范围: >= 0 加速项目数量。

错误码

错误代码（code）	描述（message）	HTTP状态码	语义
InvalidListOffset	The offset must be a valid non-negative integer.	400	offset参数取值必须是大于等于0的整数。
InvalidTarget	Invalid target query parameter. Only "all", "staging", or "production" are allowed.	400	target请求参数取值无效，必须是"all"，"staging"，或者"production"。
TooManyEntries	This query could not be completed due to the exceptionally large amount of data to be processed. Please try to use some filters to reduce the scope of the query.	400	查询范围过大，请使用请求参数缩小查询范围。

示例

200

请求示例 复制代码 复制成功#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/cdn/properties" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json"

#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/cdn/properties" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"

返回示例 复制代码 复制成功{ "count": 2, "properties": [ { "id": "8fdc9c949e986564cc24b149", "name": "TestProperty1572488767058", "legacyType": "webpro", "description": "validPropertyNoCertificate_PropertySteps", "latestVersion": 1, "lastUpdateTime": "2019-10-31T02:26:07Z", "creationTime": "2019-10-31T02:26:07Z" }, { "id": "59ebc3af71985328ded56857", "name": "TestProperty1572488525164", "legacyType": "webpro", "description": "1572488525164unique description property", "latestVersion": 1, "productionVersion": { "version": 1, "hostnames": [ "testdomain-t1572488525164.mwtrial.info" ] }, "lastUpdateTime": "2019-10-31T02:22:05Z", "creationTime": "2019-10-31T02:22:05Z" } ] }

{
    "count": 2,
    "properties": [
        {
            "id": "8fdc9c949e986564cc24b149",
            "name": "TestProperty1572488767058",
            "legacyType": "webpro",
            "description": "validPropertyNoCertificate_PropertySteps",
            "latestVersion": 1,
            "lastUpdateTime": "2019-10-31T02:26:07Z",
            "creationTime": "2019-10-31T02:26:07Z"
        },
        {
            "id": "59ebc3af71985328ded56857",
            "name": "TestProperty1572488525164",
            "legacyType": "webpro",
            "description": "1572488525164unique description property",
            "latestVersion": 1,
            "productionVersion": {
                "version": 1,
                "hostnames": [
                    "testdomain-t1572488525164.mwtrial.info"
                ]
            },
            "lastUpdateTime": "2019-10-31T02:22:05Z",
            "creationTime": "2019-10-31T02:22:05Z"
        }
    ]
}

查询加速项目列表

适用产品

接口描述

请求参数

Params 参数

返回参数

Body 参数

错误码

示例

目录

热门产品与方案

快速入口

支持与服务

投资者关系

法律申明

关于网宿

联系我们

业务咨询