APIセンター

EnableSingleDomainService

更新時間: 2024-04-17 14:16:26

Enable an accelerated domain with a state of "disabled" and provide accelerated service with an existing configuration.

  • リミットの詳細: When the accelerated domain name is enabled, the domain name's "enabled" state changes to "true". If the service order status for the domain name is incorrect or the domain name is in an illegal state, the interface cannot be invoked properly to enable the accelerated domain name.
  • 単一ユーザーの使用頻度: 300/5min
  • 使用できるプロダクト: APM,Content Acceleration,Dynamic Web Acceleration,Media Acceleration-Live,Media Acceleration,Media Acceleration Live Broadcast,Flood Shield,Flood Shield 2.0

リクエストパラメータ

Path パラメータ

パラメータ名説明
*domainIdInteger
Accelerate the ID of the domain name in the system Note: 1. See the url in the request example, 123344 for domain-id 2. After the domain name is successfully submitted, the location access url in the return parameter can be queried to the domain-id of the domain name; You can also query domain-id through the Get domain Configuration and Get domain List interfaces

レスポンスパラメータ

Body パラメータ

パラメータ名説明
code
Error code, which appears when HTTPStatus is not 202, represents the error type of the current request call
message
Response information, success when successful
http status code
httpstatus=202; Indicates that the new domain API was successfully invoked, and the current deployment of the new domain can be viewed using x-cnc-request-id in the header
x-cnc-request-id
Uniquely identified id for querying tasks per request (for all API)

エラーコード

エラーコード(code)説明(message)HTTPステータスコード意味
NoSuchDomainThe specified domain does not exist.400The specified domain name does not exist.
ForbiddenThe domain is being deleted403Domain name has been deleted
DomainNotDisabledThe domain you are trying to enable has not been disabled.409The domain name is enabled and cannot be enabled again.
DomainCanNotEnableDomain cannot enable.409Domain name cannot be enabled
WRONG_OPERATOROperator [$operator] can not deal with domain name [$domainName].400The author cannot operate the domain name
NULL_DOMAIN_NAMENo domain.400No domain name
PARAM_INVALIDparam: {0} is null or invalid.400Parameter {0} null or illegal
CustomerNoOwnDomaincustomer not own domain name[{0}]400customer not own domain name[{0}]
InvalidParameterNo domain was specified.400No domain was specified.
DOMAIN_EXCEEDS_ENABLE_VALIDITY_PERIODThe domain has been disabled for a long time(more than 3 months), and the historical configuration may not work. To avoid the risk, please delete the domain first, then recreate a new one. Domain Names:{0}400The domain has been disabled for a long time, and the historical configuration may not work. To avoid the risk, please delete the domain first, then recreate a new one. Domain Names:{0}

入力例

JSON
XML
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/domain/123344/enable" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"
レスポンス例
コピー コピー完了
HTTP/1.1 202 Accepted
Date: Fri, 17 May 2017 06:33:26 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd
 {"message":"success"}