Updated on 2025-10-22 GMT+08:00

Obtaining the Domain Name List

Function

Obtain the domain name list.

URI

GET /v1/{project_id}/cae/domains

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

items

Array of DomainItem objects

Domain name list.

kind

String

API type. Fixed value: Domain.

Table 4 DomainItem

Parameter

Type

Description

metadata

MetaDomain object

Response data.

Table 5 MetaDomain

Parameter

Type

Description

id

String

Domain name ID.

name

String

Domain name.

created_at

String

Creation time.

Example Requests

Obtain the domain name list.

GET https://{endpoint}/v1/{project_id}/cae/domains

Example Responses

Status code: 200

OK

{
  "api_version" : "v1",
  "kind" : "Domain",
  "items" : [ {
    "metadata" : {
      "id" : "4475ba56-7669-4af8-8707-c9b1368c3f9c",
      "name" : "example.cn",
      "created_at" : "2022-12-30T08:33:35.140718Z"
    }
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.