Update domain information.
Try it now
Test
RAM authorization
Request syntax
POST /v2/domain/update HTTP/1.1Request 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. |
Hello Enterprise Drive |
| description |
string |
No |
The description of the domain. |
Hello Enterprise Drive staging environment |
| 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": "",
"domain_id": "",
"domain_name": "",
"description": "",
"init_drive_enable": true,
"init_drive_size": 0,
"updated_at": "",
"created_at": "",
"size_quota": 0,
"size_quota_used": 0,
"user_count_quota": 0,
"status": 0,
"used_size": 0,
"published_app_access_strategy": {
"effect": "",
"except_app_id_list": [
""
]
},
"watermark_config": {
"enable_doc_preview": true,
"display_access_user_name": true,
"display_shareLink_creator_name": true,
"display_custom_text": ""
},
"auth_config": {
"key": {
"enable": true,
"app_id": "",
"app_secret": "",
"endpoint": "",
"enterprise_id": "",
"white_list_enable": true,
"ldap_config": {
"version": "",
"host": "",
"port": 0,
"uid": "",
"admin_dn": "",
"global_uid": "",
"admin_password": "",
"base_dn": "",
"display_name_key": "",
"type": "",
"sync_config": {
"enabled": true,
"group_object_class": "",
"group_filter": "",
"user_object_class": "",
"user_filter": "",
"cron": ""
}
},
"ding_sync_config": {
"enabled": true,
"cron": "",
"sync_mobile_enabled": true,
"sync_email_enabled": true
},
"we_chat_sync_config": {
"enabled": true,
"tag_id": "",
"cron": ""
},
"lark_sync_config": {
"enabled": true,
"cron": "",
"sync_mobile_enabled": true,
"sync_email_enabled": true
}
}
},
"sharable": true,
"ali_owner_id": "",
"archive_files_config": {
"enabled": true,
"version": ""
},
"uncompress_config": {
"enabled": true,
"version": ""
},
"multi_revision_config": {
"revision_merge_enabled": true,
"revision_count": 0,
"revision_recycle_period": 0
},
"app_config": {
"same_name_file_upload_mode": "",
"web_client_download_mode": "",
"single_file_upload_size_limit": 0,
"allow_upload_file_category_list": [
""
],
"allow_upload_custom_file_ext_list": [
""
]
},
"recycle_bin_config": {
"auto_delete_enabled": true,
"auto_delete_keep_second": 0,
"delete_trash_normal_file_disabled": true
},
"office_preview_config": {
"enabled": true
},
"office_edit_config": {
"enabled": true
},
"share_link_detail": {
"enable_office_editable": true
},
"endpoints": {
"api_endpoint": "",
"api_vpc_endpoint": "",
"app_endpoint": "",
"auth_endpoint": "",
"mgmt_endpoint": "",
"web_office_endpoint_list": "",
"store_list": [
{
"store_id": "",
"type": "",
"bucket": "",
"base_path": "",
"role_arn": "",
"ownership": "",
"location": "",
"public_endpoint": "",
"vpc_endpoint": "",
"acc_endpoint": "",
"acc_oversea_endpoint": "",
"cdn_endpoint": "",
"endpoint": ""
}
],
"va_store_list": [
{
"store_id": "",
"type": "",
"bucket": "",
"base_path": "",
"role_arn": "",
"ownership": "",
"location": "",
"public_endpoint": "",
"vpc_endpoint": "",
"acc_endpoint": "",
"acc_oversea_endpoint": "",
"cdn_endpoint": "",
"endpoint": ""
}
]
},
"data_hash_name": "",
"store_redundancy_type": "LRS"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.