Querying the Domain List (V2)

Function

This API is used to query the domain list (V2).

Calling Method

For details, see Calling APIs.

URI

GET /v2/domain/domain

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: The value must contain 32 characters. Digits and letters are allowed. Value range: N/A Default value: N/A
flag	Yes	Integer	Definition: Whether the domain is configured for a project. Constraints: N/A Value range: 0 (Not configured) 1 (Configured) Default value: N/A
offset	No	Integer	Definition: Pagination index. The offset is an integer multiple of limit. For example, if the value of offset is 0, the return starts from the first record. If the value of offset is 10, the return starts from the eleventh record. Constraints: N/A Value range: Minimum value: 0. Maximum value: 10,000. Default value: Default value: 0.
limit	No	Integer	Definition: Number of records displayed on each page. Constraints: N/A Value range: Minimum length: 1 character. Maximum length: 10 characters. Default value: 10
page_no	No	Integer	Definition: Page index. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
page_size	No	Integer	Definition: Page size. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition : User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory. Value range: Minimum length: 10 characters. Maximum length: 32,768 characters. Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	String	Response to a successful request for setting a domain.
result	result object	Definition: Returned result.
status	String	Definition: Returned status. Constraints: success: The API is successfully called. error: The API call failed.

**Table 4** result
Parameter	Type	Description
domains	Array of domains objects	Definition: Domains. Value range: N/A
total_count	Integer	Definition: Number of domains. Value range: N/A

**Table 5** domains
Parameter	Type	Description
id	Integer	Definition: Domain ID. Value range: N/A
name	String	Definition: Domain name. Value range: N/A
flag	Integer	Definition: Whether the domain is configured for the project. Value range: 0 (not configured for the project) 1 (configured for the project)
project_id	Integer	Definition: Digital ID of a project. Value range: N/A
domain_id	Integer	Definition: Digital ID of a domain. Value range: N/A
project_uuid	String	Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the API for querying the project list (ListProjectsV4.xml). Value range: N/A
default_d	Integer	Definition: Default value of whether the domain is configured for the project. Value range: 1

Example Requests

{endpoint}/v2/domain/domain?project_id=5192de5eb435430c8cd41c6ae6028848&page_no=1&page_size=10&flag=1&_=1753181122622

Example Responses

Status code: 200

Response to a successful request for querying the domain list.

{
  "result": {
    "domains": [
      {
        "id": 14,
        "name": "Performance",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 14,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 15,
        "name": "Function",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 15,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 16,
        "name": "Reliability",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 16,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 17,
        "name": "Network safety",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 17,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 18,
        "name": "Maintainability",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 18,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 19,
        "name": "Other DFX",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 19,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 20,
        "name": "Availability",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 20,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 1
      },
      {
        "id": 56599,
        "name": "111",
        "flag": 1,
        "project_id": 35138974,
        "domain_id": 56599,
        "project_uuid": "5192de5eb435430c8cd41c6ae6028848",
        "default_d": 0,
      }
    ],
    "total_count": 8
  },
  "status": "success"
}