Listing Domain Names
Function
This API is used to query basic information about an acceleration domain name, including the service area, origin server, tags, and whether the domain name is disabled.
-
A single tenant can call this API 50 times per second.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/cdn/domains
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_name |
No |
String |
Definition Acceleration domain name.
NOTE:
By default, the fuzzy match mode is used.
Constraints You can query only domain names that have been created in CDN. Range 1 to 255 characters. Default Value N/A |
business_type |
No |
String |
Definition Service type of the domain name. Constraints N/A Range
Default Value N/A |
domain_status |
No |
String |
Definition Domain name status. Constraints N/A Range
Default Value N/A |
service_area |
No |
String |
Definition Area covered by the acceleration service. Constraints N/A Range
Default Value N/A |
page_size |
No |
Integer |
Definition Number of domain names on each page. Constraints N/A Range 1 to 10,000. Default Value 30 |
page_number |
No |
Integer |
Definition Page number to be queried. Constraints N/A Range 1 to 65,535. Default Value 1 |
show_tags |
No |
Boolean |
Definition Whether to show tags. Constraints N/A Range
Default Value N/A |
exact_match |
No |
Boolean |
Definition Whether to enable exact match. If this function is disabled, fuzzy match is used. If this function is enabled, only exact match is used. Constraints N/A Range
Default Value false |
enterprise_project_id |
No |
String |
Definition Enterprise project ID. Obtain the enterprise project ID by calling the ListEnterpriseProject API of EPS. Constraints This parameter indicates the ID of the enterprise project to which the resource to be queried belongs. It is valid only when the enterprise project function is enabled. The value all indicates all projects. Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of records. |
domains |
Array of Domains objects |
Domain name details. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Domain name ID. |
domain_name |
String |
Domain name. |
business_type |
String |
Service type of the domain name. Possible values: web (website acceleration), download (file download acceleration), video (on-demand service acceleration), and wholeSite (whole site acceleration). |
domain_status |
String |
Domain name status. Possible values:
|
cname |
String |
CNAME record of the domain name. |
sources |
Array of Sources objects |
Origin server settings. |
domain_origin_host |
DomainOriginHost object |
Host header settings for origin pull. |
https_status |
Integer |
Whether HTTPS is enabled for acceleration. |
create_time |
Long |
Time when the domain name was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970). |
modify_time |
Long |
Time when the domain name was modified. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970). |
disabled |
Integer |
Whether the domain name is banned. Possible values: 0 (not banned) and 1 (banned). |
locked |
Integer |
Whether the domain name is locked. Possible values: 0 (not locked) and 1 (locked). |
auto_refresh_preheat |
Integer |
Whether automatic cache purge and prefetch are enabled. Possible values: 0 (disabled) and 1 (enabled). |
service_area |
String |
Service area of the CDN service. Possible values: mainland_china (Chinese mainland), outside_mainland_china (outside the Chinese mainland), and global (global). |
range_status |
String |
Whether range requests are supported. |
follow_status |
String |
Whether redirect from origin is enabled. |
origin_status |
String |
Origin pull status. Possible values: off (disabled) and on (enabled). |
banned_reason |
String |
Reason for banning the domain name. |
locked_reason |
String |
Reason for locking the domain name. |
enterprise_project_id |
String |
ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. If this parameter is not specified, the default project is used. This parameter is mandatory when you use an IAM user to call this API. Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). |
tags |
Array of EpResourceTag objects |
Tag information. |
Parameter |
Type |
Description |
---|---|---|
domain_id |
String |
Domain name ID. |
ip_or_domain |
String |
Non-intranet IP address or domain name of the origin server. |
origin_type |
String |
Origin server type. Possible values: ipaddr (origin server IP address), domain (origin server domain name), and obs_bucket (OBS bucket domain name). |
obs_bucket_type |
String |
OBS bucket type.
|
active_standby |
Integer |
Whether the origin server is primary or standby. Possible values: 1 (primary) and 0 (standby). |
enable_obs_web_hosting |
Integer |
Whether static website hosting is enabled for the OBS bucket. Possible values: 0 (disabled) and 1 (enabled). This parameter is passed only when origin_type is set to obs_bucket. |
Parameter |
Type |
Description |
---|---|---|
domain_id |
String |
Domain name ID. |
origin_host_type |
String |
Host type. Possible values: accelerate (acceleration domain name) and customize (custom domain name). |
customize_domain |
String |
Domain name of the host. Host for pull from the primary origin server. If the acceleration domain name has multiple primary origin servers and each origin server has a host, CDN pulls content from the host of the first primary origin server in the origin server lists. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
ErrMsg object |
Error code and error message. |
Example Requests
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0
Example Responses
Status code: 200
Success response.
{ "total" : 1, "domains" : [ { "sources" : [ { "origin_type" : "domain", "ip_or_domain" : "www.example.com", "active_standby" : 1 } ], "cname" : "www.example.com.c.test.com", "id" : "ab1234a*********************g56", "domain_name" : "www.example.com", "business_type" : "web", "service_area" : "mainland_china", "domain_status" : "online", "https_status" : 0, "create_time" : 1516861994806, "modify_time" : 1532405346365, "domain_origin_host" : { "domain_id" : "ab1234a*********************g56", "origin_host_type" : "customize", "customize_domain" : "www.example.com" }, "disabled" : 0, "locked" : 0, "range_status" : "off", "follow_status" : "off", "origin_status" : "on", "auto_refresh_preheat" : 0, "tags" : [ { "key" : "string", "value" : "string" } ] } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdn.v2.region.CdnRegion; import com.huaweicloud.sdk.cdn.v2.*; import com.huaweicloud.sdk.cdn.v2.model.*; public class ListDomainsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CdnClient client = CdnClient.newBuilder() .withCredential(auth) .withRegion(CdnRegion.valueOf("<YOUR REGION>")) .build(); ListDomainsRequest request = new ListDomainsRequest(); try { ListDomainsResponse response = client.listDomains(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdn.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CdnClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdnRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDomainsRequest() response = client.list_domains(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cdn.NewCdnClient( cdn.CdnClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDomainsRequest{} response, err := client.ListDomains(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Success response. |
400 |
Error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot