Updated on 2026-04-22 GMT+08:00

Querying Domain Names

Function

This API is used to query domain names.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    live:domain:getDomains

    Read

    -

    -

    -

    -

URI

GET /v1/{project_id}/domain

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

domain

No

String

Definition

Domain name. If this parameter is not specified, the system will return all domain names of the tenant.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID. If this parameter is not specified, the system will return the information about all domain names.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. The token 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.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Number

Definition

Total number of query results.

Range

N/A

domain_info

Array of DecoupledLiveDomainInfo objects

Definition

Domain name list.

Table 5 DecoupledLiveDomainInfo

Parameter

Type

Description

domain

String

Definition

Domain name.

Range

Length: 1 to 255 characters

domain_type

String

Definition

Domain name type.

Range

  • pull: streaming domain name

  • push: ingest domain name

vendor

String

Definition

CDN vendor.

Range

  • ChinaNetCenter

  • KingSoft

  • Tencent

  • uCDN

  • TencentOutside

  • Dnion

  • Baishan

  • Baidu

  • Onething

region

String

Definition

Region where the Live origin server is located.

Range

N/A

domain_cname

String

Definition

CNAME record for the domain name.

Range

N/A

status

String

Definition

Status of the domain name.

Range

  • on: enabled

  • off: disabled

  • configuring: configuring

related_domain

String

Definition

Ingest domain name associated with the streaming domain name. This parameter is valid only when domain_type is set to pull.

Range

Length: 1 to 256 characters

create_time

String

Definition

Time when the domain name was created. The value is a UTC time in the format of yyyy-mm-ddThh:mm:ssZ.

Range

N/A

status_describe

String

Definition

Status description.

Range

N/A

service_area

String

Definition

Acceleration area for the domain name.

Range

  • mainland_china: Chinese mainland

  • outside_mainland_china: outside the Chinese mainland

  • global: global acceleration

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

is_ipv6

Boolean

Definition

Whether IPv6 is enabled. It is disabled by default.

Range

  • true: enabled

  • false: disabled

pull_protocol

String

Definition

Stream pull protocols supported by the domain name.

Range

  • flv_rtmp: FLV and RTMP

  • hls: HLS

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Queries domain names.

GET https://{endpoint}/v1/{project_id}/domain

Example Responses

Status code: 200

Query succeeded.

{
  "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"
  } ]
}

Status code: 404

Query failed.

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "Request Illegal"
}

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
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)
    }
}

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

Query succeeded.

404

Query failed.

Error Codes

See Error Codes.