查询项目列表-文档中心

GET

https://api.cdnetworks.com/api/properties

查询项目列表

单用户调用频率：300/5min
适用产品：动态加速

API鉴权说明详见：API鉴权概览

请求参数

查询参数

参数名称	描述
serviceTypeString	可选值：wsawsa-https 服务类型
targetString	可选值：stagingproduction 加速项目的部署环境
offsetInteger	默认值：0 查询起始位置，取值范围：>= 0
limitInteger	默认值：100 每次查询的最大条数。取值范围: <= 200
sortOrderString	默认值：desc 可选值：ascdesc 返回结果的顺序。默认按最后更新时间降序。
sortByString	默认值：lastUpdateTime 可选值：creationTimelastUpdateTime 返回结果的排序依据。
contractIdString	合同号，如40015677
itemIdString	产品号，如10

返回参数

Body 参数

参数名称	描述
codeString	接口响应code，0代表成功。
messageString	接口响应信息，success代表成功，失败则提供失败信息。
- dataObject	接口响应数据
countInteger	项目数量。
- propertiesList	项目列表。
propertyIdLong	项目标识
propertyNameString	项目的名称
propertyCommentString	项目的描述。
serviceTypeString	可选值：wsawsa-https 服务类型
creationTimeString	RFC 3339格式的日期，表示创建项目的时间。
lastUpdateTimeString	RFC 3339格式的日期，表示项目的最近更新时间。
latestVersionInteger	项目的最新版本。
- stagingVersionObject	描述已部署到演练环境的项目版本。
versionInteger	项目的版本
hostnamesList	域名列表
- productionVersionObject	描述已部署到生产环境的项目版本。
versionInteger	项目的版本
hostnamesList	域名列表
- stagingDeployingVersionObject	描述正在部署到演练环境的项目版本。
versionInteger	项目的版本
hostnamesList	域名列表
- productionDeployingVersionObject	描述正在部署到生产环境的项目版本。
versionInteger	项目的版本
hostnamesList	域名列表
contractIdString	合同号
itemIdString	产品号

错误码

错误代码（code）	描述（message）	HTTP状态码	语义
0	success	200	请求成功

示例

JSON-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://api.cdnetworks.com/api/properties" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type: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://api.cdnetworks.com/api/properties" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \

返回示例 复制代码 复制成功HTTP/1.1 200 Ok x-cnc-request-id: a123c383-5443-4eab Date: Wed, 26 Jun 2024 09:38:00 GMT x-cnc-process-time: 6.53 Content-Type: application/json;charset=utf-8 {"message":"success","code":"0","data":{"count":1,"properties":[{"propertyId":123456,"propertyName":"demo","propertyComment":"I am a demo.","offerCode":"wsa","creationTime":"2024-10-10T08:08:00Z","lastUpdateTime":"2024-10-10T08:08:18Z","latestVersion":1,"stagingVersion":{"version":1,"hostnames":["www.example.com"]}}]}}

HTTP/1.1 200 Ok
x-cnc-request-id: a123c383-5443-4eab
Date: Wed, 26 Jun 2024 09:38:00 GMT
x-cnc-process-time: 6.53
Content-Type: application/json;charset=utf-8

{"message":"success","code":"0","data":{"count":1,"properties":[{"propertyId":123456,"propertyName":"demo","propertyComment":"I am a demo.","offerCode":"wsa","creationTime":"2024-10-10T08:08:00Z","lastUpdateTime":"2024-10-10T08:08:18Z","latestVersion":1,"stagingVersion":{"version":1,"hostnames":["www.example.com"]}}]}}

本篇文档内容对您是否有帮助？

有帮助

我要反馈

查询项目列表

请求参数

查询参数

返回参数

Body 参数

错误码

示例

目录