CreateDomain - 创建Domain

创建 domain。

接口说明

如果您需要基于 PDS 做二次运营,并想针对您的租户做一些细粒度控制,此时可以使用 PDS 的父子 Domain 功能。 详情:请联系官方钉钉群进行咨询:23146118

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/domain/create HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

parent_domain_idstring

父 domain id 如果需要创建子 domain,可以设置该值,一般情况下不需要创建。 如果需要针对 PDS 做二次运营,可以联系 PDS 官网客服进行咨询。

bj1
domain_namestring

domain 名称

你好企业网盘
descriptionstring

domain 描述

你好企业网盘开发环境
init_drive_enableboolean

是否开通默认网盘。为 true 则所有用户在第一次登录后都默认分配一个网盘。默认 false

true
init_drive_sizelong

init_drive_enable 为 true 时必选。 创建用户时,默认网盘的大小,单位:Bytes。 默认为 0,此时创建的 drive 大小为 0,不可以上传文件,如果需要初始化 drive, 请设置该值。 -1 则表示不限大小。

1073741824
user_count_quotalong

用户数配额,表示该 domain 允许创建的用户数量,为 0 表示不限制

50
size_quotalong

容量配额,表示 domain 下所有 drive 的总 quota 大小,0 表示不限制

1099511627776

返回参数

名称类型描述示例值
Domain

创建的域信息

示例

正常返回示例

JSON格式

{
  "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"
    ]
  },
  "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": "sha1"
}

错误码

访问错误中心查看更多错误码。