查询直播域名
功能介绍
查询直播域名
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/domain
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
否 |
String |
直播域名,如果不设置此字段,则返回租户所有的域名信息 |
enterprise_project_id |
否 |
String |
企业项目ID,如果不设置此字段,则不进行该字段过滤,返回所有域名信息 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必填,携带项目ID信息。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Number |
查询结果的总数量 |
domain_info |
Array of DecoupledLiveDomainInfo objects |
直播域名列表 |
参数 |
参数类型 |
描述 |
---|---|---|
domain |
String |
直播域名 |
domain_type |
String |
域名类型 |
vendor |
String |
CDN厂商 |
region |
String |
直播源站所属区域 |
domain_cname |
String |
直播域名的CNAME |
status |
String |
直播域名的状态 |
related_domain |
String |
播放域名关联的推流域名(只有domain_type为pull的时候有效) |
create_time |
String |
域名创建时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间 |
status_describe |
String |
状态描述 |
service_area |
String |
域名加速区域
|
enterprise_project_id |
String |
企业项目ID |
is_ipv6 |
Boolean |
IPV6开关是否开启,默认关闭,true为开启;false或空为关闭 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询直播域名。
GET https://{endpoint}/v1/{project_id}/domain
响应示例
状态码: 200
直播域名查询成功
{ "total" : 2, "domain_info" : [ { "domain" : "play.example.huawei.com", "domain_type" : "pull", "vendor" : "uCDN", "domain_cname" : "play.example.huawei.com.c.cdnhwc3.com", "region" : "region1", "status" : "on", "related_domain" : "publish.example.huawei.com", "create_time" : "2020-01-19T02:57:00Z" }, { "domain" : "publish.example.huawei.com", "domain_type" : "push", "vendor" : "uCDN", "domain_cname" : "publish.example.huawei.com.c.cdnhwc3.com", "region" : "region1", "status" : "on", "related_domain" : "", "create_time" : "2020-01-19T02:58:00Z" } ] }
状态码: 404
直播域名查询失败
{ "error_code" : "LIVE.103011019", "error_msg" : "Request Illegal" }
SDK代码示例
SDK代码示例如下。
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 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; public class ShowDomainSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); ShowDomainRequest request = new ShowDomainRequest(); try { ShowDomainResponse response = client.showDomain(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 BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowDomainRequest() response = client.show_domain(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 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowDomainRequest{} response, err := client.ShowDomain(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
直播域名查询成功 |
404 |
直播域名查询失败 |
错误码
请参见错误码。