# 查询加速域名详情 - ShowDomainDetailByName #### 功能介绍 查询加速域名详细信息，包含域名ID、服务范围、业务类型和源站等。 - 单租户调用频率：300次/min。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cdn/cdn_02_0019.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cdn/cdn_02_0020.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cdn:configuration:queryDomains | Read | domain \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI GET /v1.0/cdn/configuration/domains/{domain_name} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_name | 是 | String | **参数解释：** 加速域名 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释：** 企业项目id。您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id **约束限制：** 当用户开启企业项目功能时，该参数生效，表示查询资源所属项目，"all"表示所有项目 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户鉴权Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain | [DomainsDetail] object | 域名信息。 | 表5DomainsDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 加速域名ID。 | | domain_name | String | 加速域名。 | | business_type | String | 域名业务类型，若为web，则表示类型为网站加速；若为download，则表示业务类型为文件下载加速；若为video，则表示业务类型为点播加速；若为wholeSite，则表示类型为全站加速。 | | domain_status | String | 加速域名状态。取值意义： - online表示"已开启" - offline表示"已停用" - configuring表示"配置中" - configure_failed表示"配置失败" - checking表示"审核中" - check_failed表示"审核未通过" - deleting表示"删除中"。 | | cname | String | 加速域名对应的CNAME。 | | sources | Array of [SourcesDomainConfig] objects | 源站配置。 | | https_status | Integer | 是否开启HTTPS加速。 0：代表未开启HTTPS加速； 1：代表开启HTTPS加速，且回源方式为协议跟随； 2：代表开启HTTPS加速，且回源方式为HTTP； 3：代表开启HTTPS加速，且回源方式为HTTPS。 | | create_time | Long | 域名创建时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。 | | update_time | Long | 域名修改时间，相对于UTC 1970-01-01到当前时间相隔的毫秒数。 | | disabled | Integer | 封禁状态（0代表未禁用；1代表禁用）。 | | locked | Integer | 锁定状态（0代表未锁定；1代表锁定）。 | | service_area | String | 华为云CDN提供的加速服务范围，包含：mainland_china中国大陆、outside_mainland_china中国大陆境外、global全球。 | 表6SourcesDomainConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | origin_type | String | 源站类型。 - ipaddr：源站IP； - domain：源站域名； - obs_bucket：OBS桶域名； - third_bucket：第三方桶。 | | origin_addr | String | 源站IP或者域名。 | | priority | Integer | 源站优先级，70：主，30：备。 | | obs_web_hosting_status | String | 是否开启OBS静态网站托管，源站类型为obs_bucket时传递，off：关闭，on：开启。 | | http_port | Integer | HTTP端口，默认80,端口取值取值范围1-65535。 | | https_port | Integer | HTTPS端口，默认443,端口取值取值范围1-65535。 | | host_name | String | 回源HOST，默认加速域名。 | | obs_bucket_type | String | OBS桶类型。 - private: 私有桶（除桶ACL授权外的其他用户无桶的访问权限）。 - public: 公有桶（任何用户都可以对桶内对象进行读操作）。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [ErrMsg] object | 用于返回具体的错误码和错误消息 | 表8ErrMsg | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 ``` GET https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/www.example.com?enterprise_project_id=1 ``` #### 响应示例 **状态码：200** 成功响应。 ``` { "domain" : { "sources" : [ { "origin_type" : "domain", "origin_addr" : "www.example.com", "priority" : 70, "http_port" : 80, "https_port" : 443, "host_name" : "www.examplehost.com" } ], "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cdn.CdnClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cdn.NewCdnClient(hcClient) request := &model.ShowDomainDetailByNameRequest{} request.DomainName = "{domain_name}" response, err := client.ShowDomainDetailByName(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CDN/sdk?api=ShowDomainDetailByName&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应。 | | 400 | 错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cdn/ErrorCode.html)。