List domains.
Try it now
Test
RAM authorization
Request syntax
POST /v2/domain/list HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request parameters. |
|
| parent_domain_id |
string |
No |
The ID of the parent domain. |
bj1 |
| marker |
string |
No |
The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| limit |
integer |
No |
The maximum number of results to return. Valid values: 1 to 100. Default value: 50. |
60 |
| service_code |
string |
No |
Service code. Default is pds.
Valid values:
|
pds |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned domains. |
||
| items |
array |
The information about the domains. |
|
| Domain |
The information about a domain. |
||
| next_marker |
string |
A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists. |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
Examples
Success response
JSON format
{
"items": [
{
"parent_domain_id": "bj1",
"domain_id": "bj2",
"domain_name": "pdsdomain",
"description": "my domain",
"init_drive_enable": true,
"init_drive_size": 1073741824,
"updated_at": "2019-08-20T06:51:27.292Z",
"created_at": "2019-08-20T06:51:27.292Z",
"size_quota": 1099511627776,
"size_quota_used": 1099511627776,
"user_count_quota": 50,
"status": 1,
"used_size": 1099511627776,
"published_app_access_strategy": {
"effect": "deny",
"except_app_id_list": [
"8ovxCTRUDdbpVWBP"
]
},
"sharable": false,
"data_hash_name": "sha1",
"store_redundancy_type": "LRS"
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.