All Documents
Current Document

Content is empty

If you don't find the content you expect, please try another search term

Documentation

GetCdnDomainBasicInfo

Last updated:2021-03-17 10:54:18

GetCdnDomainBasicInfo

Description

You can call this operation to query basic information about a domain name.

Request syntax

The API request contains the specified directory /2016-09-01/domain/GetCdnDomainBasicInfo, common request headers, and operation-specific request parameters. For more information, see the sample request.

Request parameters

Parameter Required Type Description
DomainId Yes String The ID of the domain name. You can specify only one ID at a time.

Response parameters

Parameter Type Description
DomainName String The domain name that has been added to Kingsoft Cloud CDN for accelerated content delivery.
DomainId String The ID of the domain name.
Cname String The CNAME domain name. You must map the domain name to this CNAME domain name in the system of your DNS service provider.
DomainStatus String The status of the domain name.
CdnType String The business type of the domain name.
CdnSubType String The business subtype of the domain name, which is used to distinguish between businesses. This parameter is left empty by default. For more information about the enumeration types, see Usage notes.
ProjectId String The project ID of the domain name.
IcpRegistration String The ICP filing number.
AuditFailReason String The review failure cause.
CdnProtocol String The CDN access protocol. Default value: http. Valid values for live streaming are http+flv, hls, and rtmp. If the business type is file, video, or page, the access protocol is http. If the business type is live, the access protocol is http+flv, hls, or rtmp.
Regions String The billing region. Multiple regions are separated with commas (,).
OriginType String The type of the origin. Valid values: ipaddr (IP address), domain (domain name), KS3, and ksvideo (video cloud of Kingsoft Cloud).
OriginProtocol String The back-to-origin protocol. Valid values: http, https, follow, rtmp, and hls. If the business type is file, video, or page, the back-to-origin protocol is http, https, or follow. The value follow indicates that the access protocol is used as the back-to-origin protocol. If the business type is live, the back-to-origin protocol is rtmp or hls. If the access protocol is hls, the back-to-origin protocol must be hls. If the access protocol is http+flv or rtmp, the back-to-origin protocol must be rtmp.
Origin String The back-to-origin address, which is an IP address or a domain name. The system can return up to 20 IP addresses separated with commas (,) or only one domain name.
CreatedTime String The time when the domain name was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time is displayed in UTC+8. Example: 2016-08-01T21:14+0800.
ModifiedTime String The time when the domain name was modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm+0800 format. The time is displayed in UTC+8. Example: 2016-08-01T21:14+0800.

Examples

Sample request

GET method:

GET /2016-09-01/domain/GetCdnDomainBasicInfo?DomainId=2D09RHK
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetCdnDomainBasicInfo
x-version: 2016-09-01

POST method:

POST /2016-09-01/domain/GetCdnDomainBasicInfo 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetCdnDomainBasicInfo
x-version: 2016-09-01
Content-Type: application/x-www-form-urlencoded

DomainId=2D09RHK

Sample response

{
  "DomainName": "www.test.com",
  "DomainId": "2D09RHK",
  "Cname": "www.test.com.rtmpvcloud.ks-cdn.com",
  "DomainStatus": "online",
  "CdnType": "page",
  "CdnSubType": "web",
  "IcpRegistration": "Beijing ICP Certificate No. 030173-1",
  "AuditFailReason": "",
  "CdnProtocol": "http",
  "Regions": "AS,CN",
  "OriginType": "ipaddr",
  "OriginProtocol": "follow",
  "Origin": "www.test.com",
  "CreatedTime": "2020-04-29T16:26+0800",
  "ModifiedTime": "2020-11-03T16:31+0800",
  "SearchUrl": "www.test.com:80/kscdndetect.gif",
  "ProjectId": 0,
  "projectName": "default"
}

Error codes

To help you quickly locate issues, Kingsoft Cloud CDN summarizes the error codes. For more information, see Usage notes.

On this page
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback