Help Center/ CodeArts Artifact/ API Reference/ API/ User Management/ Querying the Tenant IP Address Whitelist
Updated on 2025-09-08 GMT+08:00

Querying the Tenant IP Address Whitelist

Function

Query the tenant IP address whitelist.

Calling Method

For details, see Calling APIs.

URI

GET /cloudartifact/v5/domain/ipconfig

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

page_no

No

Integer

Definition:

Number of pages in a pagination query.

Constraints:

N/A

Value range:

1–2,147,483,647

Default value:

1

page_size

No

Integer

Definition:

Number of records on each page during the pagination query.

Constraints:

N/A

Value range:

1–100

Default value:

10

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition:

Request status.

Value range:

success: The request is successful.

error: The request fails.

trace_id

String

Definition:

Request ID, which uniquely identifies the current request.

Value range:

A string of digits and hyphens (-).

result

DomainIPWhiteListModelPage object

Definition:

Tenant IP address whitelist.

Value range:

N/A

Table 3 DomainIPWhiteListModelPage

Parameter

Type

Description

total_records

Integer

Definition:

Total number of records.

Value range:

N/A

total_pages

Integer

Definition:

Total number of pages.

Value range:

N/A

data

Array of DomainIPWhiteListModel objects

Definition:

Tenant IP address whitelist.

Value range:

N/A

Table 4 DomainIPWhiteListModel

Parameter

Type

Description

id

Long

Definition:

ID.

Value range:

N/A

domain_id

String

Definition:

Tenant ID.

Value range:

N/A

region

String

Definition:

Region.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

value

String

Definition:

IP address.

Value range:

N/A

created

Long

Definition:

Creation time.

Value range:

N/A

updated

Long

Definition:

Update time.

Value range:

N/A

Example Requests

Query the tenant IP address whitelist.

https://{URL}/cloudartifact/v5/domain/ipconfig

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "cda93470aed84c24b7a7ad9f268b8c85",
  "result" : {
    "data" : [ ],
    "total_records" : 0,
    "total_pages" : 0
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.