Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Querying a Domain Name
Updated on 2025-11-06 GMT+08:00
View PDF

Querying a Domain Name

Function

This API is used to query a domain name.

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

Domain name. If this parameter is not specified, all domain names under your account are returned.

enterprise_project_id

No

String

Enterprise project ID. If this parameter is not specified, information about all domain names is returned.

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

Total number of records in the query result.

domain_info

Array of DecoupledLiveDomainInfo objects

Domain name list.
Table 5 DecoupledLiveDomainInfo

Parameter

Type

Description

domain

String

Domain name.

domain_type

String

Domain name type.

vendor

String

CDN vendor.

region

String

Region where the origin server is

domain_cname

String

CNAME record of the domain name.

status

String

Status of the domain name.

related_domain

String

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

create_time

String

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

status_describe

String

Status description.

service_area

String

Domain name acceleration area.

  • mainland_china: Chinese mainland

  • outside_mainland_china: Outside the Chinese mainland

  • global: Global acceleration

enterprise_project_id

String

Enterprise project ID

is_ipv6

Boolean

Specifies whether to enable the IPv6 function. true indicates that IPv6 is enabled, and false indicates that IPv6 is disabled or the value is empty. The default value is false.

pull_protocol

String

Stream pull protocol supported by the domain name. This parameter is valid only when domain_type is set to pull.

  • 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