Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Querying Domain Names
Updated on 2026-04-22 GMT+08:00
View PDF

Querying Domain Names

Function

This API is used to query domain names.

Calling Method

For details, see Calling APIs.

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

Status Codes

Status Code

Description

200

Query succeeded.

404

Query failed.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management