APIセンター

ListProperties

更新時間: 2025-09-09 11:36:38

Get List of Properties

  • 単一ユーザーの使用頻度: 300/5min
  • 使用できるプロダクト: Dynamic Web Acceleration
API認証の詳細については、以下を参照してください:API認証の概要

リクエストパラメータ

クエリパラメータ

パラメータ名説明
serviceTypeString
選択可能な値:wsawsa-https
Unique identifier for the product
targetString
選択可能な値:stagingproduction
Deployment Environment
offsetInteger
デフォルト値:0
Indicates the first item to return.
limitInteger
デフォルト値:100
Maximum number of properties to return. Range: <= 200
sortOrderString
デフォルト値:desc
選択可能な値:ascdesc
Order of properties to return.
sortByString
デフォルト値:lastUpdateTime
選択可能な値:creationTimelastUpdateTime
Returns results in sorted order.
contractIdString
The id of contract, such as 40015677
itemIdString
The id of product, such as 10

レスポンスパラメータ

Body パラメータ

パラメータ名説明
codeString
Response code, 0 means successful.
messageString
Response error message if failed.
dataObject
Response data.
countInteger
Number of properties.
propertiesList
List of properties.
propertyIdLong
Property ID
propertyNameString
Name of the property.
propertyCommentString
A description of the property.
serviceTypeString
選択可能な値:wsawsa-https
Unique identifier for the product.
creationTimeString
RFC3339 format date indicating when the property was created.
lastUpdateTimeString
RFC3339 date indicating when the property was last updated.
latestVersionInteger
Latest version of the property.
stagingVersionObject
Describes the version of the property deployed to staging.
versionInteger
Version of the property.
hostnamesList
hostnames.
productionVersionObject
Describes the version of the property deployed to production.
versionInteger
Version of the property.
hostnamesList
hostnames.
stagingDeployingVersionObject
Describes the version of the property deploying to staging.
versionInteger
Version of the property.
hostnamesList
hostnames.
productionDeployingVersionObject
Describes the version of the property deploying to production.
versionInteger
Version of the property.
hostnamesList
hostnames.
contractIdString
The id of contract
itemIdString
The id of product

エラーコード

エラーコード(code)説明(message)HTTPステータスコード意味
0success200success

入力例

JSON-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" \
レスポンス例
コピー コピー完了
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"]}}]}}