Querying a Domain Name
Function
This API is used to query details about a domain name.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/cdn/configuration/domains/{domain_name}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_name |
Yes |
String |
Domain name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project to which the resource belongs. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. 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). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
domain |
DomainsDetail object |
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 SourcesDomainConfig objects |
Origin server settings. |
https_status |
Integer |
Whether HTTPS is enabled for acceleration. 0: HTTPS is disabled. 1: HTTPS is enabled and the origin protocol is same as the user request. 2: HTTPS is enabled and the origin protocol is HTTP. 3: HTTPS is enabled and the origin protocol is HTTPS. |
create_time |
Long |
Time when the domain name was created. The value is the number of milliseconds since the UNIX epoch (Jan 1, 1970). |
update_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). |
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). |
Parameter |
Type |
Description |
---|---|---|
origin_type |
String |
Origin server type.
|
origin_addr |
String |
IP address or domain name of the origin server. |
priority |
Integer |
Origin server priority. Possible values: 70 (primary) and 30 (standby). |
obs_web_hosting_status |
String |
Whether static website hosting is enabled for the OBS bucket. This parameter is mandatory when the origin server type is obs_bucket. Possible values: off (disabled) and on (enabled). |
http_port |
Integer |
HTTP port. Default value: 80. The port number ranges from 1 to 65535. |
https_port |
Integer |
HTTPS port. Default value: 443. The port number ranges from 1 to 65535. |
host_name |
String |
Host header. The default value is the acceleration domain name. |
obs_bucket_type |
String |
OBS bucket type.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error |
ErrMsg object |
Error code and error message. |
Example Requests
GET https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/www.example.com?enterprise_project_id=1
Example Responses
Status code: 200
Success response.
{ "domain" : { "sources" : [ { "origin_type" : "domain", "origin_addr" : "www.example.com", "priority" : 70, "obs_web_hosting_status" : "string", "http_port" : 80, "https_port" : 443, "host_name" : "string" } ], "cname" : "www.example.com.c.example2.com", "id" : "12a***********************345d671", "domain_name" : "www.example.com", "business_type" : "web", "service_area" : "mainland_china", "domain_status" : "online", "https_status" : 0, "create_time" : 1516861994806, "update_time" : 1532405346365, "disabled" : 0 } }
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 46 |
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 ShowDomainDetailByNameSolution { 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(); ShowDomainDetailByNameRequest request = new ShowDomainDetailByNameRequest(); request.withDomainName("{domain_name}"); try { ShowDomainDetailByNameResponse response = client.showDomainDetailByName(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 31 |
# 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 = ShowDomainDetailByNameRequest() request.domain_name = "{domain_name}" response = client.show_domain_detail_by_name(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 36 |
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.ShowDomainDetailByNameRequest{} request.DomainName = "{domain_name}" response, err := client.ShowDomainDetailByName(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