Help Center/ CodeArts Req/ API Reference/ APIs/ Domain of the Scrum Project/ Querying the Domain List of a Project
Updated on 2023-06-12 GMT+08:00

Querying the Domain List of a Project

Function

Querying the Domain List of a Project

URI

GET /v4/projects/{project_id}/domains

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the 32-bit ID of the devcloud project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset.

Default: 0

limit

No

Integer

Data returned at a time. The value ranges from 1 to 100.

Minimum: 1

Maximum: 100

Default: 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total Domains

domains

Array of CreateProjectDomainResponseBody objects

Domain List

Table 5 CreateProjectDomainResponseBody

Parameter

Type

Description

domain_name

String

Domain Name

domain_id

String

Identifies a domain.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Description

error_code

String

Error Codes

Example Requests

Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/domains

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "domains" : [ {
    "domain_name" : "demo",
    "domain_id" : "123cefde62004de2b62b5e8dd2c2b3af"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.