Data Types

Last updated: 2019-08-21 15:33:59

PDF

CacheOptResult

Result of blocking/unblocking URLs

Referenced by: DisableCaches, EnableCaches.

Name Type Description
SuccessUrls Array of String List of successful URLs
Note: This field may return null, indicating that no valid values can be obtained.
FailUrls Array of String List of failed URLs
Note: This field may return null, indicating that no valid values can be obtained.

CdnData

Detailed access data

Referenced by: DescribeCdnData, DescribeIpVisit, DescribeOriginData.

Name Type Description
Metric String Query the specified metric:
flux: Traffic (in bytes)
bandwidth: Bandwidth (in bps)
request: Number of requests
fluxHitRate: Traffic hit rate (in %)
statusCode: Status code; return the aggregated data for 2xx, 3xx, 4xx, and 5xx status codes (in entries)
2XX: Return the aggregated list of 2xx status codes and the data for status codes starting with 2 (in entries)
3XX: Return the aggregated list of 3xx status codes and the data for status codes starting with 3 (in entries)
4XX: Return the aggregated list of 4xx status codes and the data for status codes starting with 4 (in entries)
5XX: Return the aggregated list of 5xx status codes and the data for status codes starting with 5 (in entries)
Alternatively, you can specify a specific status code for querying
DetailData Array of TimestampData Detailed data combination
SummarizedData SummarizedData Aggregated data combination

MapInfo

Query the mapping between a name and an ID

Referenced by: DescribeMapInfo.

Name Type Description
Id Integer Object ID
Name String Object name

ResourceData

Query an object and its access details

Referenced by: DescribeCdnData and DescribeIpVisit.

Name Type Description
Resource String Resource name, which is classified as follows based on different query conditions:
A specific domain name: This indicates the details of this domain name
multiDomains: This indicates the aggregated details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: Details at the account level
CdnData Array of CdnData Data details of a resource

ResourceOriginData

Query an object and its origin-pull details

Referenced by: DescribeOriginData.

Name Type Description
Resource String Resource name, which is classified as follows based on different query conditions:
A specific domain name: This indicates the details of this domain name
multiDomains: This indicates the aggregated details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: Details at the account level
OriginData Array of CdnData Origin-pull data details

SummarizedData

Aggregated values of details; each metric has different aggregation methods based on its characteristics

Referenced by: DescribeCdnData, DescribeIpVisit, DescribeOriginData.

Name Type Description
Name String Aggregation method, which can be:
sum: Aggregated summation
max: Maximum value; in bandwidth mode, the peak bandwidth is calculated based on the aggregated data with 5-minute granularity
avg: Average value
Value Float Aggregated data value

TimestampData

Timestamp and its corresponding value

Referenced by: DescribeCdnData, DescribeIpVisit, DescribeOriginData.

Name Type Description
Time Timestamp Statistical point in time in forward rounding mode
Take the 5-minute granularity as an example: 13:35:00 indicates that the statistical interval is between 13:35:00 and 13:39:59
Value Float Data value

TopData

Data structure of sorted data

Referenced by: ListTopData.

Name Type Description
Resource String Resource name, which is classified as follows based on different query conditions:
A specific domain name: This indicates the details of this domain name
multiDomains: This indicates the aggregated details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: Details at the account level
DetailData Array of TopDetailData Detailed sorting results

TopDetailData

Data structure of sorted data

Referenced by: ListTopData.

Name Type Description
Name String Datatype name
Value Float Data value

UrlRecord

Details of the blocked URLs

Referenced by: GetDisableRecords.

Name Type Description
Status String Status (disable: blocked; enable: unblocked)
Note: This field may return null, indicating that no valid values can be obtained.
RealUrl String Corresponding URL
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Creation time
Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime String Update time
Note: This field may return null, indicating that no valid values can be obtained.