添加空间新版SDK

更新于 2023-06-06

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，在企业存储内添加新空间。

接口调用说明

存储空间介绍：

存储空间属于企业云盘的一部分，但是调用本接口添加的空间在客户端云盘内是不可见的。
存储空间会占用企业云盘的空间。

存储空间分类：

用户空间，即USER空间。该空间的文件只能授予永久权限，要求授权者有管理权限才能授权。
应用空间，即APP空间。该空间的文件只能授予临时权限，不要求授权者有管理权限。

接口功能介绍

调用本接口，在企业云盘下创建一个新的空间，在该空间内可以进行新建文件夹、上传文件等操作。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	企业存储空间写权限	API Explorer
第三方企业应用	支持	企业存储空间写权限	API Explorer
第三方个人应用	暂不支持	企业存储空间写权限	暂不支持

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证。企业内部应用，调用获取企业内部应用的accessToken接口获取。第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。
第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Query参数

名称	类型	是否必填	描述
unionId	String	是	操作人的unionId。企业内部应用，调用查询用户详情接口获取unionid参数值。第三方企业应用，调用查询用户详情接口获取unionid参数值。

名称

类型

是否必填

描述

unionId

String

是

操作人的unionId。

企业内部应用，调用查询用户详情接口获取unionid参数值。
第三方企业应用，调用查询用户详情接口获取unionid参数值。

Body参数

名称	类型	是否必填	描述
option	Object	否	可选参数。
name	String	否	空间名称，默认无空间名称。
quota	Long	否	空间能使用的最大容量，单位Byte。说明该参数不传，表示该空间容量没有具体容量限制，但是不超过企业云盘总容量。
capabilities	Object	否	空间能力项，默认表示不设置拓展能力项。
canSearch	Boolean	否	是否支持搜索。 true：支持 false：不支持，默认值。
canRename	Boolean	否	是否支持重命名空间名称。 true：支持 false：不支持，默认值。
canRecordRecentFile	Boolean	否	是否支持被列入最近使用列表。 true：支持 false：不支持，默认值。
scene	String	否	空间场景，该参数由开发者自定义传入。说明如果该参数不传，默认值是default。如果该参数值+sceneId已存在，本接口返回已创建的空间，不会创建新空间。
sceneId	String	否	空间场景Id，该参数值由开发者自定义传入。说明如果该参数不传，默认值是0。如果参数sceneId+该参数值已存在，本接口返回已创建的空间，不会创建新空间。
ownerType	String	否	owner类型。 USER：用户类型，默认值 APP：App类型

返回参数

名称	类型	描述
space	Object	空间信息。
id	String	空间id。
corpId	String	空间所在企业corpId。
creatorId	String	创建者unionId。
ownerType	String	owner类型。 USER：用户类型，默认值 APP：App类型
ownerId	String	所有者标识。
modifierId	String	修改者unionId。
usedQuota	Long	已使用容量，单位Byte。
quota	Long	总容量，单位Byte。
status	String	空间状态。 NORMAL：正常 DELETE：已删除
createTime	String	创建时间，iso8601格式，例如：2022-07-29T14:55Z。
modifiedTime	String	修改时间，iso8601格式，例如：2022-07-29T14:55Z。
appId	String	开放平台应用appId
scene	String	业务场景。
sceneId	String	空间场景Id。
capabilities	Object	空间能力项。
canSearch	Boolean	是否支持搜索。 true：支持 false：不支持，默认值。
canRename	Boolean	是否支持重命名空间名称。 true：支持 false：不支持，默认值。
canRecordRecentFile	Boolean	是否支持被列入最近使用列表。 true：支持 false：不支持，默认值。
name	String	空间名称。
partitions	Array	分区容量信息，最大值2。
partitionType	String	分区类型。 PUBLIC_OSS_PARTITION：公有云OSS存储分区 MINI_OSS_PARTITION：专属Mini OSS存储分区
quota	Object	容量信息。
used	Long	实际已使用容量，单位Byte，最小值0。说明表示该应用下所用文件占用容量的总和，文件的上传、复制、删除相关操作会对used的值做相应变更。
max	Long	最大容量，单位Byte。说明当前应用容量被设置为max时，代表当前应用容量设置了上限，used参数值不能大于max参数值。当前应用容量未设置为max时，返回空，此时应用共享该企业剩余可用容量。
reserved	Long	预分配剩余容量，单位Byte。说明管理后台可以给应用或空间预分配容量，此字段表示预分配剩余容量，即预分配容量中未使用部分。如果没有设置预分配容，此字段是空。
type	String	容量类型。 SHARE: 共享容量。此模式下，Quota.max为空，表示共享企业容量。 PRIVATE: 预分配容量（专享容量）。此模式下，Quota.max设置值后，表示容量独占。说明需要保证单个应用的可用容量不受其他应用影响时，可使用预分配容量（专享容量）。

示例

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

错误码

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError.name	%s	参数错误-name
400	paramError.scene	%s	参数错误-scene
400	paramError.sceneId	%s	参数错误-sceneId
403	permissionDenied	%s	用户缺少创建空间的权限
500	systemError	%s	系统错误
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

这篇文档是否有帮助？

本页内容