[Deprecated] Batch acquisition of acceleration domain configuration - BatchDescribeNewUcdnDomain
Overview
Batch acquisition of acceleration domain configuration
💡 This interface will soon be offline, use GetUcdnDomainConfig to get domain configuration.
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is BatchDescribeNewUcdnDomain. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
| Offset | int | Data offset, default is 0, non-negative integer | No |
| Limit | int | Returns the length of the data. If Offset is specified, the default is 20, otherwise, the default is all. Non-negative integer. | No |
| DomainId.N | string | Domain id, the resource id generated when creating a domain, by default, all domain information under the account is obtained, n is a natural number. | No |
| ChannelType | string | Channels UCDN, UFile, UVideo | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| TotalCount | int | Number of domains that meet the conditions | No |
| MaxDomainNum | int | Maximum domain number, default is 20 | No |
| ChargeType | int | Current billing method, 10-Traffic Pay-As-You-Go, 20-Daily Peak Bandwidth, 30-Monthly 95th Percentile Billing, 31-Monthly Average Peak, 32-Monthly Fourth Peak, 33-Sum of Daily Average Peaks, 34- Daily 95th Percentile Average, 40-Billing Method Not Selected | No |
| LastChargeType | int | Indicates the billing method switched to last time, 10=Pay-per-flow, 20=Daily peak bandwidth, 30=Postpaid monthly, 40=Billing method not selected | No |
| Arrearage | array[string] | An array indicating arrears, the array contains the following element values, 1= Domestic traffic is in arrears 2= Overseas traffic is in arrears 3= Domestic bandwidth is in arrears 4= Overseas bandwidth is in arrears | No |
| Vip | string | VIP indicator, yes - yes no - no | No |
| DomainSet | array[DomainInfo] | Domain information list, see DomainInfo | No |
Data Model
DomainInfo
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| OriginIp | array[string] | The source IP is the IP address that the CDN server accesses when it returns to the source. Multiple source IPs are supported, which can be expressed as: [1.1.1.1,2.2.2.2]. | Yes |
| TestUrl | string | Test URL, used for domain creation acceleration test | Yes |
| CdnType | string | The business type of the accelerated domain name, 'web' represents the website, 'stream' represents video, 'download' represents download. | Yes |
| CacheConf | array[CacheConf] | Cache Configuration Rules List | Yes |
| AreaCode | string | Query bandwidth region 'cn' represents domestic, 'abroad' represents overseas. If not filled, the default is all regions. | No |
| OriginHost | string | Back-to-source Http request header Host, the default is the acceleration domain name | No |
| OriginPort | int | Origin Port | No |
| CdnProtocol | string | Acceleration type http, http|https | No |
| OriginProtocol | string | Origin Protocol http, http|https Default http | No |
| CertName | string | Certificate Name | No |
| Tag | string | Business group, default is Default | No |
| CacheHost | string | CacheHost, different domain names can be configured to the same CacheHost to achieve cache sharing, the default is the accelerated domain name. | No |
| ReferType | int | 0 whitelist, 1 blacklist | No |
| NullRefer | boolean | When ReferType is set to whitelist, NullRefer set to false means NULL refer access is not allowed, while set to true means NULL refer access is allowed. | No |
| ReferList | array[string] | Refer list, supports regular expressions | No |
| Domain | string | Domain name, the domain name accelerated by the user | No |
| DomainId | string | Domain ID, the ID generated when creating a domain | No |
| Status | string | The current status of the accelerated domain name created. 'check' represents under review, 'checkSuccess' represents review passed, 'checkFail' represents review failed, 'enable' represents accelerating, 'disable' represents stop accelerating, 'delete' represents delete accelerating, 'enableing' represents accelerating is being turned on, 'disableing' represents stop accelerating is in progress, 'deleteing' represents deletion is in progress. | No |
| Cname | string | CDN domain name. The CDN domain name generated when creating an acceleration domain name, used for setting CNAME records. | No |
| CreateTime | int | The time of domain creation. Format: Timestamp. | No |
| ValidTime | int | Start allocating Cname time. Format: Timestamp. | No |
| AccessConf | AccessConf | Access Control | No |
| ReferStatus | boolean | Refer configuration switch, true for turning on, false for turning off | No |
| HttpsStatusCn | string | Domestic HTTPS status enableing - Enabling fail - Enabling failed enable - Enabled disable - Not enabled | No |
| HttpsStatusAbroad | string | Overseas HTTPS status enableing - Enabling, fail - Enabling failed, enable - Enabled, disable - Not enabled | No |
CacheConf
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| PathPattern | string | Path mode, supports regular expression | Yes |
| CacheTTL | int | Caching Time | Yes |
| CacheUnit | string | Unit of cache time. sec (seconds), min (minutes), hour (hours), day (days). The upper limit is 1 year. | Yes |
| CacheBehavior | boolean | Whether to cache, true for caching, false for not caching. In the case of false, CacheTTL and CacheUnit are forced to be ineffective. | Yes |
| HttpCodePattern | string | Status code mode, non-200, 206 status codes, multiple status codes are separated by a vertical line (|), this attribute is only returned in the status code cache configuration list. | No |
| Description | string | Caching Rule Description | No |
| FollowOriginRule | boolean | Whether to prioritize following the source station's header caching strategy, false means not prioritizing the source station, true means prioritizing the source station's caching header. The default is 0. | No |
AccessConf
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| IpBlacklist | string | Separate multiple IPs with commas | No |
Example
Request Example
https://api.surfercloud.com/?Action=BatchDescribeNewUcdnDomain
&ProjectId=ZQiDGIbu
&Offset=0
&Limit=20
&DomainId.0=ucdn-xxxx
&ChannelType=ucdnResponse Example
{
"Action": "BatchDescribeNewUcdnDomainResponse",
"RetCode": 0
}