Updated on 2026-09-02 GMT+08:00

CLI Command Reference

Statistical Analysis

API Name

Command

Description

Operation

Querying Domain Name Statistics by Region and Carrier

hcloud CDN ShowDomainLocationStats/v2

This API is used to query the summary or detailed statistics of a domain name. You can query statistics by domain name, country/region, province, and carrier. You can query metrics such as the bandwidth, traffic, request count, and HTTP status codes of a domain name.

Go debug

Querying Domain Name Statistics

hcloud CDN ShowDomainStats/v2

This API is used to query the summary and detailed data of domain metrics such as traffic, bandwidth, number of requests, and HTTP status codes.

Go debug

Querying Top 100 URLs

hcloud CDN ShowTopUrl/v2

This API is used to query statistics for the top 100 URLs, including the breakdowns of traffic and request count metrics.

Go debug

Querying Details About Top 100 Referers

hcloud CDN ListCdnDomainTopRefers/v2

This API is used to query statistics for the top 100 referers, including the breakdowns of traffic and request count metrics.

Go debug

Downloading a Statistical Metric Table

hcloud CDN DownloadStatisticsExcel/v2

- This API is used to download a statistical metric table.

Go debug

Querying Top Domain Names

hcloud CDN ShowTopDomainNames/v2

- This API is used to query top domain names.

Go debug

Querying Peak Bandwidth Data of a Domain Name

hcloud CDN ShowBandwidthCalc/v2

- This API is used to query peak bandwidth data of a domain name.

Go debug

Downloading a Table of Statistics by Region and Carrier

hcloud CDN DownloadRegionCarrierExcel/v2

- This API is used to download a table of statistics by region and carrier.

Go debug

Billing Management

API Name

Command

Description

Operation

Querying the Billing Option

hcloud CDN ShowChargeModes/v2

This API is used to query the billing option.

Go debug

Configuring the Billing Option

hcloud CDN SetChargeModes/v2

This API is used to configure the billing option.

Go debug

Analytics

API Name

Command

Description

Operation

Querying Analytics Configurations

hcloud CDN ShowStatsConfigs/v2

This API is used to query popular content statistics and Cloud Eye reporting configurations.

Go debug

Setting an Analytics Configuration

hcloud CDN SetStatsConfig/v2

This API is used to set an Analytics configuration.

Go debug

Querying Daily Client Access Details by Domain Name

hcloud CDN ListDomainClientStats/v2

This API is used to query daily client access details by domain name.

Go debug

Querying Top Origin URLs of a Domain Name

hcloud CDN ListCdnDomainTopOriginUrl/v2

This API is used to query statistics for the top origin URLs, including the breakdowns of traffic and request count metrics.

Go debug

Querying Top IP Address Statistics of a Domain Name

hcloud CDN ListCdnDomainTopIps/v2

This API is used to query statistics for the top IP addresses, including the breakdowns of traffic and request count metrics.

Go debug

Querying Top User Agent Statistics of a Domain Name

hcloud CDN ListCdnDomainTopUas/v2

This API is used to query statistics for the top user agents, including the breakdowns of traffic and request count metrics.

Go debug

Querying Operations Report Subscription Tasks by Page

hcloud CDN ListSubscriptionTasks/v2

This API is used to query operations report subscription tasks by page.

Go debug

Creating an Operations Report Subscription Task

hcloud CDN CreateSubscriptionTask/v2

This API is used to create an operations report subscription task.

Go debug

Modifying an Operations Report Subscription Task

hcloud CDN UpdateSubscriptionTask/v2

This API is used to modify an operations report subscription task.

Go debug

Deleting an Operations Report Subscription Task

hcloud CDN DeleteSubscriptionTask/v2

This API is used to delete an operations report subscription task.

Go debug

Querying Asynchronous Statistics Export Tasks

hcloud CDN ListExportTasks/v2

This API is used to query asynchronous statistics export tasks by page.

Go debug

Creating an Asynchronous Statistics Export Task

hcloud CDN CreateExportTask/v2

This API is used to create an asynchronous statistics export task. CDR data and top URL statistics can be exported.

Go debug

Querying Special Configurations of a Tenant

hcloud CDN ShowSpecialUser/v2

This API is used to query the special CDN configurations of a tenant.

Go debug

Exporting CDN Data

hcloud CDN ExportStatsOpen/v2

This API is used to export CDN data.

Go debug

Querying the Access Details of Top 100 Paths

hcloud CDN ListCdnDomainTopPath/v2

This API is used to query the access details of the top 100 paths.

Go debug

Querying Domain Name Statistics by Country

hcloud CDN ShowDomainCountryStat/v2

This API is used to query domain name statistics by country.

Go debug

Domain Name Configuration

API Name

Command

Description

Operation

Querying IP Address Information

hcloud CDN ShowIpInfo/v2

This API is used to query IP address information.

Go debug

Modifying the Status of Private Bucket Retrieval

hcloud CDN UpdatePrivateBucketAccess/v2

This API is used to modify the status of private bucket retrieval.

Go debug

Associating a Certificate with Multiple Domain Names

hcloud CDN UpdateDomainMultiCertificates/v2

If you associate a certificate with multiple domain names, you need to enable force HTTP settings for the domain names.

Go debug

Querying All Domain Names Associated with HTTPS Certificates

hcloud CDN ShowCertificatesHttpsInfo/v2

Querying All Domain Names Associated with HTTPS Certificates

Go debug

Listing Resource Tags

hcloud CDN ShowTags/v2

This API is used to list resource tags.

Go debug

Creating a Resource Tag

hcloud CDN CreateTags/v2

This API is used to create a recourse tag.

Go debug

Deleting a Resource Tag

hcloud CDN BatchDeleteTags/v2

This API is used to delete a resource tag.

Go debug

Copying Domain Configuration

hcloud CDN BatchCopyDomain/v2

"This API is used to copy the configuration of a domain name to other domain names."

Go debug

Modifying the Full Domain Configuration

hcloud CDN UpdateDomainFullConfig/v2

This API is used to modify the domain name configuration. You can modify the service type, service area, remarks, IPv6, origin protocol, origin URL rewriting, advanced origin, range request, redirect from origin, ETag verification, origin response timeout, origin request header, HTTPS, TLS version, force redirect, HSTS, HTTP/2, OCSP stapling, QUIC, cache rule, status code cache TTL, referer validation, IP ACL, User-Agent ACL, token authentication, remote authentication, IP access frequency, HTTP header, custom error page, smart compression, request rate limiting, WebSocket, video seek, origin SNI, access URL rewriting, browser cache TTL, geo-blocking settings, client certificate, and TLS version and cipher suite settings.

Go debug

Querying Domain Name Configuration

hcloud CDN ShowDomainFullConfig/v2

This API is used to query the domain name configuration. You can query the service type, service area, remarks, IPv6, origin protocol, origin URL rewriting, advanced origin, range request, redirect from origin, ETag verification, origin response timeout, origin request header, HTTPS, TLS version, force redirect, HSTS, HTTP/2, OCSP stapling, QUIC, cache rule, status code cache TTL, referer validation, IP ACL, User-Agent ACL, token authentication, remote authentication, IP access frequency, HTTP header, custom error page, smart compression, request rate limiting, WebSocket, video seek, origin SNI, access URL rewriting, browser cache TTL, geo-blocking settings, client certificate, and TLS version and cipher suite settings.

Go debug

Creating a Shared Cache Group

hcloud CDN CreateShareCacheGroups/v2

This API is used to configure a shared cache group with a primary domain name to share its cache with other domain names. This improves the cache hit ratio.

Go debug

Listing Shared Cache Groups

hcloud CDN ListShareCacheGroups/v2

This API is used to list shared cache groups.

Go debug

Updating a Shared Cache Group

hcloud CDN UpdateShareCacheGroups/v2

This API is used to update a shared cache group.

Go debug

Deleting a Shared Cache Group

hcloud CDN DeleteShareCacheGroups/v2

This API is used to delete a shared cache group.

Go debug

Creating a Rule in the Rules Engine

hcloud CDN CreateRuleNew/v2

The rules engine allows you to configure rules in graphical mode, which is more flexible and fine-grained. By restricting trigger conditions, you can control the resource range for the configuration to take effect, meeting requirements in various scenarios.

Go debug

Listing Rules in the Rules Engine

hcloud CDN ListRuleDetails/v2

This API is used to list rules in the rules engine.

Go debug

Updating a Rule in the Rules Engine

hcloud CDN UpdateRuleNew/v2

This API is used to update a rule in the rules engine.

Go debug

Deleting a Rule from the Rules Engine

hcloud CDN DeleteRuleNew/v2

This API is used to delete a rule from the rules engine.

Go debug

Updating All Rules in the Rules Engine

hcloud CDN UpdateFullRule/v2

This API is used to update all rules in the rules engine.

Go debug

Updating the Status and Priority of Rules

hcloud CDN BatchUpdateRuleStatus/v2

This API is used to update the status and priority of rules in batches.

Go debug

Domain Name Operations

API Name

Command

Description

Operation

Querying Basic Information About a Domain Name

hcloud CDN ListDomainConfigs/v2

This API is used to query basic information about a domain name, including the CNAME resolution status and whether the domain supports configuration replication.

Go debug

Querying Special Configurations of a Domain Name

hcloud CDN ListSpecialConfiguration/v2

This API is used to query special configurations of a domain name. Currently, memo information can be queried.

Go debug

Copying Domain Configurations to New Domains

hcloud CDN CreateDomainByDuplicate/v2

This API is used to copy the configuration of an existing domain name to a new domain name.

Go debug

Creating a Domain Name

hcloud CDN CreateDomain/v2

This API is used to create a domain name.

Go debug

Querying Domain Names

hcloud CDN ListDomains/v2

This API is used to query domain names.

Go debug

Deleting a Domain Name

hcloud CDN DeleteDomain/v2

This API is used to delete an accelerated domain name.

Go debug

Enabling CDN for a Domain Name

hcloud CDN EnableDomain/v2

This API is used to enable CDN for a domain name.

Go debug

Disabling CDN for a Domain Name

hcloud CDN DisableDomain/v2

This API is used to disable CDN for a domain name.

Go debug

Querying a Domain Name

hcloud CDN ShowDomainDetailByName/v2

This API is used to query details about a domain name.

Go debug

Verifying the Domain Name Ownership

hcloud CDN VerifyDomainOwner/v2

This API is used to verify the ownership of a domain name.

Go debug

Querying the Ownership Verification Information of a Domain Name

hcloud CDN ShowVerifyDomainOwnerInfo/v2

This API is used to query the ownership verification information of a domain name.

Go debug

Quotas

API Name

Command

Description

Operation

Querying Quotas

hcloud CDN ShowQuota/v2

This API is used to query the quotas for your account, including the quotas of domain names, files and directories to be refreshed, and files to be preheated.

Go debug

Tenant Configuration

API Name

Command

Description

Operation

Modifying the Tenant Configuration

hcloud CDN ModifyAccountInfo/v2

This API is used to modify the tenant configuration. Currently, it allows you to enable OBS and SCM authorization.

Go debug

Template Configuration

API Name

Command

Description

Operation

Creating a Domain Name Template

hcloud CDN CreateDomainTemplate/v2

Creating a Domain Name Template.

Go debug

Listing Domain Name Templates

hcloud CDN ShowDomainTemplate/v2

Listing Domain Name Templates.

Go debug

Modifying a Domain Name Template

hcloud CDN UpdateDomainTemplate/v2

Modifying a Domain Name Template.

Go debug

Deleting a Domain Name Template

hcloud CDN DeleteDomainTemplate/v2

Deleting a Domain Name Template.

Go debug

Applying a Domain Name Template

hcloud CDN ApplyDomainTemplate/v2

Applying a Domain Name Template.

Go debug

Querying Application Records of a Domain Name Template

hcloud CDN ShowAppliedTemplateRecord/v2

Querying Application Records of a Domain Name Template.

Go debug

Cache Refreshing and Preheating

API Name

Command

Description

Operation

Creating a Cache Refreshing Task

hcloud CDN CreateRefreshTasks/v2

This API is used to create a cache refreshing task.

Go debug

Creating a Cache Preheating Task

hcloud CDN CreatePreheatingTasks/v2

This API is used to create a cache preheating task.

Go debug

Querying Cache Refreshing and Preheating Tasks

hcloud CDN ShowHistoryTasks/v2

This API is used to query cache refreshing and preheating tasks.

Go debug

Querying a Cache Refreshing or Preheating Task

hcloud CDN ShowHistoryTaskDetails/v2

This API is used to query a cache refreshing or preheating task.

Go debug

Querying Cache Refreshing and Preheating Records

hcloud CDN ShowUrlTaskInfo/v2

This API is used to query cache refreshing and preheating records. To use this API, submit a service ticket.

Go debug

Cache Purge and Prefetch

API Name

Command

Description

Operation

Creating a URL Blocking or Unblocking Task

hcloud CDN CreateAccessControlTask/v2

This API is used to create a URL blocking or unblocking task. To use this API, submit a service ticket.

Go debug

Querying URL Blocking or Unblocking Tasks

hcloud CDN ListAccessControlTask/v2

This API is used to query URL blocking or unblocking tasks. To use this API, submit a service ticket.

Go debug

Querying Blocked URLs

hcloud CDN ListBanUrl/v2

This API is used to query blocked URLs. To use this API, submit a service ticket.

Go debug

Log Management

API Name

Command

Description

Operation

Querying Logs

hcloud CDN ShowLogs/v2

This API is used to query the log download link.

Go debug