Update domain information.
Try it now
Test
RAM authorization
Request syntax
POST /v2/domain/update HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request parameters. |
|
| domain_id |
string |
Yes |
The domain ID. |
bj1 |
| domain_name |
string |
No |
The name of the domain. |
你好企业网盘 |
| description |
string |
No |
The description of the domain. |
你好企业网盘调试环境 |
| init_drive_enable |
boolean |
No |
Specifies whether to enable the default drive feature. A value of true specifies that all users are assigned a drive by default on the first logon. Default value: false. |
true |
| init_drive_size |
integer |
No |
The size of the default drive. Unit: bytes. You must specify init_drive_size if you set init_drive_enable to true. Default value: 0. A value of 0 specifies that the size of the default drive is 0 bytes and you cannot upload files to the drive. To initialize the default drive, set init_drive_size to 0. A value of -1 specifies that the size is unlimited. |
1073741824 |
| user_count_quota |
integer |
No |
The maximum number of users that can be created in the domain. |
50 |
| size_quota |
integer |
No |
The total storage quota for all drives in the domain. A value of 0 specifies that the quota is unlimited. |
1099511627776 |
| published_app_access_strategy | AppAccessStrategy |
No |
The access policy of the application. |
Response elements
|
Element |
Type |
Description |
Example |
| Domain |
The information about the updated domain. |
Examples
Success response
JSON format
{
"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"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.