Data Types

Last updated: 2020-01-13 16:31:22

CacheOptResult

Result of blocking/unblocking URLs

Used by actions: DisableCaches、EnableCaches.

Name Type Description
SuccessUrls Array of String List of succeeded 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

Used by actions: DescribeCdnData、DescribeIpVisit、DescribeOriginData.

Name Type Description
Metric String Queries the specified metric:
flux: traffic (in bytes)
bandwidth: bandwidth (in bps)
request: number of requests
fluxHitRate: traffic hit rate (in %)
statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries)
2XX: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries)
3XX: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries)
4XX: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries)
5XX: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries)
Alternatively, you can specify a status code for querying.
DetailData Array of TimestampData Detailed data combination
SummarizedData SummarizedData Aggregate data combination

CdnIp

CdnIp attribute details

Used by actions: DescribeCdnIp.

Name Type Description
Ip String IP of the node.
Platform String Whether the IP is a Tencent Cloud CDN cache node. yes: it is a Tencent Cloud CDN cache node; no: it is not.
Location String District/country where the node is located. unknown: the node location is unknown.
History Array of CdnIpHistory Activation and deactivation history of the node.
Area String Service region of the node. mainland: Mainland China; overseas: outside Mainland China; unknown: unknown

CdnIpHistory

Activation and deactivation history of a CDN IP node.

Used by actions: DescribeCdnIp.

Name Type Description
Status String Node status. online: activated; offline: deactivated
Datetime Timestamp Operation time. If its value is null, it means there is no status change record.
Note: This field may return null, indicating that no valid values can be obtained.

DomainLog

Details about a log package download link

Used by actions: DescribeCdnDomainLogs.

Name Type Description
StartTime Timestamp Starting time of the log package
EndTime Timestamp End time of the log package
LogPath String Log package download link
Area String Acceleration region corresponding to the log package
mainland: within Mainland China
overseas: outside Mainland China
LogName String Log package filename

MapInfo

Mapping between a name and an ID

Used by actions: DescribeMapInfo.

Name Type Description
Id Integer Object ID
Name String Object name

PurgeTask

Purge task details.

Used by actions: DescribePurgeTasks.

Name Type Description
TaskId String Purge task ID
Url String Purged URL
Status String Purge task status
fail: purge failed
done: purge succeeded
process: purge in progress
PurgeType String Purge type
url: URL purge
path: directory purge
FlushType String Purge method
flush: purges updated resources; this type is available only for directory purges
delete: purges all resources
CreateTime Timestamp Purge task submission time

PushTask

Prefetch task details.

Used by actions: DescribePushTasks.

Name Type Description
TaskId String Prefetch task ID
Url String Prefetched URL
Status String Prefetch task status
fail: prefetch failed
done: prefetch succeeded
process: prefetch in progress
Percent Integer Prefetch progress in percentage
CreateTime Timestamp Prefetch task submission time
Area String Prefetch region
mainland: within Mainland China
overseas: outside Mainland China
global: global

RegionMapRelation

Association between a region ID and sub-region IDs.

Used by actions: DescribeMapInfo.

Name Type Description
RegionId Integer Region ID
SubRegionIdList Array of Integer List of sub-region IDs

ResourceData

This API is used to query an object and its access details

Used by actions: DescribeCdnData、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 aggregate details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: This indicates the details at the account level
CdnData Array of CdnData Data details of a resource

ResourceOriginData

This API is used to query an object and its origin-pull details

Used by actions: 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 aggregate details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: This indicates the details at the account level
OriginData Array of CdnData Origin-pull data details

SummarizedData

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

Used by actions: DescribeCdnData、DescribeIpVisit、DescribeOriginData.

Name Type Description
Name String Aggregation method, which can be:
sum: aggregate summation
max: maximum value; in bandwidth mode, the peak bandwidth is calculated based on the aggregate data with 5-minute granularity.
avg: average value
Value Float Aggregate data value

TimestampData

Timestamp and its corresponding value

Used by actions: DescribeCdnData、DescribeIpVisit、DescribeOriginData.

Name Type Description
Time Timestamp Statistical point in time in forward rounding mode
Taking 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

Used by actions: 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 aggregate details of multiple domain names
Project ID: This displays the ID of the specifically queried project
all: This indicates the details at the account level
DetailData Array of TopDetailData Detailed sorting results

TopDetailData

Data structure of sorted data

Used by actions: ListTopData.

Name Type Description
Name String Datatype name
Value Float Data value

UrlRecord

Details of the blocked URLs

Used by actions: 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.