文档

GetDomain - 获取Domain

调试

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

调试

授权信息

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

请求语法

POST /v2/domain/get

请求参数

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

请求参数。

domain_idstring

domain id

bj1
get_quota_usedboolean

是否需要获取 domain 的已用 quota,默认为 false。当 domain 容量配额 size_quota 大于 0 时,传 true 可获取 domain 已用容量配额。

true

返回参数

名称类型描述示例值
Domain

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": ""
      },
      "we_chat_sync_config": {
        "enabled": true,
        "tag_id": "",
        "cron": ""
      }
    }
  },
  "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": ""
      }
    ]
  }
}

错误码

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

  • 本页导读 (0)
文档反馈