diff options
Diffstat (limited to 'data/zh_cn/pds')
| -rw-r--r-- | data/zh_cn/pds/2020-03-20/api-docs.php | 827 | ||||
| -rw-r--r-- | data/zh_cn/pds/2022-03-01/api-docs.php | 20311 |
2 files changed, 21138 insertions, 0 deletions
diff --git a/data/zh_cn/pds/2020-03-20/api-docs.php b/data/zh_cn/pds/2020-03-20/api-docs.php new file mode 100644 index 0000000..0fa359f --- /dev/null +++ b/data/zh_cn/pds/2020-03-20/api-docs.php @@ -0,0 +1,827 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'PDS', + 'product' => 'pds', + 'version' => '2020-03-20', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DoCheckResource', + 'DoLogicalDeleteResource', + 'EdmCanRefund', + 'DoPhysicalDeleteResource', + 'EdmPayOrderCallback', + 'HandleAliAccountLifecycleCommand', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DoCheckResource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'Interrupt', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Invoker', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Pk', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Bid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Hid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskIdentifier', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskExtraData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GmtWakeup', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Success', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Invoker' => [ + 'type' => 'string', + ], + 'Pk' => [ + 'type' => 'string', + ], + 'GmtWakeup' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Url' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TaskExtraData' => [ + 'type' => 'string', + ], + 'Bid' => [ + 'type' => 'string', + ], + 'Prompt' => [ + 'type' => 'string', + ], + 'TaskIdentifier' => [ + 'type' => 'string', + ], + 'Hid' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Country' => [ + 'type' => 'string', + ], + 'Interrupt' => [ + 'type' => 'boolean', + ], + 'Level' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [], + ], + 'DoLogicalDeleteResource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'Interrupt', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Invoker', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Pk', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Bid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Hid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskIdentifier', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskExtraData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GmtWakeup', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Success', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Invoker' => [ + 'type' => 'string', + ], + 'Pk' => [ + 'type' => 'string', + ], + 'GmtWakeup' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Url' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TaskExtraData' => [ + 'type' => 'string', + ], + 'Bid' => [ + 'type' => 'string', + ], + 'Prompt' => [ + 'type' => 'string', + ], + 'TaskIdentifier' => [ + 'type' => 'string', + ], + 'Hid' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Country' => [ + 'type' => 'string', + ], + 'Interrupt' => [ + 'type' => 'boolean', + ], + 'Level' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [], + ], + 'EdmCanRefund' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'data', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'string', + ], + 'success' => [ + 'type' => 'boolean', + ], + 'synchro' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DoPhysicalDeleteResource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'Interrupt', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Invoker', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Pk', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Bid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Hid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskIdentifier', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskExtraData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GmtWakeup', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Success', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Invoker' => [ + 'type' => 'string', + ], + 'Pk' => [ + 'type' => 'string', + ], + 'GmtWakeup' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Url' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TaskExtraData' => [ + 'type' => 'string', + ], + 'Bid' => [ + 'type' => 'string', + ], + 'Prompt' => [ + 'type' => 'string', + ], + 'TaskIdentifier' => [ + 'type' => 'string', + ], + 'Hid' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Country' => [ + 'type' => 'string', + ], + 'Interrupt' => [ + 'type' => 'boolean', + ], + 'Level' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [], + ], + 'EdmPayOrderCallback' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'data', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'string', + ], + 'success' => [ + 'type' => 'boolean', + ], + 'synchro' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'HandleAliAccountLifecycleCommand' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'data', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'string', + ], + 'success' => [ + 'type' => 'boolean', + ], + 'synchro' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cn-shenzhen.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cn-beijing.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cn-zhangjiakou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cn-hangzhou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cn-shanghai.admin.aliyunpds.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ap-southeast-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'cn-guangzhou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cn-hongkong.admin.aliyunpds.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'us-west-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'eu-central-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ap-southeast-5.admin.aliyunpds.com', + ], + ], +]; diff --git a/data/zh_cn/pds/2022-03-01/api-docs.php b/data/zh_cn/pds/2022-03-01/api-docs.php new file mode 100644 index 0000000..83250c5 --- /dev/null +++ b/data/zh_cn/pds/2022-03-01/api-docs.php @@ -0,0 +1,20311 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'PDS', + 'product' => 'pds', + 'version' => '2022-03-01', + ], + 'directories' => [ + [ + 'id' => 181654, + 'title' => 'Domain管理', + 'type' => 'directory', + 'children' => [ + 'CreateDomain', + 'GetDomain', + 'UpdateDomain', + 'ListDomains', + 'SearchDomains', + 'DeleteDomain', + ], + ], + [ + 'id' => 165270, + 'title' => '认证与授权', + 'type' => 'directory', + 'children' => [ + 'Authorize', + 'Token', + ], + ], + [ + 'id' => 163808, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'GetLinkInfoByUserId', + 'LinkAccount', + 'GetLinkInfo', + 'UnLinkAccount', + ], + ], + [ + 'id' => 165207, + 'title' => '群组管理', + 'type' => 'directory', + 'children' => [ + 'CreateGroup', + 'UpdateGroup', + 'GetGroup', + 'ListGroup', + 'DeleteGroup', + 'AddGroupMember', + 'RemoveGroupMember', + 'ListGroupMember', + ], + ], + [ + 'id' => 163812, + 'title' => '用户管理', + 'type' => 'directory', + 'children' => [ + 'CreateUser', + 'ImportUser', + 'UpdateUser', + 'GetUser', + 'ListUser', + 'SearchUser', + 'DeleteUser', + ], + ], + [ + 'id' => 163815, + 'title' => '空间管理', + 'type' => 'directory', + 'children' => [ + 'CreateDrive', + 'UpdateDrive', + 'GetDrive', + 'ListDrive', + 'GetDefaultDrive', + 'ListMyDrives', + 'SearchDrive', + 'DeleteDrive', + ], + ], + [ + 'id' => 163817, + 'title' => '文件管理', + 'type' => 'directory', + 'children' => [ + 'CreateFile', + 'DeleteFile', + 'UpdateFile', + 'SearchFile', + 'ListFile', + 'GetFile', + 'DownloadFile', + 'GetUploadUrl', + 'ListUploadedParts', + 'CompleteFile', + 'MoveFile', + 'CopyFile', + 'GetDownloadUrl', + 'FilePutUserTags', + 'FileDeleteUserTags', + 'VideoDRMLicense', + ], + ], + [ + 'id' => 168925, + 'title' => '文件多版本管理', + 'type' => 'directory', + 'children' => [ + 'DeleteRevision', + 'UpdateRevision', + 'RestoreRevision', + 'ListRevision', + 'GetRevision', + ], + ], + [ + 'id' => 165276, + 'title' => '增量处理', + 'type' => 'directory', + 'children' => [ + 'ScanFile', + 'ListDelta', + 'DeltaGetLastCursor', + ], + ], + [ + 'id' => 164951, + 'title' => '权限管理', + 'type' => 'directory', + 'children' => [ + 'ListReceivedFile', + 'ListMyGroupDrive', + 'FileRemovePermission', + 'FileAddPermission', + 'FileListPermission', + 'ListAssignment', + 'AssignRole', + 'CancelAssignRole', + ], + ], + [ + 'id' => 164958, + 'title' => '分享管理', + 'type' => 'directory', + 'children' => [ + 'CreateShareLink', + 'UpdateShareLink', + 'SearchShareLink', + 'CancelShareLink', + 'ListShareLink', + 'GetShareLink', + 'GetShareLinkByAnonymous', + 'GetShareLinkToken', + ], + ], + [ + 'id' => 164964, + 'title' => '回收站管理', + 'type' => 'directory', + 'children' => [ + 'TrashFile', + 'ClearRecyclebin', + 'ListRecyclebin', + 'RestoreFile', + ], + ], + [ + 'id' => 163810, + 'title' => '图像AI管理', + 'type' => 'directory', + 'children' => [ + 'UpdateFacegroup', + 'ListTags', + 'ListAddressGroups', + 'ListFacegroups', + 'SearchAddressGroups', + 'RemoveFaceGroupFile', + 'CreateStory', + 'CreateCustomizedStory', + 'SearchStories', + 'GetStory', + 'UpdateStory', + 'DeleteStory', + 'AddStoryFiles', + 'RemoveStoryFiles', + 'CreateSimilarImageClusterTask', + 'GetTaskStatus', + 'SearchSimilarImageClusters', + ], + ], + [ + 'id' => 165162, + 'title' => '任务管理', + 'type' => 'directory', + 'children' => [ + 'GetAsyncTask', + ], + ], + [ + 'id' => 166916, + 'title' => '在线视频预览', + 'type' => 'directory', + 'children' => [ + 'GetVideoPreviewPlayMeta', + 'GetVideoPreviewPlayInfo', + ], + ], + [ + 'id' => 182149, + 'title' => '权益管理', + 'type' => 'directory', + 'children' => [ + 'CreateIdentityToBenefitPkgMapping', + 'UpdateIdentityToBenefitPkgMapping', + 'GetIdentityToBenefitPkgMapping', + 'ListIdentityToBenefitPkgMapping', + ], + ], + [ + 'id' => 182158, + 'title' => '内容安全管理', + 'type' => 'directory', + 'children' => [ + 'InvestigateFile', + 'CsiGetFileInfo', + ], + ], + [ + 'id' => 172104, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'Batch', + 'AuditLogExport', + 'GetDomainQuota', + 'GroupUpdateName', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'PunishFile', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AccountAccessTokenResponse' => [ + 'title' => '账号 access token 的相应', + 'description' => '账号 access token 的相应结构', + 'type' => 'object', + 'properties' => [ + 'access_token' => [ + 'title' => '访问凭证', + 'type' => 'string', + ], + 'refresh_token' => [ + 'title' => '刷新凭证', + 'type' => 'string', + ], + 'expires_in' => [ + 'title' => '凭证有效期', + 'type' => 'integer', + 'format' => 'int64', + ], + 'token_type' => [ + 'title' => '凭证类型', + 'type' => 'string', + ], + 'user_id' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'user_name' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'avatar' => [ + 'title' => '用户头像', + 'type' => 'string', + ], + 'nick_name' => [ + 'title' => '用户昵称', + 'type' => 'string', + ], + 'default_drive_id' => [ + 'title' => '用户默认空间ID', + 'type' => 'string', + ], + 'role' => [ + 'title' => '用户角色', + 'type' => 'string', + ], + 'status' => [ + 'title' => '用户状态', + 'type' => 'string', + ], + 'expire_time' => [ + 'title' => '凭证过期时间', + 'type' => 'string', + ], + 'is_first_login' => [ + 'title' => '是否首次登录', + 'type' => 'boolean', + ], + 'device_id' => [ + 'title' => '登录设备ID', + 'type' => 'string', + ], + 'device_name' => [ + 'title' => '登录设备名称', + 'type' => 'string', + ], + 'domain_id' => [ + 'title' => '域ID', + 'type' => 'string', + ], + 'default_sbox_drive_id' => [ + 'title' => '默认保险箱空间 ID', + 'type' => 'string', + ], + 'state' => [ + 'title' => '临时权限，用于登录成功后设置密码', + 'type' => 'string', + ], + 'exist_link' => [ + 'title' => '当前用户已存在的登录方式', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LinkInfo', + ], + ], + 'need_link' => [ + 'title' => '是否需要引用', + 'type' => 'boolean', + ], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'pin_setup' => [ + 'title' => '用户的数据密码是否设置过', + 'type' => 'boolean', + ], + 'need_rp_verify' => [ + 'title' => '用户是否需要进行的实人认证', + 'type' => 'boolean', + ], + 'path_status' => [ + 'title' => '用户 path 开启状', + 'type' => 'string', + ], + ], + ], + 'AccountLinkInfo' => [ + 'title' => 'A short description of struct', + 'description' => '用户绑定的账号信息', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域ID', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'authentication_type' => [ + 'title' => '账号类型', + 'description' => '账号类型'."\n" + ."\n" + .'- mobile：手机号'."\n" + ."\n" + .'- email：邮箱'."\n" + ."\n" + .'- ding：钉钉'."\n" + ."\n" + .'- ram：阿里云RAM子账号'."\n" + ."\n" + .'- wechat：企业微信'."\n" + ."\n" + .'- ldap：LDAP账号'."\n" + ."\n" + .'- custom：自定义账号', + 'type' => 'string', + 'example' => 'mobile', + ], + 'identity' => [ + 'title' => '账号唯一标识', + 'description' => '账号唯一标识', + 'type' => 'string', + 'example' => '136***000', + ], + 'extra' => [ + 'title' => '账号附加信息', + 'description' => '账号附加信息，当账号类型为手机号时，此字段表示国家编码，比如中国大陆为86，当前只有手机号才返回此字段', + 'type' => 'string', + 'example' => '86', + ], + 'user_id' => [ + 'title' => '账号对应的用户ID', + 'description' => '账号对应的用户ID', + 'type' => 'string', + 'example' => '00016a587b62b50003deea299a4f5b50', + ], + 'created_at' => [ + 'title' => '账号创建时间', + 'description' => '账号创建时间，从1970年1月1日0点到现在的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579768', + ], + 'display_name' => [ + 'title' => '账号显示名', + 'description' => '账号显示名，用于界面上展示的名称，比如LDAP账号唯一标识为uid，但是展示给用户看的可以选择工号或其他信息', + 'type' => 'string', + 'example' => '001', + ], + 'status' => [ + 'title' => '账号状态', + 'description' => '账号状态', + 'type' => 'string', + 'example' => 'normal', + ], + 'last_login_time' => [ + 'title' => '账号最后一次登录的时间', + 'description' => '账号最后一次登录的时间，从1970年1月1日0点到现在的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579769', + ], + ], + ], + 'Activity' => [ + 'title' => 'A short description of struct', + 'description' => '最近活动', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间 id', + 'type' => 'string', + ], + 'activity_id' => [ + 'title' => '活动 id', + 'type' => 'string', + ], + 'user_id' => [ + 'title' => '用户 id', + 'type' => 'string', + ], + 'device' => [ + 'title' => '设备名', + 'type' => 'string', + ], + 'event_type' => [ + 'title' => '事件类型', + 'type' => 'integer', + 'format' => 'int32', + ], + 'latest_event_time' => [ + 'title' => '最近事件时间', + 'type' => 'string', + ], + 'resource_category' => [ + 'title' => '资源类型', + 'type' => 'integer', + 'format' => 'int32', + ], + 'resource_list' => [ + 'title' => '资源列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + ], + ], + 'total_resource_count' => [ + 'title' => '资源总数', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'AddStoryFile' => [ + 'title' => '向故事中添加文件的相关返回信息', + 'description' => '返回添加到故事中的文件及其成功与否', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id', + 'type' => 'string', + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'title' => '文件版本号', + 'description' => '文件版本号', + 'type' => 'string', + 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', + ], + 'error_code' => [ + 'title' => '添加单文件时的错误码', + 'description' => '添加单文件时的错误码', + 'type' => 'string', + ], + 'error_message' => [ + 'title' => '添加单文件时的错误信息', + 'description' => '添加单文件时的错误信息', + 'type' => 'string', + ], + ], + ], + 'Address' => [ + 'title' => '地点', + 'description' => '地点', + 'type' => 'object', + 'properties' => [ + 'country' => [ + 'title' => '国家或地区', + 'description' => '国家或地区', + 'type' => 'string', + 'example' => '中国', + ], + 'province' => [ + 'title' => '省', + 'description' => '省', + 'type' => 'string', + 'example' => '浙江省', + ], + 'city' => [ + 'title' => '城市', + 'description' => '城市', + 'type' => 'string', + 'example' => '杭州市', + ], + 'district' => [ + 'title' => '区', + 'description' => '区', + 'type' => 'string', + 'example' => '余杭区', + ], + 'township' => [ + 'title' => '街道', + 'description' => '街道', + 'type' => 'string', + 'example' => '文一西路', + ], + ], + ], + 'AddressGroup' => [ + 'title' => '地点分组', + 'description' => '地点分组', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '地点名称', + 'description' => '地点名称', + 'type' => 'string', + ], + 'location' => [ + 'title' => '经纬度', + 'description' => '经纬度', + 'type' => 'string', + 'example' => '30.12231,120.1212', + ], + 'count' => [ + 'title' => '地点数量', + 'description' => '地点分组内文件数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'cover_url' => [ + 'title' => '地点封面图片地址', + 'description' => '地点封面图片地址', + 'type' => 'string', + ], + 'cover_file_id' => [ + 'title' => '地点封面图片文件ID', + 'description' => '地点封面图片文件ID', + 'type' => 'string', + ], + 'address_detail' => [ + 'title' => '地点详细信息', + 'description' => '地点详细信息', + '$ref' => '#/components/schemas/Address', + ], + ], + ], + 'Aggregation' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'title' => '字段', + 'type' => 'string', + 'format' => 'byte', + ], + 'operation' => [ + 'title' => '操作', + 'type' => 'string', + 'format' => 'byte', + ], + 'value' => [ + 'title' => '值', + 'type' => 'number', + 'format' => 'double', + ], + 'groups' => [ + 'title' => '组', + 'type' => 'array', + 'items' => [ + 'required' => false, + '$ref' => '#/components/schemas/AggregationsGroup', + ], + ], + ], + ], + 'AggregationsGroup' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'title' => '计数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'value' => [ + 'title' => '值', + 'type' => 'string', + 'format' => 'byte', + ], + ], + ], + 'Album' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'album_id' => [ + 'title' => 'album_id', + 'type' => 'string', + ], + 'owner' => [ + 'title' => 'owner', + 'type' => 'string', + ], + 'name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'description' => [ + 'title' => 'description', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => 'updated_at', + 'type' => 'string', + ], + 'user_tags' => [ + 'title' => 'user_tags', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'file_count' => [ + 'title' => 'file_count', + 'type' => 'integer', + 'format' => 'int64', + ], + 'cover_file' => [ + 'title' => 'cover_file', + '$ref' => '#/components/schemas/File', + ], + 'base_face_file' => [ + 'title' => 'base_face_file', + '$ref' => '#/components/schemas/File', + ], + 'base_face_group_id' => [ + 'title' => 'base_face_group_id', + 'type' => 'string', + ], + ], + ], + 'AlbumFile' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'album_id' => [ + 'title' => '相册 ID', + 'type' => 'string', + ], + 'joined_at' => [ + 'title' => '加入相册的时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'domain_id' => [ + 'title' => '域 ID', + 'type' => 'string', + ], + 'drive_id' => [ + 'title' => '空间 ID', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => '文件 ID', + 'type' => 'string', + ], + 'name' => [ + 'title' => '文件名', + 'type' => 'string', + ], + 'type' => [ + 'title' => '文件类型', + 'type' => 'string', + ], + 'content_type' => [ + 'title' => '内容类型', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'transhed_at' => [ + 'title' => '放入回收站时间', + 'type' => 'string', + ], + 'file_extension' => [ + 'title' => '文件后缀', + 'type' => 'string', + ], + 'mime_type' => [ + 'title' => 'MIME 类型', + 'type' => 'string', + ], + 'hidden' => [ + 'title' => '是否隐藏', + 'type' => 'boolean', + ], + 'size' => [ + 'title' => '大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'starred' => [ + 'title' => '是否收藏', + 'type' => 'boolean', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + ], + 'user_meta' => [ + 'title' => '自定义元数据', + 'type' => 'string', + ], + 'labels' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'upload_id' => [ + 'title' => '上传 ID', + 'type' => 'string', + ], + 'parent_file_id' => [ + 'title' => '父文件 ID', + 'type' => 'string', + ], + 'crc64_hash' => [ + 'title' => 'crc64', + 'type' => 'string', + ], + 'content_hash' => [ + 'title' => '内容哈希', + 'type' => 'string', + ], + 'content_hash_name' => [ + 'title' => '内容哈希算法', + 'type' => 'string', + ], + 'download_url' => [ + 'title' => '下载地址', + 'type' => 'string', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'type' => 'string', + ], + 'category' => [ + 'title' => '文件分类', + 'type' => 'string', + ], + 'local_created_at' => [ + 'title' => '本地创建时间', + 'type' => 'string', + ], + 'local_modified_at' => [ + 'title' => '本地修改时间', + 'type' => 'string', + ], + 'revision_id' => [ + 'title' => '版本 ID', + 'type' => 'string', + ], + 'investigation_info' => [ + 'title' => '审核信息', + '$ref' => '#/components/schemas/InvestigationInfo', + ], + 'thumbnail_urls' => [ + 'title' => '多尺度缩略图地址', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'image_media_metadata' => [ + 'title' => '图片信息。仅开启增值服务图片处理功能有效。', + '$ref' => '#/components/schemas/ImageMediaMetadata', + ], + 'ex_fields_info' => [ + 'title' => '自定义扩展信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + 'object_uri' => [ + 'title' => '内容对象的uri', + 'type' => 'string', + ], + ], + ], + 'App' => [ + 'title' => 'app', + 'type' => 'object', + 'properties' => [ + 'app_id' => [ + 'title' => 'app_id', + 'type' => 'string', + ], + 'app_name' => [ + 'title' => 'app_name', + 'type' => 'string', + ], + 'description' => [ + 'title' => 'description', + 'type' => 'string', + ], + 'redirect_uri' => [ + 'title' => 'redirect_uri', + 'type' => 'string', + ], + 'scope' => [ + 'title' => 'scope', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'app_secret' => [ + 'title' => 'app_secret', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => 'updated_at', + 'type' => 'string', + ], + 'logo' => [ + 'title' => 'logo', + 'type' => 'string', + ], + 'type' => [ + 'title' => 'type', + 'type' => 'string', + ], + 'provider' => [ + 'title' => 'provider', + 'type' => 'string', + ], + 'stage' => [ + 'title' => 'stage', + 'type' => 'string', + ], + ], + ], + 'AppAccessStrategy' => [ + 'title' => 'App访问策略', + 'description' => 'App访问策略', + 'type' => 'object', + 'properties' => [ + 'effect' => [ + 'title' => 'App 访问策略', + 'description' => '全局 App 访问策略'."\n" + .'* allow 表示允许所有 app 来访问该 domain'."\n" + .'* deny 表示拒绝所有 app 来访问该 domain（默认）'."\n" + ."\n\n" + .'建议配置：'."\n" + .'1. 全局访问策略 effect 设置为 deny'."\n" + .'2. 允许部分 app ID 来访问，设置 except_app_id_list 为 ["appid1", "appid2"]', + 'type' => 'string', + 'enumValueTitles' => [ + 'allow' => '允许', + 'deny' => '拒绝', + ], + 'example' => 'deny', + ], + 'except_app_id_list' => [ + 'title' => '白名单或黑名单AppID列表', + 'description' => '例外的 app ID 列表'."\n" + ."\n" + .' * 当全局策略 effect 为 allow 时，表示全局允许所有的 app 来访问 domain，但是处于 except_app_id_list 列表的 app 则禁止访问 domain。'."\n" + .' * 当全局策略 effect 为 deny 时，表示全局禁止所有的 app 来访问 domain，但是处于 except_app_id_list 列表的 app 则允许访问 domain。', + 'type' => 'array', + 'items' => [ + 'description' => 'appID', + 'type' => 'string', + 'example' => '8ovxCTRUDdbpVWBP', + ], + ], + ], + ], + 'ArchiveFilesConfigResponse' => [ + 'title' => 'ArchiveFilesConfigResponse', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => 'enabled', + 'type' => 'boolean', + ], + 'version' => [ + 'title' => 'version', + 'type' => 'string', + ], + ], + ], + 'AuditLog' => [ + 'title' => '审计日志', + 'description' => '审计日志', + 'type' => 'object', + 'properties' => [ + 'log_id' => [ + 'title' => '日志id', + 'type' => 'string', + ], + 'acted_at' => [ + 'title' => '操作时间', + 'type' => 'string', + ], + 'actor_id' => [ + 'title' => '操作者id', + 'type' => 'string', + ], + 'actor_type' => [ + 'title' => '操作者类型', + 'type' => 'string', + ], + 'actor_name' => [ + 'title' => '操作者名称', + 'type' => 'string', + ], + 'action_category' => [ + 'title' => '操作分类', + 'type' => 'string', + ], + 'action_type' => [ + 'title' => '操作类型', + 'type' => 'string', + ], + 'object_id' => [ + 'title' => '对象id', + 'type' => 'string', + ], + 'object_name' => [ + 'title' => '对象名', + 'type' => 'string', + ], + 'file_path_type' => [ + 'title' => '文件空间类型', + 'type' => 'string', + ], + 'detail' => [ + 'title' => '日志详情', + '$ref' => '#/components/schemas/AuditLogDetail', + ], + 'client_ip' => [ + 'title' => '客户端IP', + 'type' => 'string', + ], + 'client_type' => [ + 'title' => '客户端类型', + 'type' => 'string', + ], + 'client_version' => [ + 'title' => '客户端版本', + 'type' => 'string', + ], + 'client_device' => [ + 'title' => '客户端设备', + 'type' => 'string', + ], + ], + ], + 'AuditLogDetail' => [ + 'title' => '审计日志详情', + 'description' => '审计日志详情', + 'type' => 'object', + 'properties' => [ + 'file_log_detail' => [ + '$ref' => '#/components/schemas/FileLogDetail', + ], + 'user_log_detail' => [ + '$ref' => '#/components/schemas/UserLogDetail', + ], + 'drive_log_detail' => [ + '$ref' => '#/components/schemas/DriveLogDetail', + ], + ], + ], + 'BaseAlbumFileOperationResult' => [ + 'title' => 'A short description of struct', + 'description' => '相册文件操作结果', + 'type' => 'object', + 'properties' => [ + 'file' => [ + 'title' => '文件源信息', + '$ref' => '#/components/schemas/CommonFileItem', + ], + 'is_succeed' => [ + 'title' => '操作是否成功', + 'type' => 'boolean', + ], + 'error_code' => [ + 'title' => '操作失败的错误码', + 'type' => 'string', + ], + 'error_message' => [ + 'title' => '操作失败的错误原因', + 'type' => 'string', + ], + ], + ], + 'BaseAssignmentResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'domain_id', + 'type' => 'string', + ], + 'identity' => [ + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'title' => 'role_id', + 'type' => 'string', + ], + 'manage_resource_type' => [ + 'title' => 'manage_resource_type', + 'type' => 'string', + ], + 'manage_resource_id' => [ + 'title' => 'manage_resource_id', + 'type' => 'string', + ], + 'associated_role_tag_id' => [ + 'title' => 'associated_role_tag_id', + 'type' => 'string', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => 'updated_at', + 'type' => 'string', + ], + 'disinherit_sub_group' => [ + 'title' => 'disinherit_sub_group', + 'type' => 'boolean', + ], + ], + ], + 'BaseDomainResponse' => [ + 'title' => 'base domain 信息', + 'description' => 'Domain 基础信息', + 'type' => 'object', + 'properties' => [ + 'parent_domain_id' => [ + 'title' => 'parent_domain_id string 父 domain id，如果存在，表示该 domain为子 domain domain_id string domain id', + 'type' => 'string', + ], + 'domain_id' => [ + 'title' => 'domain id', + 'type' => 'string', + ], + 'domain_name' => [ + 'title' => '域名称', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'init_drive_enable' => [ + 'title' => '否开通默认网盘。为true则所有用户在第一次登录后都默认分配一个网盘。默认false', + 'type' => 'boolean', + ], + 'init_drive_size' => [ + 'title' => 'init_drive_enable==true时必选。 默认网盘的大小, 单位：Bytes。为0则表示不限大小。默认为0', + 'type' => 'integer', + 'format' => 'int64', + ], + 'updated_at' => [ + 'title' => '最后修改时间，ISO格式，如: 2019-04-08T07:05:18.825Z', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'type' => 'string', + ], + 'size_quota' => [ + 'title' => '容量配额', + 'type' => 'integer', + 'format' => 'int64', + ], + 'size_quota_used' => [ + 'title' => '容量配额使用空间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'status' => [ + 'title' => 'domain状态：创建中，正常，已过期', + 'type' => 'integer', + 'format' => 'int64', + ], + 'used_size' => [ + 'title' => '逻辑空间使用量，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + ], + 'published_app_access_strategy' => [ + 'title' => 'App 访问策略', + '$ref' => '#/components/schemas/AppAccessStrategy', + ], + 'share_link_enabled' => [ + 'title' => '是否允许创建分享链接，默认为 false', + 'type' => 'boolean', + ], + ], + ], + 'BaseDriveResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Domain ID', + 'type' => 'string', + 'example' => 'hz999', + ], + 'drive_id' => [ + 'title' => 'Drive ID', + 'type' => 'string', + 'example' => '123', + ], + 'drive_name' => [ + 'title' => 'Drive 名称', + 'type' => 'string', + 'example' => 'ccpdrive', + ], + 'description' => [ + 'title' => 'Drive 备注信息', + 'type' => 'string', + 'example' => 'ccp team drive', + ], + 'creator' => [ + 'title' => 'Drive 创建者', + 'type' => 'string', + 'example' => 'ccp', + ], + 'owner' => [ + 'title' => 'Drive 所有者', + 'type' => 'string', + 'example' => 'ccp', + ], + 'owner_type' => [ + 'title' => 'Drive 所有者类型', + 'type' => 'string', + 'example' => 'user', + ], + 'drive_type' => [ + 'title' => 'Drive 类型', + 'type' => 'string', + 'example' => 'normal', + ], + 'status' => [ + 'title' => 'Drive 状态', + 'type' => 'string', + 'example' => 'enabled', + ], + 'used_size' => [ + 'title' => 'Drive 空间已使用量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'total_size' => [ + 'title' => 'Drive 空间总量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102400', + ], + 'store_id' => [ + 'title' => '存储 ID, domain的PathType为OSSPath时返回', + 'type' => 'string', + 'example' => '123', + ], + 'relative_path' => [ + 'title' => 'relative_path', + 'type' => 'string', + ], + 'encrypt_mode' => [ + 'title' => 'encrypt_mode', + 'type' => 'string', + ], + 'encrypt_data_access' => [ + 'title' => 'encrypt_data_access', + 'type' => 'boolean', + ], + 'action_list' => [ + 'title' => 'action_list', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => 'updated_at', + 'type' => 'string', + ], + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => [ + '$ref' => '#/components/schemas/IDPermission', + ], + ], + 'is_handover' => [ + 'title' => '是否为交接的drive', + 'type' => 'boolean', + ], + 'category' => [ + 'title' => 'category', + 'type' => 'string', + ], + 'path_status' => [ + 'title' => 'path_status', + 'type' => 'string', + ], + 'delta_enabled' => [ + 'title' => '是否开启了delta', + 'type' => 'boolean', + ], + ], + ], + 'BaseFileListInheritPermissionResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'member' => [ + 'title' => 'member', + '$ref' => '#/components/schemas/FilePermissionMember', + ], + 'file_id' => [ + 'title' => 'file_id', + 'type' => 'string', + ], + ], + ], + 'BaseFileUserPermissionResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'domain_id', + 'type' => 'string', + 'example' => 'bj23', + ], + 'identity' => [ + 'title' => 'identity', + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'title' => 'role_id', + 'type' => 'string', + ], + 'drive_id' => [ + 'title' => 'drive_id', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => 'file_id', + 'type' => 'string', + ], + 'file_full_path' => [ + 'title' => 'file_full_path', + 'type' => 'string', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'integer', + 'format' => 'int64', + ], + 'expire_time' => [ + 'title' => 'expire_time', + 'type' => 'integer', + 'format' => 'int64', + ], + 'disinherit_sub_group' => [ + 'title' => 'disinherit_sub_group', + 'type' => 'boolean', + ], + 'can_access' => [ + 'title' => 'can_access', + 'type' => 'boolean', + ], + ], + ], + 'BaseGroupResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'domain id', + 'type' => 'string', + 'example' => 'bj123', + ], + 'group_id' => [ + 'title' => 'group id', + 'type' => 'string', + 'example' => 'b38b5681bd964950ad8bc0f8ea504793', + ], + 'group_name' => [ + 'title' => 'group name', + 'type' => 'string', + 'example' => 'name-111', + ], + 'description' => [ + 'title' => 'description', + 'type' => 'string', + 'example' => 'desc-111', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111111', + ], + 'updated_at' => [ + 'title' => 'updated_at', + 'type' => 'string', + 'example' => '111111', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + 'example' => 'system', + ], + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => [ + '$ref' => '#/components/schemas/IDPermission', + ], + ], + 'is_sync' => [ + 'title' => 'is_sync', + 'type' => 'boolean', + ], + ], + ], + 'BaseRoleMemberResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'domain_id', + 'type' => 'string', + ], + 'identity' => [ + '$ref' => '#/components/schemas/Identity', + ], + 'identity_name' => [ + 'title' => 'identity_name', + 'type' => 'string', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => 'created_at', + 'type' => 'string', + ], + 'is_admin' => [ + 'title' => 'is_admin', + 'type' => 'boolean', + ], + 'assignment_list' => [ + 'title' => 'assignment_list', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/BaseAssignmentResponse', + ], + ], + 'subdomain_id' => [ + 'title' => 'subdomain_id', + 'type' => 'string', + ], + ], + ], + 'BaseUserResponse' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Domain ID', + 'type' => 'string', + 'example' => 'hz999', + ], + 'user_id' => [ + 'title' => '用户 ID', + 'type' => 'string', + 'example' => 'ccpuserid', + ], + 'avatar' => [ + 'title' => '头像', + 'type' => 'string', + 'example' => 'http://a.b.c/ccp.jpg', + ], + 'created_at' => [ + 'title' => '用户创建时间', + 'type' => 'string', + 'example' => '1567407718386', + ], + 'updated_at' => [ + 'title' => '用户修改时间', + 'type' => 'string', + 'example' => '1567407718386', + ], + 'email' => [ + 'title' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nick_name' => [ + 'title' => '昵称', + 'type' => 'string', + 'example' => 'abc', + ], + 'phone' => [ + 'title' => '电话', + 'type' => 'string', + 'example' => '13700000000', + ], + 'phone_region' => [ + 'title' => '国家编码', + 'type' => 'string', + ], + 'role' => [ + 'title' => '角色', + 'type' => 'string', + 'example' => 'user', + ], + 'status' => [ + 'title' => '用户状态', + 'type' => 'string', + 'example' => 'enabled', + ], + 'user_name' => [ + 'title' => '用户名称', + 'type' => 'string', + 'example' => 'name', + ], + 'description' => [ + 'title' => '用户备注信息', + 'type' => 'string', + 'example' => 'ccp team user', + ], + 'default_drive_id' => [ + 'title' => '默认 Drive ID', + 'type' => 'string', + 'example' => '123', + ], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + 'deny_change_password_by_self' => [ + 'title' => '禁止用户自行修改密码', + 'type' => 'boolean', + ], + 'need_change_password_next_login' => [ + 'title' => '下次登录强制修改密码', + 'type' => 'boolean', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + 'example' => 'system', + ], + 'expired_at' => [ + 'title' => '用户过期时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => [ + '$ref' => '#/components/schemas/IDPermission', + ], + ], + 'is_sync' => [ + 'title' => 'is_sync', + 'type' => 'boolean', + ], + 'default_location' => [ + 'title' => 'default_location', + 'type' => 'string', + ], + 'last_login_time' => [ + 'title' => 'last_login_time', + 'type' => 'integer', + 'format' => 'int64', + ], + 'path_status' => [ + 'title' => 'path 开启状态', + 'type' => 'string', + ], + ], + ], + 'BenefitPkgDeliveryInfo' => [ + 'title' => 'A short description of struct', + 'description' => '权益包下发信息', + 'type' => 'object', + 'properties' => [ + 'amount' => [ + 'title' => '权益包下发的数量', + 'description' => '权益包下发的数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'is_permanent' => [ + 'title' => '是否永久有效', + 'description' => '是否永久有效', + 'type' => 'boolean', + 'example' => 'false', + ], + 'expire_time' => [ + 'title' => '权益包下发的超期时间', + 'description' => '权益包下发的超期时间'."\n" + ."\n" + .'is_permanent为false时，返回有效值', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'created_at' => [ + 'title' => '权益包下发的创建时间', + 'description' => '权益包下发的创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + ], + ], + 'CNameStatus' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'bingding_state' => [ + 'title' => 'binding_state', + 'type' => 'string', + 'example' => 'BINDING/BOUND', + ], + 'legal_state' => [ + 'title' => 'legal_state', + 'type' => 'string', + 'example' => 'NORMAL/ABNORMAL', + ], + 'remark' => [ + 'title' => 'remark', + 'type' => 'string', + 'example' => 'beian', + ], + ], + ], + 'CdnFileDownloadCallbackInfo' => [ + 'title' => 'CDN下载回调', + 'description' => 'CDN文件下载回调', + 'type' => 'object', + 'properties' => [ + 'bucket' => [ + 'title' => 'bucket名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ccp-bj1-bj-1234', + ], + 'object' => [ + 'title' => 'oss key', + 'type' => 'string', + 'required' => true, + ], + 'httpHeader.range' => [ + 'title' => '下载范围', + 'type' => 'string', + 'example' => 'bytes=0-1024', + ], + 'domain_id' => [ + 'title' => 'domain id', + 'type' => 'string', + 'required' => true, + ], + 'user_id' => [ + 'title' => '用户id', + 'type' => 'string', + 'required' => true, + ], + 'drive_id' => [ + 'title' => 'drive id', + 'type' => 'string', + 'required' => true, + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + 'required' => true, + ], + 'token' => [ + 'title' => '访问token', + 'type' => 'string', + 'required' => true, + 'example' => 'md5.Sum([]byte(fmt.Sprintf("%v%v%v%v%v%v...%v", req.Object, req.Range, req.DomainID, req.DriveID, req.UserID, req.FileID, req.Expire)))', + ], + 'expire' => [ + 'title' => 'unix超时时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + 'required' => true, + ], + 'CertInfo' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'cert_name' => [ + 'title' => 'cert_name', + 'type' => 'string', + 'example' => 'xxx', + ], + 'cert_body' => [ + 'title' => 'cert_body', + 'type' => 'string', + 'example' => 'xxx', + ], + 'cert_privatekey' => [ + 'title' => 'cert_privatekey', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'ClearRecycleBinItem' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'domain_id', + 'type' => 'string', + ], + 'drive_id' => [ + 'title' => 'drive_id', + 'type' => 'string', + ], + 'task_id' => [ + 'title' => 'task_id', + 'type' => 'string', + ], + 'async_task_id' => [ + 'title' => 'async_task_id', + 'type' => 'string', + ], + ], + ], + 'CommonFileItem' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => 'drive_id', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => 'file_id', + 'type' => 'string', + ], + 'revision_id' => [ + 'title' => 'revision_id', + 'type' => 'string', + ], + ], + ], + 'CopyUserTagsDirective' => [ + 'title' => 'CopyUserTagsDirective', + 'type' => 'object', + 'properties' => [ + 'directive' => [ + 'title' => 'copy 时的 user tags 设置选项', + 'type' => 'string', + 'example' => 'all, include, none, exclude', + ], + 'keys' => [ + 'title' => 'include/exlcude 选择的 keys', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'CssCreateOrderParam' => [ + 'title' => '创建订单/询价参数', + 'description' => '创建订单/询价参', + 'type' => 'object', + 'properties' => [ + 'buyerId' => [ + 'title' => '购买用户ID（aliuid', + 'type' => 'integer', + 'format' => 'int64', + ], + 'childId' => [ + 'title' => '子用户ID（childid', + 'type' => 'integer', + 'format' => 'int64', + ], + 'userId' => [ + 'title' => '使用者ID（aliuid', + 'type' => 'integer', + 'format' => 'int64', + ], + 'payerId' => [ + 'title' => '支付者ID（aliuid）', + 'type' => 'integer', + 'format' => 'int64', + ], + 'bid' => [ + 'title' => 'bid', + 'type' => 'string', + ], + 'requestId' => [ + 'title' => '选填。用于全程跟踪请求用途', + 'type' => 'string', + ], + 'token' => [ + 'title' => '选填。用于幂等性校验，客户端设置', + 'type' => 'string', + ], + 'fromApp' => [ + 'title' => '必须。调用方应用名', + 'type' => 'string', + ], + 'skipChannel' => [ + 'title' => '必须。渠道是否跳过调用', + 'type' => 'boolean', + ], + 'createrNick' => [ + 'title' => '选填。 如果是后台小二创建的订单，则设置此参数', + 'type' => 'string', + ], + 'memo' => [ + 'title' => '选填。订单备注', + 'type' => 'string', + ], + 'agentId' => [ + 'title' => '选填。订购来源(如阿里妈妈alimama_cps)', + 'type' => 'string', + ], + 'commodities' => [ + 'title' => '必填。 购买的商品对象列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CssInstanceCommodity', + ], + ], + 'promotionCode' => [ + 'title' => '选填， 推荐码', + 'type' => 'string', + ], + 'planGroupId' => [ + 'title' => '套餐组id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'planId' => [ + 'title' => '套餐id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'planInstanceId' => [ + 'title' => '套餐实例id, 由套餐driver为套餐购买生成的实例id', + 'type' => 'string', + ], + 'cssAuthRequestParam' => [ + 'title' => '选填，鉴权参数', + 'type' => 'any', + ], + 'language' => [ + 'title' => '选填，语言', + 'type' => 'string', + ], + 'promotionInputParam' => [ + 'title' => '调用者传入的优惠可选项', + 'type' => 'any', + ], + 'orderOrigin' => [ + 'title' => '订单来源（可选，可为null)', + 'type' => 'string', + ], + 'marketType' => [ + 'title' => '相关判断 用这个Long型的', + 'type' => 'integer', + 'format' => 'int64', + ], + 'umidToken' => [ + 'title' => 'umidToken 选填', + 'type' => 'string', + ], + 'cilentIp' => [ + 'title' => '客户 IP，选填', + 'type' => 'string', + ], + 'orderParams' => [ + 'title' => '选填。公共的订购参数', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'autoPay' => [ + 'title' => '订单是否自动支付，默认不自动支付', + 'type' => 'boolean', + ], + 'autoUseCoupon' => [ + 'title' => '自动支付的时候，是否自动使用代金券', + 'type' => 'boolean', + ], + 'transientAccess' => [ + 'title' => '临时 AK', + 'type' => 'any', + ], + 'certificate' => [ + 'title' => 'receipt', + 'type' => 'string', + ], + ], + ], + 'CssInstanceCommodity' => [ + 'title' => '购买的商品对象', + 'description' => '购买的商品对象', + 'type' => 'object', + 'properties' => [ + 'planItemId' => [ + 'title' => '选填。如果是套餐订单，套餐项id必填', + 'type' => 'integer', + 'format' => 'int64', + ], + 'commodityCode' => [ + 'title' => '必填。商品code', + 'type' => 'string', + 'required' => false, + ], + 'specCode' => [ + 'title' => '必填。规格code 阿里云官网商品,commodityCode与specCode相同。 云市场及镜像市场的商品,commodityCode与specCode不同。', + 'type' => 'string', + 'required' => false, + ], + 'duration' => [ + 'title' => '必填。订购的周期数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + 'pricingCycle' => [ + 'title' => '必填。订购的周期单位,年：Year，月：Month，日：Day，时：Hour', + 'type' => 'string', + 'required' => false, + ], + 'quantity' => [ + 'title' => '必填，订购实例数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + 'orderType' => [ + 'title' => '新购 :BUY,续费:RENEW,升级:UPGRADE,试用:TRIAL', + 'type' => 'string', + ], + 'chargeType' => [ + 'title' => '必填。付费类型：预付费:PREPAY-，后付费:POSTPAY', + 'type' => 'string', + ], + 'refundSpecCode' => [ + 'title' => '选填。需要退款的商品CODE，目前用于增量带宽和转换订单的退订;', + 'type' => 'string', + ], + 'components' => [ + 'title' => '必填。订购模块集合', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CssInstanceComponent', + ], + ], + 'orderParams' => [ + 'title' => '选填。订购参数(需要订单系统透传的参数)', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'instanceId' => [ + 'title' => '必填。实例ID，新购，续费，升级类型订单必填,格式为：JSON.toJSONString(List instanceIds)', + 'type' => 'string', + ], + 'activityId' => [ + 'title' => '选填。 购买对象参与的活动id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'isFree' => [ + 'title' => '选填。是否免费，默认不免费 (如试用和补偿续费订单)', + 'type' => 'boolean', + ], + 'isSyncToSubscription' => [ + 'title' => '选填。是否同步转订购，默认异步', + 'type' => 'boolean', + ], + 'isPrePayPostCharge' => [ + 'title' => '选填。是否预付费后付款订单，默认不是', + 'type' => 'boolean', + ], + 'isRenewChange' => [ + 'title' => '选填。是否续费变配订单，默认不是。', + 'type' => 'boolean', + ], + 'specifyStartDate' => [ + 'title' => '选填。指定开始时间,单位：ms。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'specUpgradeOriginSpecCodes' => [ + 'title' => '跨规格升级 原规格Code列表（一个新购，一个续费变配，，这个时候来跨规格升级就需要是一个list', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'upgradeInquireFinancialValue' => [ + 'title' => '升级是否询剩余财务价值（true：调用汇金取剩余财务价值，false：询差价）默认询财务价值', + 'type' => 'boolean', + ], + 'aliyunProduceCode' => [ + 'title' => '阿里云生产标识', + 'type' => 'string', + ], + 'redeemOrderType' => [ + 'title' => '提货券订单类型，提货券订单传入，默认为', + 'type' => 'string', + ], + 'redeemNoList' => [ + 'title' => '提货券券号列表，用于在新购和兑换的时候传入对应的提货券', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'CssInstanceComponent' => [ + 'title' => '订购模块', + 'description' => '订购模块', + 'type' => 'object', + 'properties' => [ + 'componentCode' => [ + 'title' => '配件 code', + 'type' => 'string', + ], + 'componentName' => [ + 'title' => '配件名称', + 'type' => 'string', + ], + 'globalKey' => [ + 'title' => '多语言key 根据统一的规则生成', + 'type' => 'string', + ], + 'tag' => [ + 'title' => '标记，必填。磁盘ID，新购，续费，升级类型订单必填,格式为：JSON.toJSONString(List tags) 并严格按照instanceId的顺序填写。', + 'type' => 'string', + ], + 'instanceProperty' => [ + 'title' => '模块属性信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CssInstanceProperty', + ], + ], + 'moduleAttrStatus' => [ + 'title' => '表达此次配件的状态， 1:新增，2:变更，3:无变化; 请严格参照此状态进行赋值', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'CssInstanceProperty' => [ + 'title' => '模块属性', + 'description' => '模块属性', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '属性名称', + 'type' => 'string', + ], + 'code' => [ + 'title' => '属性代码', + 'type' => 'string', + ], + 'value' => [ + 'title' => '属性值', + 'type' => 'string', + ], + 'unit' => [ + 'title' => '单位', + 'type' => 'string', + ], + 'globalKey' => [ + 'title' => '多语言翻译的key', + 'type' => 'string', + ], + ], + ], + 'CssProduce' => [ + 'title' => '下单回调', + 'description' => 'common buy 下单回调', + 'type' => 'object', + 'properties' => [ + 'buyerId' => [ + 'title' => '购买用户ID（aliuid', + 'type' => 'integer', + 'format' => 'int64', + ], + 'childId' => [ + 'title' => '子用户ID（childid）', + 'type' => 'integer', + 'format' => 'int64', + ], + 'userId' => [ + 'title' => '使用者ID（aliuid', + 'type' => 'integer', + 'format' => 'int64', + ], + 'payerId' => [ + 'title' => '支付者ID（aliuid）', + 'type' => 'integer', + 'format' => 'int64', + ], + 'bid' => [ + 'title' => 'bid', + 'type' => 'string', + ], + 'requestId' => [ + 'title' => '选填。用于全程跟踪请求用途', + 'type' => 'string', + ], + 'token' => [ + 'title' => '选填。用于幂等性校验，客户端设置', + 'type' => 'string', + ], + 'fromApp' => [ + 'title' => '必须。调用方应用名', + 'type' => 'string', + ], + 'skipChannel' => [ + 'title' => '必须。渠道是否跳过调用', + 'type' => 'boolean', + ], + 'orderId' => [ + 'title' => '订单号', + 'type' => 'integer', + 'format' => 'int64', + ], + 'purchases' => [ + 'title' => '商品列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CssPurchase', + ], + ], + ], + ], + 'CssPurchase' => [ + 'title' => '商品', + 'description' => '商品', + 'type' => 'object', + 'properties' => [ + 'commodityCode' => [ + 'title' => '商品code', + 'type' => 'string', + ], + 'chargeType' => [ + 'title' => '付费类型：预付费:PREPAY-，后付费:POSTPAY', + 'type' => 'string', + ], + 'startDate' => [ + 'title' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'endDate' => [ + 'title' => '过期时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'gmtCreate' => [ + 'title' => 'xxx', + 'type' => 'integer', + 'format' => 'int64', + ], + 'instanceComponents' => [ + 'title' => '订购模块集合', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CssInstanceComponent', + ], + ], + 'purchaseParams' => [ + 'title' => '参数', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'instanceId' => [ + 'title' => '必填。实例ID，新购，续费，升级类型订单必填,格式为：JSON.toJSONString(List instanceIds);', + 'type' => 'string', + ], + 'orderType' => [ + 'title' => '新购 :BUY,续费:RENEW,升级:UPGRADE,试用:TRIAL', + 'type' => 'string', + ], + ], + ], + 'CustomSideLinkConfig' => [ + 'title' => 'CustomSideLinkConfig', + 'type' => 'object', + 'properties' => [ + 'icon' => [ + 'title' => 'icon', + 'type' => 'string', + ], + 'text' => [ + 'title' => 'text', + 'type' => 'string', + ], + 'link' => [ + 'title' => 'link', + 'type' => 'string', + ], + ], + ], + 'DataBoxPrivileges' => [ + 'title' => 'A short description of struct', + 'description' => 'DataBoxPrivileges', + 'type' => 'object', + 'properties' => [ + 'feature_id' => [ + 'title' => '特性id', + 'type' => 'string', + ], + 'feature_attr_id' => [ + 'title' => '特性属性id', + 'type' => 'string', + ], + 'quota' => [ + 'title' => '配额', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'DataCName' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'location' => [ + 'title' => 'location', + 'type' => 'string', + ], + 'store_id' => [ + 'title' => '存储id', + 'type' => 'string', + ], + 'cname' => [ + 'title' => 'cname', + 'type' => 'string', + ], + 'cert_name' => [ + 'title' => 'cert_name', + 'type' => 'string', + ], + 'cert_expire_time' => [ + 'title' => 'cert_expire_time', + 'type' => 'integer', + 'format' => 'int64', + ], + 'cname_type' => [ + 'title' => 'cname_type', + 'type' => 'string', + ], + ], + ], + 'Domain' => [ + 'title' => 'domain 信息', + 'description' => '基础 domain 信息', + 'type' => 'object', + 'properties' => [ + 'parent_domain_id' => [ + 'title' => 'parent_domain_id string 父 domain id，如果存在，表示该 domain为子 domain domain_id string domain id', + 'description' => '父 domain ID，如果存在，表示子 domain，否则表示普通 domain', + 'type' => 'string', + 'example' => 'bj1', + ], + 'domain_id' => [ + 'title' => 'domain id', + 'description' => 'domain ID', + 'type' => 'string', + 'example' => 'bj2', + ], + 'domain_name' => [ + 'title' => '域名称', + 'description' => 'domain 名称', + 'type' => 'string', + 'example' => 'pdsdomain', + ], + 'description' => [ + 'title' => '描述', + 'description' => 'domain 描述', + 'type' => 'string', + 'example' => 'my domain', + ], + 'init_drive_enable' => [ + 'title' => '否开通默认网盘。为true则所有用户在第一次登录后都默认分配一个网盘。默认false', + 'description' => '否开通默认网盘。为true则所有用户在第一次登录后都默认分配一个网盘。默认false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'init_drive_size' => [ + 'title' => 'init_drive_enable==true时必选。 默认网盘的大小, 单位：Bytes。为0则表示不限大小。默认为0', + 'description' => 'init\\_drive\\_enable 为true时必选。 创建用户时，默认网盘的大小，单位：Bytes。'."\n" + .'默认为 0，此时创建的 drive 大小为0，不可以上传文件，如果需要初始化 drive， 请设置该值。'."\n" + .'-1则表示不限大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1073741824', + ], + 'updated_at' => [ + 'title' => '最后修改时间，ISO格式，如: 2019-04-08T07:05:18.825Z', + 'description' => '最后修改时间，ISO格式，如: 2019-04-08T07:05:18.825Z', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'created_at' => [ + 'title' => '创建时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'description' => '创建时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'size_quota' => [ + 'title' => '容量配额', + 'description' => '容量配额，表示 domain 下所有 drive 的总quota 大小，0 表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1099511627776', + ], + 'size_quota_used' => [ + 'title' => '容量配额使用空间', + 'description' => '所有 drive 的 quota 容量配额使用空间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1099511627776', + ], + 'user_count_quota' => [ + 'title' => '用户数配额', + 'description' => '用户数配额', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'status' => [ + 'title' => 'domain状态：创建中，正常，已过期', + 'description' => 'domain状态：'."\n" + .'1：正常'."\n" + .'2：创建中'."\n" + .'6：已过期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'used_size' => [ + 'title' => '逻辑空间使用量，单位为字节', + 'description' => '逻辑空间使用量，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1099511627776', + ], + 'published_app_access_strategy' => [ + 'title' => 'App 访问策略', + 'description' => 'App 访问策略', + '$ref' => '#/components/schemas/AppAccessStrategy', + ], + 'sharable' => [ + 'title' => '是否开启共享', + 'description' => '是否开启共享', + 'type' => 'boolean', + ], + 'data_hash_name' => [ + 'title' => 'domain hash type', + 'description' => '表示计算数据哈希值的方法名称。', + 'type' => 'string', + 'example' => 'sha1', + ], + 'store_redundancy_type' => [ + 'title' => '存储冗余类型。本地冗余：LRS；同城冗余：ZRS', + 'description' => '存储冗余类型。本地冗余：LRS；同城冗余：ZRS', + 'type' => 'string', + 'example' => 'LRS', + ], + 'system_drive_config' => [ + '$ref' => '#/components/schemas/SystemDriveConfig', + ], + ], + ], + 'DomainAppConfig' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'same_name_file_upload_mode' => [ + 'title' => 'same_name_file_upload_mode', + 'type' => 'string', + ], + 'web_client_download_mode' => [ + 'title' => 'web_client_download_mode', + 'type' => 'string', + ], + 'single_file_upload_size_limit' => [ + 'title' => 'single_file_upload_size_limit', + 'type' => 'integer', + 'format' => 'int64', + ], + 'allow_upload_file_category_list' => [ + 'title' => 'allow_upload_file_category_list', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'allow_upload_custom_file_ext_list' => [ + 'title' => 'allow_upload_custom_file_ext_list', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'DomainBuildClientConfig' => [ + 'title' => 'DomainBuildClient', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'copyright' => [ + 'title' => 'copyright', + 'type' => 'string', + ], + ], + ], + 'DomainEndpoints' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [], + ], + 'DomainSeniorConfig' => [ + 'title' => 'DomainSeniorConfig', + 'type' => 'object', + 'properties' => [ + 'home_page_bg_image_url' => [ + 'title' => 'home_page_bg_image_url', + 'type' => 'string', + ], + 'home_page_slogan' => [ + 'title' => 'home_page_slogan', + 'type' => 'string', + ], + 'home_page_footer' => [ + 'title' => 'home_page_footer', + 'type' => 'string', + ], + 'home_page_footer2' => [ + 'title' => 'home_page_footer2', + 'type' => 'string', + ], + 'csp_frame_ancestors' => [ + 'title' => 'csp_frame_ancestors', + 'type' => 'string', + ], + 'referer_enable' => [ + 'title' => 'referer_enable', + 'type' => 'boolean', + ], + 'wx_txt_list' => [ + '$ref' => '#/components/schemas/WxTrustedDomainConfig', + ], + 'custom_login_appid' => [ + 'title' => 'custom_login_appid', + 'type' => 'string', + ], + 'custom_login_url' => [ + 'title' => 'custom_login_url', + 'type' => 'string', + ], + 'custom_logout_url' => [ + 'title' => 'custom_logout_url', + 'type' => 'string', + ], + 'custom_side_link_list' => [ + 'title' => 'custom_side_link_list', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CustomSideLinkConfig', + ], + ], + 'client_download_enable' => [ + 'title' => 'client_download_enable', + 'type' => 'boolean', + ], + ], + ], + 'Drive' => [ + 'title' => 'A short description of struct', + 'description' => '空间', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'title' => '空间id', + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'drive_name' => [ + 'title' => '空间名称', + 'description' => '空间名称', + 'type' => 'string', + 'example' => 'drv1', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vipdrive', + ], + 'owner' => [ + 'title' => '归属者', + 'description' => '归属者', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'owner_type' => [ + 'title' => '归属者类型', + 'description' => '归属者类型', + 'type' => 'string', + 'example' => 'user', + ], + 'drive_type' => [ + 'title' => '空间类型', + 'description' => '空间类型', + 'type' => 'string', + 'example' => 'normal', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态'."\n" + ."\n" + .'1. enabled 表示该空间可使用'."\n" + .'2. disabled 表示该空间不可用', + 'type' => 'string', + 'example' => 'enabled', + ], + 'used_size' => [ + 'title' => '使用空间大小', + 'description' => '使用空间大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20480', + ], + 'total_size' => [ + 'title' => '总空间大小', + 'description' => '总空间大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '204800', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + ], + 'DriveLogDetail' => [ + 'title' => 'drive日志详情', + 'description' => 'drive日志详情', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'total_size' => [ + 'title' => '总大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'owner_id' => [ + 'title' => '归属人id', + 'type' => 'string', + ], + 'owner_name' => [ + 'title' => '归属人的名称', + 'type' => 'string', + ], + 'owner_type' => [ + 'title' => '归属人的类别', + 'type' => 'string', + ], + 'update_to' => [ + 'title' => '更新后的设置', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'total_size' => [ + 'title' => '总大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'owner_id' => [ + 'title' => '归属人id', + 'type' => 'string', + ], + 'owner_name' => [ + 'title' => '归属人的名称', + 'type' => 'string', + ], + 'owner_type' => [ + 'title' => '归属人的类别', + 'type' => 'string', + ], + ], + ], + 'force_delete' => [ + 'title' => '是否强制删除', + 'type' => 'boolean', + ], + 'handover_owner_name' => [ + 'title' => '交接人的名称', + 'type' => 'string', + ], + ], + ], + 'ExternalMultiFileRevisionConfig' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'revision_merge_enabled' => [ + 'title' => 'revision_merge_enabled', + 'type' => 'boolean', + ], + 'revision_count' => [ + 'title' => 'revision_count', + 'type' => 'integer', + 'format' => 'int64', + ], + 'revision_recycle_period' => [ + 'title' => 'revision_recycle_period', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'FaceGroup' => [ + 'title' => '人脸分组', + 'description' => '人脸分组', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'title' => '人脸分组ID', + 'description' => '人脸分组ID', + 'type' => 'string', + 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', + ], + 'group_name' => [ + 'title' => '人脸分组名称', + 'description' => '人脸分组名称', + 'type' => 'string', + 'example' => 'name', + ], + 'image_count' => [ + 'title' => '照片数量', + 'description' => '人脸分组内照片数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'created_at' => [ + 'title' => '人脸分组生成时间。格式 RFC3339', + 'description' => '人脸分组生成时间', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + ], + 'updated_at' => [ + 'title' => '人脸分组修改时间。格式 RFC3339', + 'description' => '人脸分组修改时间', + 'type' => 'string', + 'example' => '2022-01-14T10:10:52.83948013+08:00', + ], + 'group_cover_url' => [ + 'title' => '人脸分组封面头像地址', + 'description' => '人脸分组封面头像地址', + 'type' => 'string', + 'example' => 'https://xxx', + ], + 'group_cover_file_id' => [ + 'title' => '人脸分组封面文件ID', + 'description' => '人脸分组封面文件ID', + 'type' => 'string', + 'example' => '6549c959640fbd517c9b4d93b3b36aecc45xxxxx', + ], + 'group_cover_width' => [ + 'title' => '人脸分组封面图片宽', + 'description' => '人脸分组封面图片宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'group_cover_height' => [ + 'title' => '人脸分组封面图片高', + 'description' => '人脸分组封面图片高', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'group_cover_face_boundary' => [ + 'title' => '人脸分组封面图片边框', + 'description' => '人脸分组封面图片边框', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '宽，单位像素', + 'description' => '宽，单位像素', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Height' => [ + 'title' => '高， 单位像素', + 'description' => '高， 单位像素', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Top' => [ + 'title' => '距离照片顶部的距离，单位像素', + 'description' => '距离照片顶部的距离，单位像素', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Left' => [ + 'title' => '距离照片左边框的距离，单位像素', + 'description' => '距离照片左边框的距离，单位像素', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'remarks' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + ], + ], + ], + 'FaceThumbnail' => [ + 'title' => '人脸缩略图信息。仅开启增值服务图片处理功能有效。', + 'description' => '人脸缩略图信息。仅开启增值服务图片处理功能有效。', + 'type' => 'object', + 'properties' => [ + 'face_id' => [ + 'title' => '人脸 id。', + 'description' => '人脸 id。', + 'type' => 'string', + 'example' => 'a9a66a86-73dd-4c95-8b79-1d8a49db5226', + ], + 'face_group_id' => [ + 'title' => '人脸所属分组 id。', + 'description' => '人脸所属分组 id。'."\n" + ."\n" + .'包含如下特定 id：'."\n" + ."\n" + .'- figure-cluster-id-independent：该人脸暂无合适的分组，后续在数据集中新增图片后进行人脸聚类操作时，该人脸可能被分入组中。'."\n" + ."\n" + .'- figure-cluster-id-unavailable：该人脸暂未进行过聚类操作，即在数据集中新增图片后，未进行人脸聚类。', + 'type' => 'string', + 'example' => 'Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0', + ], + 'face_thumbnail' => [ + 'title' => '人脸缩略图。', + 'description' => '人脸缩略图。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2', + ], + ], + ], + 'File' => [ + 'title' => 'file 详情', + 'description' => '文件', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'title' => '空间id', + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id', + 'type' => 'string', + 'example' => '5d79206586bb5dd69fb34c349282718146c55da7', + ], + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => '1.mov', + ], + 'type' => [ + 'title' => '类型', + 'description' => '类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'file' => '文件', + 'folder' => '文件夹', + ], + 'example' => 'file', + ], + 'content_type' => [ + 'title' => '内容类型', + 'description' => '内容类型', + 'type' => 'string', + 'example' => 'application/json', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'image file', + ], + 'trashed_at' => [ + 'title' => '放入回收站时间', + 'description' => '放入回收站时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'file_extension' => [ + 'title' => '文件扩展', + 'description' => '文件扩展名', + 'type' => 'string', + 'example' => 'txt', + ], + 'hidden' => [ + 'title' => '是否隐藏', + 'description' => '是否隐藏', + 'type' => 'boolean', + 'example' => 'false', + ], + 'size' => [ + 'title' => '大小', + 'description' => '如果是文件，表示文件大小'."\n" + ."\n" + .'如果是文件夹，表示文件夹的大小（递归计算所有子孙文件的大小）'."\n" + .'备注：文件夹大小只有在 list file，get file 时设置 fields 包含 dir_size 时才会返回', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'starred' => [ + 'title' => '是否收藏', + 'description' => '是否收藏', + 'type' => 'boolean', + 'example' => 'false', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态，只有available的文件和目录才是可以被访问的，如果文件处于uploading状态，GetFile会返回文件不存在, ListFile也不会返回uploading状态的文件', + 'type' => 'string', + 'enumValueTitles' => [ + 'available' => 'available', + 'uploading' => 'uploading', + ], + 'example' => 'available', + ], + 'labels' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'string', + 'example' => '["label1:1", "label2:2"]', + ], + 'example' => '["label1:1", "label2:2"]', + ], + 'upload_id' => [ + 'title' => '上传id', + 'description' => '上传id', + 'type' => 'string', + 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6', + ], + 'parent_file_id' => [ + 'title' => '父文件夹id', + 'description' => '父文件夹id', + 'type' => 'string', + 'example' => '3d5b846942cf94fa72324c8a4bda34e81da635a', + ], + 'crc64_hash' => [ + 'title' => 'crc64', + 'description' => 'crc64', + 'type' => 'string', + 'example' => '3574582125365864471', + ], + 'content_hash' => [ + 'title' => '内容hash', + 'description' => '内容hash', + 'type' => 'string', + 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3', + ], + 'content_hash_name' => [ + 'title' => '内容hash算法名', + 'description' => '内容hash算法名，当前hash 算法支持sha1', + 'type' => 'string', + 'enumValueTitles' => [ + 'sha1' => 'sha1', + ], + 'example' => 'sha1', + ], + 'download_url' => [ + 'title' => '下载链接', + 'description' => '下载链接， 下载链接默认有效期是 15 分钟，如果URL过期，可以通过 GetFile 进行获取', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'description' => '缩略图地址（已废弃，推荐使用thumbnail\\_urls）', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + 'category' => [ + 'title' => '分类', + 'description' => '分类， pds 会根据文件的后缀名和 mime-type 对文件进行分类，主要分类有 doc, image, audio, video', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => 'image', + 'doc' => 'doc', + 'audio' => 'audio', + 'video' => 'video', + ], + 'example' => 'image', + ], + 'local_created_at' => [ + 'title' => '文件本地创建时间', + 'description' => '文件本地创建时间, 本地创建时间是指文件在上传时刻的本地时间，主要帮助客户端识别本地上传时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'local_modified_at' => [ + 'title' => '文件本地修改时间', + 'description' => '文件本地修改时间，文件本地更新时间, 本地更新时间是指文件在上传时刻的本地时间，主要帮助客户端识别本地更新时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'revision_id' => [ + 'title' => '版本id', + 'description' => '版本id， 当相同file-id 文件覆盖上传时， 会有新的revision_id 产生', + 'type' => 'string', + 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', + ], + 'thumbnail_urls' => [ + 'title' => '返回的缩略图信息', + 'description' => '返回的缩略图信息，与入参thumbnail\\_processes中传入的key对应。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '返回的缩略图信息，与入参thumbnail\\_processes中传入的key对应。', + 'type' => 'string', + 'required' => false, + 'example' => '"128X128": "https://url1", "800X800": "url2"', + ], + ], + 'image_media_metadata' => [ + 'title' => '图片信息。仅开启增值服务图片处理功能有效。', + 'description' => '图片信息。仅开启增值服务图片处理功能有效。', + '$ref' => '#/components/schemas/ImageMediaMetadata', + ], + 'user_tags' => [ + 'title' => '用户自定义标签', + 'description' => '用户自定义标签', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '用户自定义标签', + 'type' => 'string', + 'example' => '"k1":"v1", "k2","v2"', + ], + ], + 'video_media_metadata' => [ + 'title' => '音视频信息', + 'description' => '音视频信息', + '$ref' => '#/components/schemas/VideoMediaMetadata', + ], + 'id_path' => [ + 'title' => '文件id路径', + 'description' => '文件id路径', + 'type' => 'string', + 'required' => false, + 'example' => 'id1/id2', + ], + 'name_path' => [ + 'title' => '文件路径', + 'description' => '文件路径', + 'type' => 'string', + 'example' => 'root/f1/f2', + ], + 'dir_size_info' => [ + 'title' => '目录计量信息', + 'description' => 'list file，get file 时，如果 fields 设置了 dir_size，那么该字段会返回，表示文件夹的统计信息', + 'type' => 'object', + 'properties' => [ + 'dir_count' => [ + 'title' => '文件夹数量', + 'description' => '该文件夹下所有子孙文件夹数量，递归计算。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'file_count' => [ + 'title' => '文件数量', + 'description' => '该文件夹下所有子孙文件数量，递归计算。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'action_list' => [ + 'title' => '权限列表', + 'description' => '权限列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'auto_delete_left_sec' => [ + 'title' => '回收站文件自动删除剩余时间', + 'description' => '回收站文件自动删除剩余时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'FileDownloadCallbackInfo' => [ + 'title' => '文件下载回调', + 'description' => '文件下载回调', + 'type' => 'object', + 'properties' => [ + 'bucket' => [ + 'title' => 'bucket名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ccp-bj1-bj-1234', + ], + 'object' => [ + 'title' => 'oss key', + 'type' => 'string', + 'required' => true, + ], + 'httpHeader.range' => [ + 'title' => '下载范围', + 'type' => 'string', + 'example' => 'bytes=0-1024', + ], + 'domain_id' => [ + 'title' => 'domain id', + 'type' => 'string', + 'required' => true, + ], + 'user_id' => [ + 'title' => '用户id', + 'type' => 'string', + 'required' => true, + ], + 'drive_id' => [ + 'title' => 'drive id', + 'type' => 'string', + 'required' => true, + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + 'required' => true, + ], + ], + 'required' => false, + ], + 'FileIDInfo' => [ + 'title' => 'FileIDInfo', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => 'drive_id', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => 'file_id', + 'type' => 'string', + ], + 'type' => [ + 'title' => 'type', + 'type' => 'string', + ], + ], + ], + 'FileLogDetail' => [ + 'title' => '文件日志详情', + 'description' => '文件日志详情', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'parent_path' => [ + 'title' => '父目录路径', + 'type' => 'string', + ], + 'new_name' => [ + 'title' => '新文件名', + 'type' => 'string', + ], + 'to_parent_path_type' => [ + 'title' => '目标目录类型', + 'type' => 'string', + ], + 'to_parent_path' => [ + 'title' => '目标目录路径', + 'type' => 'string', + ], + 'size' => [ + 'title' => '大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'decompress_file_list' => [ + 'title' => '解压文件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '解压文件', + ], + ], + 'rev_version' => [ + 'title' => '文件版本', + 'type' => 'integer', + 'format' => 'int64', + ], + 'revision_id' => [ + 'title' => '版本id', + 'type' => 'string', + ], + ], + ], + 'FilePermissionMember' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'title' => '授权对象', + 'description' => '被授权对象，可以是用户或群组', + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'title' => '授予的角色ID', + 'description' => '目前支持两种方式设置权限，一种是通过指定角色设置权限，另一种是自定义操作权限，此字段用于指定角色设置权限，与action\\_list互斥，当两个字段同时设置时，以此字段为准'."\n" + ."\n" + .'目前支持：'."\n" + ."\n" + .'SystemFileOwner（文件协同）'."\n" + ."\n" + .'SystemFileDownloader（下载者）'."\n" + ."\n" + .'SystemFileEditor（编辑者）'."\n" + ."\n" + .'SystemFileEditorWithoutDelete（无删除编辑者）'."\n" + ."\n" + .'SystemFileEditorWithoutShareLink（无分享编辑者）'."\n" + ."\n" + .'SystemFileMetaViewer（可见列表）'."\n" + ."\n" + .'SystemFileUploader（上传者）、SystemFileUploaderAndDownloader（上传/下载者）'."\n" + ."\n" + .'SystemFileDownloaderWithShareLink（下载/分享者）'."\n" + ."\n" + .'SystemFileUploaderAndDownloaderWithShareLink（上传/下载/分享者）'."\n" + ."\n" + .'SystemFileUploaderAndViewer（预览/上传者）'."\n" + ."\n" + .'SystemFileUploaderWithShareLink（上传/分享者）'."\n" + ."\n" + .'SystemFileViewer（预览者）', + 'type' => 'string', + 'example' => 'SystemFileDownloader', + ], + 'expire_time' => [ + 'title' => '过期时间', + 'description' => '此授权过期的时间， 从1970年1月1日0点到目标时间的毫秒数， 永久有效可以设置为系统预定义的一个值：4775500800000', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1633598085642', + ], + 'disinherit_sub_group' => [ + 'title' => '是否禁用子用户组继承此权限', + 'description' => '是否禁用子群组下的用户继承此权限，举个例子，比如有/group1/group2， user1在group1下， user2在group2下。给group1授权时，此字段设置为true，则只有user1有权限，user2没有权限', + 'type' => 'boolean', + 'example' => 'false', + ], + 'action_list' => [ + 'title' => '授予的操作权限列表', + 'description' => '目前支持两种方式设置权限，一种是通过指定角色设置权限，另一种是自定义操作权限，此字段用于自定义操作权限，与role\\_id互斥，当两个字段同时设置时，以role\\_id字段为准，设置action\\_list字段时系统会自动生成一个临时role\\_id，取消授权可以通过临时role\\_id来取消', + 'type' => 'array', + 'items' => [ + 'description' => "\n" + .'自定义操作权限：'."\n" + .'- FILE.VISIBLE: 可见'."\n" + .'- FILE.PREVIEW: 可预览'."\n" + .'- FILE.MOVE: 可移动'."\n" + .'- FILE.DELETE: 可删除'."\n" + .'- FILE.COPY: 可复制'."\n" + .'- FILE.CREATE: 可创建'."\n" + .'- FILE.DOWNLOAD: 可下载'."\n" + .'- FILE.SHARELINK: 可分享'."\n" + .'- FILE.UPDATE: 可更新'."\n" + .'- FILE.LIST: 可列举', + 'type' => 'string', + 'example' => 'FILE.CREATE', + ], + 'required' => false, + ], + ], + ], + 'FileStreamInfo' => [ + 'title' => 'A short description of struct', + 'description' => '文件流信息', + 'type' => 'object', + 'properties' => [ + 'size' => [ + 'title' => '大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'content_hash' => [ + 'title' => '内容hash', + 'type' => 'string', + ], + 'content_hash_name' => [ + 'title' => '内容hash名', + 'type' => 'string', + ], + 'proof_code' => [ + 'title' => '挑战码', + 'type' => 'string', + ], + 'proof_version' => [ + 'title' => '挑战算法版本', + 'type' => 'string', + ], + 'pre_hash' => [ + 'title' => '预秒传', + 'type' => 'string', + ], + 'content_md5' => [ + 'title' => '内容md5', + 'type' => 'string', + ], + 'part_info_list' => [ + 'title' => '分段信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/UploadPartInfo', + ], + ], + ], + ], + 'FileTaskResultResponse' => [ + 'title' => 'FileTaskResultResponse', + 'type' => 'object', + 'properties' => [ + 'src_file' => [ + 'title' => 'src file', + '$ref' => '#/components/schemas/FileIDInfo', + ], + 'rst_file' => [ + 'title' => 'rst_file', + '$ref' => '#/components/schemas/FileIDInfo', + ], + 'err_code' => [ + 'title' => 'err_code', + 'type' => 'string', + ], + 'message' => [ + 'title' => 'message', + 'type' => 'string', + ], + ], + ], + 'GetOfficeEditUrlOption' => [ + 'title' => 'A short description of struct', + 'description' => '文档编辑选项', + 'type' => 'object', + 'properties' => [ + 'copy' => [ + 'title' => '是否允许复制内容，不传递该参数默认允许复制', + 'type' => 'boolean', + ], + 'readonly' => [ + 'title' => '预览模式，不传递该参数默认是预览模式', + 'type' => 'boolean', + ], + 'print' => [ + 'title' => '是否允许打印内容，不传递该参数默认禁止打印', + 'type' => 'boolean', + ], + ], + ], + 'GetOfficeEditUrlWatermark' => [ + 'title' => 'A short description of struct', + 'description' => '在线编辑水印配置', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '水印类型。0：无水印，1：文字水印。', + 'type' => 'integer', + 'format' => 'int32', + ], + 'value' => [ + 'title' => '文字水印的文字。当WatermarkType设置为1时，才能设置此参数', + 'type' => 'string', + ], + 'fillstyle' => [ + 'title' => '文字水印的透明度，默认值为rgba(192,192,192,0.6)。', + 'type' => 'string', + ], + 'font' => [ + 'title' => '文字水印的字体，默认值为bold 20px Serif', + 'type' => 'string', + ], + 'rotate' => [ + 'title' => '文字水印的旋转度，单位为弧度。', + 'type' => 'number', + 'format' => 'double', + ], + 'horizontal' => [ + 'title' => '文字水印水平间距，单位为px。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'vertical' => [ + 'title' => '文字水印垂直间距，单位为px。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'GetOfficePreviewUrlOption' => [ + 'title' => 'A short description of struct', + 'description' => '文档预览控制选项', + 'type' => 'object', + 'properties' => [ + 'copy' => [ + 'title' => '是否允许复制内容，不传递该参数默认允许复制', + 'type' => 'boolean', + ], + 'print' => [ + 'title' => '是否允许打印内容，不传递该参数默认禁止打印', + 'type' => 'boolean', + ], + ], + ], + 'Group' => [ + 'title' => 'A short description of struct', + 'description' => 'group', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域ID', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'group_id' => [ + 'title' => '用户组ID', + 'description' => '群组ID', + 'type' => 'string', + 'example' => 'b45c0c0c373c41ec9ebb5c85a025a08f', + ], + 'group_name' => [ + 'title' => '用户组名', + 'description' => '群组名称', + 'type' => 'string', + 'example' => 'test group', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'created by system', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间，从1970年1月1日0点到当前的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670573504600', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'description' => '更新时间，从1970年1月1日0点到当前的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670573504600', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者ID', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + ], + 'HotDriveFile' => [ + 'title' => '空间热门文件', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + 'example' => '666ff36c22278f023ec', + ], + 'revision_id' => [ + 'title' => '文件版本id', + 'type' => 'string', + 'example' => '666ff36c22278f023ec', + ], + 'name' => [ + 'title' => '文件名', + 'type' => 'string', + 'example' => 'a.jpg', + ], + 'category' => [ + 'title' => '文件类型', + 'type' => 'string', + 'example' => 'doc', + ], + 'action_count' => [ + 'title' => '操作次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'count_at' => [ + 'title' => '统计毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727059860000', + ], + 'action_list' => [ + 'title' => '空间文件权限列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'FILE.GET', + ], + ], + ], + ], + 'HotKnowledgeBaseFile' => [ + 'title' => '知识库热门文件', + 'description' => '热门知识库文件', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + 'example' => '666ff36c22278f023ec', + ], + 'revision_id' => [ + 'title' => '文件版本id', + 'type' => 'string', + 'example' => '666ff36c22278f023ec', + ], + 'knowledge_base_id' => [ + 'title' => '知识库id', + 'type' => 'string', + 'example' => '4jTsp3AgW', + ], + 'name' => [ + 'title' => '文件名', + 'type' => 'string', + 'example' => 'a.jpg', + ], + 'category' => [ + 'title' => '文件类型', + 'type' => 'string', + 'example' => 'image', + ], + 'action_count' => [ + 'title' => '操作次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'count_at' => [ + 'title' => '统计毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727578860000', + ], + 'action_list' => [ + 'title' => '知识库文件的权限列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'KNOWLEDGEBASEFILE.GET', + ], + ], + ], + ], + 'IDPermission' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'permission' => [ + '$ref' => '#/components/schemas/Permission', + ], + 'disinherit_sub_group' => [ + 'title' => 'DisinheritSubGroup', + 'type' => 'boolean', + ], + 'expire_time' => [ + 'title' => 'ExpireTime', + 'type' => 'integer', + 'format' => 'int64', + ], + 'roles' => [ + 'title' => 'Roles', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Identity' => [ + 'title' => 'A short description of struct', + 'description' => '可授权对象，表示一个用户或者一个群组', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'title' => '类型', + 'description' => '对象类型'."\n" + .'- IT_User：表示用户类型'."\n" + .'- IT_Group：表示群组类型', + 'type' => 'string', + 'example' => 'IT_User', + ], + 'identity_id' => [ + 'title' => 'ID', + 'description' => '用户ID或者群组ID', + 'type' => 'string', + 'example' => '16435bdf934248b788b7b3771ee9a3dw', + ], + ], + ], + 'IdentityToBenefitPkgMapping' => [ + 'title' => 'A short description of struct', + 'description' => '实体的权益包关联信息', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'title' => '实体的类型', + 'description' => '实体的类型', + 'type' => 'string', + 'example' => 'user', + ], + 'identity_id' => [ + 'title' => '实体的唯一标识', + 'description' => '实体的标识ID', + 'type' => 'string', + 'example' => 'user123', + ], + 'benefit_pkg_owner_id' => [ + 'title' => '权益包的所有者ID', + 'description' => '权益包的所有者ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'benefit_pkg_id' => [ + 'title' => '权益包的唯一标识', + 'description' => '权益包的标识ID', + 'type' => 'string', + 'example' => '40cb7794c9294', + ], + 'benefit_pkg_type' => [ + 'title' => '权益包的类型', + 'description' => '权益包的类型'."\n" + ."\n" + .'有效值：'."\n" + ."\n" + .'user_identity：用户等级权益包'."\n" + ."\n" + .'user_resource：用户资源权益包', + 'type' => 'string', + 'example' => 'user_identity', + ], + 'benefit_pkg_name' => [ + 'title' => '权益包的名称', + 'description' => '权益包的名称', + 'type' => 'string', + 'example' => '高级会员', + ], + 'benefit_pkg_priority' => [ + 'title' => '权益包的优先级', + 'description' => '权益包的优先级'."\n" + ."\n" + .'用户等级权益包返回的优先级，数字越小，优先级越高。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'benefit_pkg_computation_rule' => [ + 'title' => '权益包内权益的计算规则', + 'description' => '权益包内权益的计算规则'."\n" + ."\n" + .'用户等级权益包，返回为空，只根据优先级priority计算生效权益的quota。'."\n" + ."\n" + .'用户资源权益包，可以返回空值或非空值。返回非空时，该权益包用于追加计算其它权益包中已存在权益的配额，限于quota型权益。如：一个用户等级权益包中已经包含10G用户存储容量，可以再定义一个或多个用户资源权益包，用于给某些用户增加额外的存储容量。'."\n" + ."\n" + .'支持的追加计算规则包括：'."\n" + ."\n" + .'sum：多个权益包中有相同权益，进行累加'."\n" + ."\n" + .'max：多个权益包中有相同权益，取max值'."\n" + ."\n" + .'min：多个权益包中有相同权益，取min值', + 'type' => 'string', + 'example' => 'sum', + ], + 'delivery_info_list' => [ + 'title' => '权益包的下发信息', + 'description' => '权益包的下发信息列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/BenefitPkgDeliveryInfo', + ], + ], + 'created_at' => [ + 'title' => '实体权益包关联的创建时间', + 'description' => '实体和权益包关联的创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'updated_at' => [ + 'title' => '实体权益包关联的更新时间', + 'description' => '实体和权益包关联的更新时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + ], + ], + 'ImageMediaMetadata' => [ + 'title' => '图片信息。仅开启增值服务图片处理功能有效。', + 'description' => '图片元数据。仅当开启增值服务图片处理功能有效。', + 'type' => 'object', + 'properties' => [ + 'time' => [ + 'title' => '拍摄时间，RFC3339 格式。', + 'description' => '拍摄时间，RFC3339 格式。', + 'type' => 'string', + 'example' => '2006-01-02T15:04:05.000Z07:00', + ], + 'width' => [ + 'title' => '图片宽度，单位为像素（px）。', + 'description' => '宽度，单位为像素。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'height' => [ + 'title' => '图片高度，单位为像素（px）。', + 'description' => '高度，单位为像素。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'location' => [ + 'title' => 'GPS 经纬度信息。', + 'description' => '地理经纬度信息。', + 'type' => 'string', + 'example' => '30.185453,120.218522', + ], + 'country' => [ + 'title' => '国家或地区。', + 'description' => '国家或地区。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'China', + ], + 'province' => [ + 'title' => '省。', + 'description' => '省。', + 'type' => 'string', + 'example' => 'Zhejiang', + ], + 'city' => [ + 'title' => '城市。', + 'description' => '城市。', + 'type' => 'string', + 'example' => 'Hangzhou', + ], + 'district' => [ + 'title' => '区。', + 'description' => '区。', + 'type' => 'string', + 'example' => 'Xihu', + ], + 'township' => [ + 'title' => '街道。', + 'description' => '街道。', + 'type' => 'string', + 'example' => 'Xihu', + ], + 'address_line' => [ + 'title' => '完整地址。', + 'description' => '完整地址。', + 'type' => 'string', + 'example' => 'Zhejiang hangzhou xihu', + ], + 'image_tags' => [ + 'title' => '图片标签详情列表', + 'description' => '图片标签详情列表', + 'type' => 'array', + 'items' => [ + 'description' => '系统标签（该数据结构将于2025年2月20日起停止透出）', + '$ref' => '#/components/schemas/SystemTag', + ], + ], + 'faces_thumbnail' => [ + 'title' => '人脸缩略图列表。', + 'description' => '人脸缩略图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '人脸缩略图', + '$ref' => '#/components/schemas/FaceThumbnail', + ], + ], + 'exif' => [ + 'title' => '图片EXIF信息。', + 'description' => '图片EXIF信息。', + 'type' => 'string', + 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}', + ], + 'image_quality' => [ + 'title' => '图片评分信息。', + 'description' => '图片评分信息。', + '$ref' => '#/components/schemas/ImageQuality', + ], + ], + ], + 'ImageProcess' => [ + 'title' => 'A short description of struct', + 'description' => '图片处理规则', + 'type' => 'object', + 'properties' => [ + 'image_thumbnail_process' => [ + 'title' => '图片类型文件的缩略图规则', + 'description' => '图片类型文件的缩略图规则，参考OSS的图片处理规则。默认为：image/resize,m\\_fill,h\\_128,w\\_128,limit\\_0', + 'type' => 'string', + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', + ], + 'video_thumbnail_process' => [ + 'title' => '视频类型文件的缩略图规则', + 'description' => '视频类型文件的缩略图规则，参考OSS的视频截帧处理规则。默认为：video/snapshot,t\\_1000,f\\_jpg,w\\_0,h\\_0,m\\_fast,ar\\_auto', + 'type' => 'string', + 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', + ], + 'office_thumbnail_process' => [ + 'title' => '文档类型文件的缩略图规则', + 'description' => '文档类型文件的缩略图规则，文档类型的文件会选择文档中一页的截图作为原图，此参数是基于该截图来做处理。默认为：image/resize,m\\_fill,h\\_128,w\\_128,limit\\_0', + 'type' => 'string', + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', + ], + ], + ], + 'ImageQuality' => [ + 'title' => '图片评分详情。仅开启增值服务图片处理功能有效。', + 'description' => '图片评分详情。仅开启增值服务图片处理功能有效。', + 'type' => 'object', + 'properties' => [ + 'overall_score' => [ + 'title' => '图片整体质量评分。该评分为 AI 自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。 范围 0-1，越高则质量越好。', + 'description' => '图片整体质量评分。该评分为 AI 自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。 范围 0-1，评分越高则质量越好。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.736', + ], + ], + ], + 'ImageTag' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => '动物', + ], + 'count' => [ + 'title' => '数量', + 'description' => '分组内文件数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'cover_url' => [ + 'title' => '标签封面图片地址', + 'description' => '标签封面图片地址', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + 'cover_file_id' => [ + 'title' => '封面文件id', + 'description' => '封面文件id', + 'type' => 'string', + 'example' => '5d79206586bb5dd69fb34c349282718146c55da7', + ], + 'cover_file_category' => [ + 'title' => '封面文件分类', + 'description' => '封面文件分类', + 'type' => 'string', + 'example' => 'image', + ], + 'cover_tag_confidence' => [ + 'title' => '封面标签置信度。取值范围为 0（表示置信度最低）~1（表示置信度最高）。', + 'description' => '封面标签置信度', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'cover_overall_score' => [ + 'title' => '封面评分。该评分为 AI 自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。 范围 0-1，越高则质量越好。', + 'description' => '封面评分', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.736', + ], + ], + ], + 'Int64Range' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'from' => [ + 'title' => '起始', + 'type' => 'integer', + 'format' => 'int64', + ], + 'to' => [ + 'title' => '结束', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'InvestigationInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '审核状态', + 'description' => '审核状态', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '未审核', + '不支持审核', + '审核失败', + '审核中', + '审核成功', + '被处罚接口调用', + ], + 'example' => '4', + ], + 'suggestion' => [ + 'title' => '审核建议执行的操作', + 'description' => '审核建议执行的操作', + 'type' => 'string', + 'enumValueTitles' => [ + 'pass' => '结果正常', + 'block' => '结果违规，建议进行限制', + ], + 'example' => 'block', + ], + 'video_detail' => [ + 'title' => '视频审核信息', + 'description' => '视频审核信息', + 'type' => 'object', + 'properties' => [ + 'block_frames' => [ + 'title' => '违规帧信息', + 'description' => '违规帧信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'rate' => [ + 'title' => '置信度', + 'description' => '置信度。取值范围0～100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '99.1', + ], + 'offset' => [ + 'title' => '截帧距离片头的时间（秒）', + 'description' => '截帧距离片头的时间（秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'label' => [ + 'title' => '检测结果分类', + 'description' => '检测结果分类', + 'type' => 'string', + 'example' => 'porn', + ], + ], + ], + ], + ], + ], + ], + ], + 'JWTPayload' => [ + 'type' => 'object', + 'properties' => [ + 'auto_create' => [ + 'title' => '扩展字段，是否自动创建用户', + 'type' => 'boolean', + ], + 'sub_type' => [ + 'title' => '扩展字段，表示账号类型，目前支持填 user、service，此处填user，则sub为userID，签发普通用户accessToken。 此处填service，则sub为domainID，签发domain服务账号accessToken(超级管理员权限)', + 'type' => 'string', + ], + 'iss' => [ + 'title' => '控制台申请的JWT App ID', + 'type' => 'string', + ], + 'sub' => [ + 'title' => '待授权的UserID或者DomainID', + 'type' => 'string', + ], + 'aud' => [ + 'title' => 'DomainID', + 'type' => 'string', + ], + 'jti' => [ + 'title' => '应用生成JWT的唯一标识，长度16-128位，推荐使用uuid即可', + 'type' => 'string', + ], + 'exp' => [ + 'title' => 'JWT过期时间, Unix Time，单位秒，生效时间和过期时间不能超过15分钟。为防止客户端和服务器时间不一致，此时间建议设置为当前时间加5分钟。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'iat' => [ + 'title' => '签发时间，Unix Time，单位秒，在此时间之前无法使用，如：1577682075', + 'type' => 'integer', + 'format' => 'int64', + ], + 'nbf' => [ + 'title' => '生效时间，Unix Time，单位秒，不指定则默认为当前时间。生效时间和过期时间不能超过15分钟。 为防止客户端和服务器时间不一致，此时间建议设置为当前时间减5分钟，或者不设置。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'KnowledgeBase' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'knowledge_base_id' => [ + 'title' => '知识库ID', + 'type' => 'string', + ], + 'owner_type' => [ + 'title' => '1', + 'type' => 'string', + ], + 'owner_id' => [ + 'title' => '1', + 'type' => 'string', + ], + 'owner_name' => [ + 'title' => '1', + 'type' => 'string', + ], + 'name' => [ + 'title' => '1', + 'type' => 'string', + ], + 'cover_uri' => [ + 'title' => '1', + 'type' => 'string', + ], + 'description' => [ + 'title' => '1', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int64', + ], + 'created_at' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_filter' => [ + 'title' => '1', + 'type' => 'string', + ], + 'link_rule_list' => [ + 'title' => '1', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LinkRule', + ], + 'required' => false, + ], + ], + ], + 'KnowledgeCategory' => [ + 'title' => '知识分类', + 'type' => 'object', + 'properties' => [ + 'knowledge_base_id' => [ + 'title' => '知识库id', + 'type' => 'string', + ], + 'knowledge_base_name' => [ + 'title' => '知识库名称', + 'type' => 'string', + ], + 'parent_knowledge_category_id' => [ + 'title' => '父知识分类id', + 'type' => 'string', + ], + 'knowledge_category_id' => [ + 'title' => '知识分类id', + 'type' => 'string', + ], + 'name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'keywords' => [ + 'title' => '关键词列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'owner' => [ + 'title' => '所有者', + 'type' => 'string', + ], + 'owner_type' => [ + 'title' => '所有者类型', + 'type' => 'string', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'KnowledgeFile' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'knowledge_base_id' => [ + 'title' => '知识库 ID', + 'type' => 'string', + ], + 'knowledge_category_id' => [ + 'title' => '知识分类 ID', + 'type' => 'string', + ], + 'drive_id' => [ + 'title' => '云盘 ID', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => '文件 ID', + 'type' => 'string', + ], + 'revision_id' => [ + 'title' => '文件版本 ID', + 'type' => 'string', + ], + 'joined_at' => [ + 'title' => '文件加入知识库/知识分类的毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'creator_id' => [ + 'title' => '文件加入知识库/知识分类的操作者 ID', + 'type' => 'string', + ], + 'file_image_time' => [ + 'title' => '图片文件的拍摄时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_created_at' => [ + 'title' => '文件的毫秒级创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_updated_at' => [ + 'title' => '文件的毫秒级更新时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_creator_id' => [ + 'title' => '文件的创建者 ID', + 'type' => 'string', + ], + 'file_size' => [ + 'title' => '文件大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_category' => [ + 'title' => '文件类别', + 'type' => 'string', + ], + 'file_name' => [ + 'title' => '文件名', + 'type' => 'string', + ], + 'file_name_path' => [ + 'title' => '文件名路径', + 'type' => 'string', + ], + 'file_last_modifier_id' => [ + 'title' => '文件最后的修改者 ID', + 'type' => 'string', + ], + 'file_last_modifier_type' => [ + 'title' => '文件最后的修改者类型', + 'type' => 'string', + ], + 'drive_name' => [ + 'title' => '云盘名称', + 'type' => 'string', + ], + ], + ], + 'KnowledgeFileItem' => [ + 'title' => '知识文件相关接口入参实体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间 ID', + 'type' => 'string', + 'required' => true, + ], + 'file_id' => [ + 'title' => '文件 ID', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'LinkInfo' => [ + 'title' => 'A short description of struct', + 'description' => '用户登录信息', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '当前用户已存在的登录方式', + 'type' => 'string', + ], + 'identity' => [ + 'title' => '当前用户已存在的登录标识', + 'type' => 'string', + ], + 'extra' => [ + 'title' => '额外的信息，比如type为mobile时，此字段为国家编号，不填默认86', + 'type' => 'string', + ], + ], + ], + 'LinkRule' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'src_file_id' => [ + 'title' => '1', + 'type' => 'string', + ], + 'src_drive_id' => [ + 'title' => '1', + 'type' => 'string', + ], + 'link_type' => [ + 'title' => '1', + 'type' => 'string', + ], + 'src_file_name' => [ + 'title' => '文件名', + 'type' => 'string', + ], + 'src_drive_name' => [ + 'title' => 'drive名', + 'type' => 'string', + ], + 'src_valid' => [ + 'title' => '1', + 'type' => 'boolean', + ], + ], + ], + 'LocationDateCluster' => [ + 'title' => '时空聚类详情', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间 id。', + 'type' => 'string', + ], + 'cluster_id' => [ + 'title' => '聚类 id。', + 'type' => 'string', + ], + 'title' => [ + 'title' => '聚类标题。', + 'type' => 'string', + ], + 'level' => [ + 'title' => '聚类的行政级别。', + 'type' => 'string', + 'enum' => [ + 'country', + 'province', + 'city', + 'district', + 'township', + ], + ], + 'address' => [ + 'title' => '地址信息。', + '$ref' => '#/components/schemas/Address', + ], + 'start_time' => [ + 'title' => '聚类开始时间。RFC3339。', + 'type' => 'string', + ], + 'end_time' => [ + 'title' => '聚类结束时间。RFC3339。', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '聚类创建时间。RFC3339。', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => '聚类更新时间。RFC3339。', + 'type' => 'string', + ], + 'custom_labels' => [ + 'title' => '自定义标签。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'MediaPlayInfoTemplate' => [ + 'title' => 'A short description of struct', + 'description' => '多媒体播放模版', + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'type' => 'string', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + ], + 'url' => [ + 'title' => '播放地址', + 'type' => 'string', + ], + ], + ], + 'Membership' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'type' => 'string', + ], + 'group_id' => [ + 'title' => '组id', + 'type' => 'string', + ], + 'sub_group_id' => [ + 'title' => '子组id', + 'type' => 'string', + ], + 'user_id' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'member_type' => [ + 'title' => '成员类型', + 'type' => 'string', + ], + 'member_role' => [ + 'title' => '成员角色', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'creator' => [ + 'title' => '创建者', + 'type' => 'string', + ], + ], + ], + 'NameCheckResult' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'exist_file_id' => [ + 'title' => 'exist file id', + 'type' => 'string', + ], + 'exist_file_type' => [ + 'title' => 'exist file type', + 'type' => 'string', + ], + ], + ], + 'OfficeEditConfig' => [ + 'title' => 'OfficeEditConfig', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => 'enabled', + 'type' => 'boolean', + ], + ], + ], + 'OfficePreviewConfig' => [ + 'title' => 'OfficePreviewConfig', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => 'enabled', + 'type' => 'boolean', + ], + ], + ], + 'Permission' => [ + 'title' => 'A short description of struct', + 'description' => '权限', + 'type' => 'object', + 'properties' => [ + 'collection' => [ + 'title' => '权限集', + 'description' => '权限集，设置全局权限时为 global，其他场景默认为空', + 'type' => 'string', + 'example' => 'global', + ], + 'resource_type' => [ + 'title' => '资源类型', + 'description' => '资源类型，文件类型资源为RT\\_File', + 'type' => 'string', + 'example' => 'RT_File', + ], + 'resource' => [ + 'title' => '资源', + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'fa212***', + ], + 'identity_type' => [ + 'title' => '授予对象类型', + 'description' => '授予对象类型，当前支持IT\\_User、IT\\_Group、IT\\_Role', + 'type' => 'string', + 'example' => 'IT_User', + ], + 'identity_id' => [ + 'title' => '授予对象ID', + 'description' => '授予对象ID', + 'type' => 'string', + 'example' => 'af22***', + ], + 'action_list' => [ + 'title' => '操作列表', + 'description' => '操作列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '操作', + 'description' => '具体操作，比如FILE.ALL', + 'type' => 'string', + 'example' => 'FILE.ALL', + ], + ], + ], + ], + 'effect' => [ + 'title' => '作用', + 'description' => '作用，可填allow、deny', + 'type' => 'string', + 'example' => 'deny', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间，格式为毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703648502811', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'description' => '修改时间，格式为毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703648502811', + ], + 'condition' => [ + 'title' => '条件', + 'description' => '条件', + '$ref' => '#/components/schemas/PermissionCondition', + ], + 'user_tags' => [ + 'title' => '自定义标签', + 'description' => '自定义标签', + 'type' => 'array', + 'items' => [ + 'description' => '自定义标签字符串', + 'type' => 'string', + 'example' => 'user1', + ], + ], + ], + ], + 'PermissionCondition' => [ + 'title' => 'permission condition', + 'description' => '条件', + 'type' => 'object', + 'properties' => [ + 'ip_equals' => [ + 'title' => 'ip在里面', + 'description' => 'IP地址条件，当IP等于以下列表中其中一个时，此条件成立', + 'type' => 'object', + 'properties' => [ + 'client_ip' => [ + 'title' => 'ip', + 'description' => '客户端IP地址', + 'type' => 'array', + 'items' => [ + 'description' => '具体的IP地址', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + ], + ], + ], + 'ip_not_equals' => [ + 'title' => 'ip不在里面', + 'description' => 'IP地址条件，当IP不等于以下列表中任意一个时，此条件成立', + 'type' => 'object', + 'properties' => [ + 'client_ip' => [ + 'title' => 'ip', + 'description' => '客户端IP地址', + 'type' => 'array', + 'items' => [ + 'description' => '具体的IP地址', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + ], + ], + ], + 'string_like' => [ + 'title' => 'vpc_id在里面', + 'description' => '字符串匹配条件，当传入字符串等于以下列表中其中一个时，此条件成立', + 'type' => 'object', + 'properties' => [ + 'vpc_id' => [ + 'title' => 'vpc_id', + 'description' => '客户端所在的vpcID作为字符串匹配条件', + 'type' => 'array', + 'items' => [ + 'description' => '具体VpcID', + 'type' => 'string', + 'example' => 'vpc-xxx', + ], + ], + ], + ], + 'string_not_like' => [ + 'title' => 'vpc_id不在里面', + 'description' => '字符串匹配条件，当传入字符串不等于以下列表中任意一个时，此条件成立', + 'type' => 'object', + 'properties' => [ + 'vpc_id' => [ + 'title' => 'vpi_id', + 'description' => '客户端所在的vpcID作为字符串匹配条件', + 'type' => 'array', + 'items' => [ + 'description' => '具体VpcID', + 'type' => 'string', + 'example' => 'vpc-xxx', + ], + ], + ], + ], + 'bool_equals' => [ + 'title' => '是否分享场景', + 'description' => '是否分享场景', + 'type' => 'object', + 'properties' => [ + 'is_share_link' => [ + 'title' => '是否分享场景', + 'description' => '是否分享场景', + 'type' => 'boolean', + ], + ], + ], + 'bool_not_equals' => [ + 'title' => '是否分享场景', + 'description' => '是否分享场景', + 'type' => 'object', + 'properties' => [ + 'is_share_link' => [ + 'title' => '是否分享场景', + 'description' => '是否分享场景', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'PersonalRightsInfoResponse' => [ + 'type' => 'object', + 'properties' => [ + 'spu_id' => [ + 'title' => 'spu_id', + 'type' => 'string', + ], + 'name' => [ + 'title' => '名字', + 'type' => 'string', + ], + 'title' => [ + 'title' => '标题', + 'type' => 'string', + ], + 'icon' => [ + 'title' => '图标', + 'type' => 'string', + ], + 'expires_time' => [ + 'title' => '过期时间', + 'type' => 'string', + ], + 'is_expires' => [ + 'title' => '是否过期', + 'type' => 'boolean', + ], + 'privileges' => [ + 'title' => '权益', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DataBoxPrivileges', + ], + 'required' => false, + ], + 'history_latest_rights' => [ + 'title' => '最新权益', + '$ref' => '#/components/schemas/PersonalRightsInfoResponse', + ], + 'other_rights' => [ + 'title' => '其他权益', + '$ref' => '#/components/schemas/PersonalRightsInfoResponse', + ], + ], + ], + 'PersonalSpaceInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'PersonalSpaceInfo', + 'type' => 'object', + 'properties' => [ + 'used_size' => [ + 'title' => '使用大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'total_size' => [ + 'title' => '总大小', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'ReceivedMsg' => [ + 'title' => 'A short description of struct', + 'description' => '收到的通知消息', + 'type' => 'object', + 'properties' => [ + 'msg_id' => [ + 'title' => '消息id', + 'type' => 'string', + 'example' => '50d6f2aaa16525c7d053998e48fac265962f585f', + ], + 'msg_category' => [ + 'title' => '消息分类', + 'type' => 'string', + 'example' => 'system', + ], + 'msg_sub_category' => [ + 'title' => '消息子分类', + 'type' => 'string', + 'example' => 'change_user_setting', + ], + 'msg_content' => [ + 'title' => '消息内容', + 'type' => 'object', + 'properties' => [ + 'msg_data' => [ + 'title' => '消息携带的数据', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"actor": "admin", "role": "superadmin", "target": "phone", "to": "137*****123" }', + ], + ], + ], + ], + 'msg_type' => [ + 'title' => '消息类别', + 'type' => 'string', + 'example' => 'edit_user', + ], + 'has_read' => [ + 'title' => '是否已读', + 'type' => 'boolean', + 'example' => 'false', + ], + 'read_at' => [ + 'title' => '已读事件', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716363191123', + ], + 'publish_at' => [ + 'title' => '发送时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716363191123', + ], + ], + ], + 'RecentActedFile' => [ + 'title' => '最近操作的文件', + 'description' => '最近操作的文件', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '空间id', + 'type' => 'string', + 'example' => '50d6f2aaa16525c7d053998e48fac265962f585f', + ], + 'drive_name' => [ + 'title' => '空间名', + 'type' => 'string', + 'example' => 'group drive', + ], + 'drive_owner_id' => [ + 'title' => '空间所有者id', + 'type' => 'string', + 'example' => '50d6f2aaa16525c7d053998e48fac265962f585f', + ], + 'drive_owner_type' => [ + 'title' => '空间所有者类型', + 'type' => 'string', + 'example' => 'group', + ], + 'drive_is_handover' => [ + 'title' => '是否是移交的空间', + 'type' => 'boolean', + 'example' => 'false', + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + 'example' => '50d6f2aaa16525c7d053998e48fac265962f585f', + ], + 'file_name' => [ + 'title' => '文件名', + 'type' => 'string', + 'example' => 'a.jpg', + ], + 'size' => [ + 'title' => '文件大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'category' => [ + 'title' => '文件类型', + 'type' => 'string', + 'example' => 'doc', + ], + 'thumbnail' => [ + 'title' => '文件缩略图', + 'type' => 'string', + 'example' => 'https://xxx.jpg', + ], + 'trashed' => [ + 'title' => '是否移到回收站', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deleted' => [ + 'title' => '是否删除', + 'type' => 'boolean', + 'example' => 'true', + ], + 'action_list' => [ + 'title' => '文件权限列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'FILE.GET', + ], + ], + ], + ], + 'RecycleBinConfig' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'auto_delete_enabled' => [ + 'title' => 'auto_delete_enabled', + 'type' => 'boolean', + ], + 'auto_delete_keep_second' => [ + 'title' => 'auto_delete_keep_second', + 'type' => 'integer', + 'format' => 'int32', + ], + 'delete_trash_normal_file_disabled' => [ + 'title' => 'delete_trash_normal_file_disabled', + 'type' => 'boolean', + ], + ], + ], + 'RefundNoticeParam' => [ + 'title' => 'A short description of struct', + 'description' => '退款通知参数', + 'type' => 'object', + 'properties' => [ + 'refundType' => [ + 'title' => '退款类型', + 'type' => 'string', + ], + 'orderIds' => [ + 'title' => '订单号列表', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'instanceId' => [ + 'title' => '实例 id', + 'type' => 'string', + ], + 'commodityCode' => [ + 'title' => '商品 code', + 'type' => 'string', + ], + 'aliyunProduceCode' => [ + 'title' => '阿里云产品 code', + 'type' => 'string', + ], + 'aliuid' => [ + 'title' => '阿里云用户 id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'newExpireTime' => [ + 'title' => '过期时间', + 'type' => 'any', + ], + 'refundParamMap' => [ + 'title' => '退款参数', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Revision' => [ + 'title' => 'A short description of struct', + 'description' => '版本', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'title' => '空间id', + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id', + 'type' => 'string', + 'example' => '9520943DC264', + ], + 'revision_id' => [ + 'title' => '版本id', + 'description' => '版本id', + 'type' => 'string', + 'example' => '40CB7794C929', + ], + 'revision_name' => [ + 'title' => '版本名', + 'description' => '版本名', + 'type' => 'string', + 'example' => '1.mov', + ], + 'revision_version' => [ + 'title' => '版本号', + 'description' => '版本号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'size' => [ + 'title' => '版本大小', + 'description' => '版本大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'file_extension' => [ + 'title' => '扩展名', + 'description' => '扩展名', + 'type' => 'string', + 'example' => 'mov', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'keep_forever' => [ + 'title' => '是否永久保留', + 'description' => '是否永久保留', + 'type' => 'boolean', + 'example' => 'false', + ], + 'revision_description' => [ + 'title' => '版本描述', + 'description' => '版本描述', + 'type' => 'string', + 'example' => 'aaa', + ], + 'is_latest_version' => [ + 'title' => '是否为最新版本', + 'description' => '是否为最新版本', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'crc64_hash' => [ + 'title' => 'crc64', + 'description' => 'crc64', + 'type' => 'string', + 'example' => '3574582125365864471', + ], + 'content_hash' => [ + 'title' => '内容hash', + 'description' => '内容hash', + 'type' => 'string', + 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3', + ], + 'content_hash_name' => [ + 'title' => '内容hash算法名', + 'description' => '内容hash算法名', + 'type' => 'string', + 'example' => 'sha1', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'description' => '缩略图地址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", + ], + 'url' => [ + 'title' => '预览地址', + 'description' => '预览地址', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", + ], + 'download_url' => [ + 'title' => '下载地址', + 'description' => '下载地址，ListRevision不返回该字段，GetRevision, UpdateRevision, RestoreRevision返回该字段。', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", + ], + 'creator_id' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'string', + ], + 'creator_name' => [ + 'title' => '创建者名称', + 'description' => '创建者名称', + 'type' => 'string', + ], + ], + ], + 'Role' => [ + 'title' => '角色', + 'description' => '角色', + 'type' => 'object', + 'properties' => [ + 'role_id' => [ + 'title' => '角色ID', + 'description' => '角色ID', + 'type' => 'string', + 'example' => 'f2a***', + ], + 'name' => [ + 'title' => '角色名', + 'description' => '角色名', + 'type' => 'string', + 'example' => '文件预览者', + ], + 'description' => [ + 'title' => '角色描述', + 'description' => '角色描述', + 'type' => 'string', + 'example' => '拥有预览文件权限', + ], + 'manage_resource_type' => [ + 'title' => '管理的资源类型', + 'description' => '管理的资源类型，目前支持RT\\_File', + 'type' => 'string', + 'example' => 'RT_File', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者ID', + 'type' => 'string', + 'example' => 'a23***', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间，格式毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703648502811', + ], + 'updated_at' => [ + 'title' => '上次更新时间', + 'description' => '上次更新时间，格式毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703648502811', + ], + 'permissions' => [ + 'title' => '权限列表', + 'description' => '权限列表', + 'type' => 'array', + 'items' => [ + 'description' => '权限项', + '$ref' => '#/components/schemas/Permission', + ], + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'enabled', + ], + ], + ], + 'SearchFromThirdPartyItem' => [ + 'title' => 'SearchFromThirdPartyItem', + 'type' => 'object', + 'properties' => [ + 'authentication_type' => [ + 'title' => 'authentication_type', + 'type' => 'string', + ], + 'identity' => [ + 'title' => 'identity', + 'type' => 'string', + ], + 'extra' => [ + 'title' => 'extra', + 'type' => 'string', + ], + 'others' => [ + 'title' => 'others', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + ], + ], + 'ShareLink' => [ + 'title' => '分享', + 'description' => '分享', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'title' => '分享id', + 'description' => '分享id', + 'type' => 'string', + 'example' => '7JQX1FswpQ8', + ], + 'share_pwd' => [ + 'title' => '分享密码', + 'description' => '提取码，0-64个字符。长度0表示没有提取码。', + 'type' => 'string', + 'example' => 'abcF123x', + ], + 'drive_id' => [ + 'title' => '空间id', + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id_list' => [ + 'title' => '分享父路径文件id列表', + 'description' => '分享父路径文件id列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '["xx"]', + ], + 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', + ], + 'expiration' => [ + 'title' => '到期时间', + 'description' => '失效时间点。'."\n" + .'RFC3339格式，比如："2020-06-28T11:33:00.000+08:00"。'."\n" + .'永久有效：""', + 'type' => 'string', + 'example' => '2020-06-28T11:33:00.000+08:00', + ], + 'expired' => [ + 'title' => '是否过期', + 'description' => '是否过期', + 'type' => 'boolean', + 'example' => 'false', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'videos', + ], + 'share_name' => [ + 'title' => '分享名称', + 'description' => '分享名，默认使用第一个文件名', + 'type' => 'string', + 'example' => 'video-1.MP4', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态。'."\n" + .'枚举值如下：'."\n" + .'- disabled（已取消）'."\n" + .'- enabled（有效）', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '已取消', + 'enabled' => '有效', + ], + 'example' => 'enabled', + ], + 'preview_count' => [ + 'title' => '预览次数', + 'description' => '预览次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'save_count' => [ + 'title' => '转存次数', + 'description' => '转存次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'download_count' => [ + 'title' => '下载次数', + 'description' => '下载次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'report_count' => [ + 'title' => '被举报次数', + 'description' => '被举报次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'video_preview_count' => [ + 'title' => '音视频播放次数', + 'description' => '音视频播放次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'access_count' => [ + 'title' => '访问次数', + 'description' => '访问次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'disable_preview' => [ + 'title' => '禁止预览分享中的文件', + 'description' => '禁止预览分享中的文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'disable_save' => [ + 'title' => '禁止转存分享中的文件', + 'description' => '禁止转存分享中的文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'disable_download' => [ + 'title' => '禁止下载分享中的文件', + 'description' => '禁止下载分享中的文件', + 'type' => 'boolean', + 'example' => 'false', + ], + 'preview_limit' => [ + 'title' => '分享预览次数限制', + 'description' => '分享预览次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'save_limit' => [ + 'title' => '分享转存次数限制', + 'description' => '分享转存次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'download_limit' => [ + 'title' => '分享下载次数限制', + 'description' => '分享下载次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'share_all_files' => [ + 'title' => '是否分享整个drive中的文件', + 'description' => '是否分享整个drive中的文件', + 'type' => 'boolean', + 'example' => 'true', + ], + 'save_download_limit' => [ + 'title' => '分享转存和下载次数总和限制', + 'description' => '分享转存和下载次数总和限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'office_editable' => [ + 'title' => '是否允许在线编辑分享的文档', + 'description' => '是否允许在线编辑分享的文档', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ShareLinkConfig' => [ + 'title' => 'ShareLinkConfig', + 'type' => 'object', + 'properties' => [ + 'enable_share_link_office_edit' => [ + 'title' => 'enable_share_link_office_edit', + 'type' => 'boolean', + ], + ], + ], + 'ShareLinkDetail' => [ + 'title' => 'ShareLinkDetail', + 'type' => 'object', + 'properties' => [ + 'enable_office_editable' => [ + 'title' => 'enable_office_editable', + 'type' => 'boolean', + ], + ], + ], + 'SimpleQuery' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'title' => '字段', + 'type' => 'string', + 'format' => 'byte', + ], + 'operation' => [ + 'title' => '操作', + 'type' => 'string', + 'format' => 'byte', + ], + 'sub_queries' => [ + 'title' => '查询条件', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/SimpleQuery', + ], + ], + 'value' => [ + 'title' => '值', + 'type' => 'string', + 'format' => 'byte', + ], + ], + ], + 'SimpleStreamInfo' => [ + 'title' => 'SimpleStreamInfo', + 'description' => '数据流信息', + 'type' => 'object', + 'properties' => [ + 'crc64_hash' => [ + 'title' => 'crc64_hash', + 'type' => 'string', + ], + 'size' => [ + 'title' => 'size', + 'type' => 'integer', + 'format' => 'int64', + ], + 'content_hash' => [ + 'title' => 'content_hash', + 'type' => 'string', + ], + 'content_hash_name' => [ + 'title' => 'content_hash_name', + 'type' => 'string', + ], + 'download_url' => [ + 'title' => 'download_url', + 'type' => 'string', + ], + 'url' => [ + 'title' => 'url', + 'type' => 'string', + ], + 'thumbnail' => [ + 'title' => 'thumbnail', + 'type' => 'string', + ], + ], + ], + 'Story' => [ + 'title' => 'A short description of struct', + 'description' => '故事', + 'type' => 'object', + 'properties' => [ + 'story_id' => [ + 'title' => '故事 id', + 'description' => '故事 id', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'story_type' => [ + 'title' => '故事类型', + 'description' => '故事类型。'."\n" + .'由用户创建时指定，见 [CreateStory](~~2367602~~) 和 [CreateCustomizedStory](~~2369338~~)。', + 'type' => 'string', + 'example' => 'PeopleMemory', + ], + 'story_sub_type' => [ + 'title' => '故事子类型', + 'description' => '故事子类型。'."\n" + .'由用户创建时指定，见 [CreateStory](~~2367602~~) 和 [CreateCustomizedStory](~~2369338~~)。', + 'type' => 'string', + 'example' => 'Solo', + ], + 'story_name' => [ + 'title' => '故事名称', + 'description' => '故事名称', + 'type' => 'string', + 'example' => 'test_name', + ], + 'story_start_time' => [ + 'title' => '故事开始时间', + 'description' => '故事开始时间。时间格式为 RFC3339。', + 'type' => 'string', + 'example' => '2021-01-14T10:17:18.102700407+08:00', + ], + 'story_end_time' => [ + 'title' => '故事结束时间', + 'description' => '故事结束时间。时间格式为 RFC3339。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'created_at' => [ + 'title' => '故事创建时间', + 'description' => '故事创建时间。时间格式为 RFC3339。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'updated_at' => [ + 'title' => '故事更新时间', + 'description' => '故事更新时间。时间格式为 RFC3339。', + 'type' => 'string', + 'example' => '2022-01-14T10:17:18.102700407+08:00', + ], + 'face_group_ids' => [ + 'title' => '人脸分组列表', + 'description' => '人脸分组列表。'."\n" + .'仅为人物故事类型时有值，其他故事类型或自定义故事无值。', + 'type' => 'array', + 'items' => [ + 'description' => '人脸分组 id', + 'type' => 'string', + 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', + ], + ], + 'cover_file_id' => [ + 'title' => '故事封面文件 id', + 'description' => '故事封面文件 id', + 'type' => 'string', + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'cover_file_thumbnail_url' => [ + 'title' => '故事封面文件缩略图', + 'description' => '故事封面文件缩略图', + 'type' => 'string', + 'example' => 'https://pds-domain-bucket.oss-cn-hangzhou.aliyuncs.com/Bh1HqdAs%2F1001%2F642a88c26f99cad589904fc8a6b2db6021c6601f%2F642a88c29391c47f221e49e88a21fa9b0a9e5063?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5eGE8nGtYZ59bSnbUODlmsjTttVhpbFpjz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNXD6XXO2qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABVgD3mIAeUoDYKTJrFTPdmAPIrlUUQ1HZstB0ZVHvYByygr3oeitG9FEQ8lcfaZYJOtWRchdgH8tsSwHj2jI1vMeAiLHgbW98SPA3yfN8OR1kLW73uq3LAvekc9Qldz33YTM4JA5MNJzR8x5O6Oe4rY5OMSSVU5F%2Ffr8bJZD%2FXMM%3D&x-oss-access-key-id=STS.NT3XsrXYXBvLoe2rkvBTyiSnD&x-oss-expires=1685966251&x-oss-process=image%2Fresize%2Cw_500&x-oss-signature=XimW6haBxYktKg4cstMfpd%2F2LSoMibj6A%2B7ZqBJcSbQ%3D&x-oss-signature-version=OSS2', + ], + 'story_file_list' => [ + 'title' => '故事文件列表', + 'description' => '故事文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + 'custom_labels' => [ + 'title' => '自定义标签', + 'description' => '自定义标签。'."\n" + .'用户根据自身业务标记相关的键值对，可用于 FindStories 检索。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '自定义标签', + 'type' => 'any', + 'example' => 'value', + ], + ], + ], + ], + 'SystemDriveConfig' => [ + 'title' => 'SystemDriveConfig', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => 'enable', + 'type' => 'boolean', + ], + 'drive_id' => [ + 'title' => 'drive_id', + 'type' => 'string', + ], + 'resource_parent_file_id_map' => [ + 'title' => 'resource_parent_file_id_map', + 'type' => 'object', + ], + ], + ], + 'SystemTag' => [ + 'title' => '标签详细信息。仅开启增值服务图片处理功能有效。', + 'description' => '系统AI处理标签。仅当开启增值服务图片处理功能有效。（该数据结构将于2025年2月20日起停止透出）', + 'type' => 'object', + 'properties' => [ + 'confidence' => [ + 'title' => '标签置信度，取值范围为 0（表示置信度最低）~1（表示置信度最高）。', + 'description' => '标签置信度，取值范围为 0（表示置信度最低）~1（表示置信度最高）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.98', + ], + 'parent_name' => [ + 'title' => '标签父标签。', + 'description' => '标签的父标签名称。', + 'type' => 'string', + 'example' => 'sport', + ], + 'name' => [ + 'title' => '标签名。', + 'description' => '标签名称。', + 'type' => 'string', + 'example' => 'basketball', + ], + 'tag_level' => [ + 'title' => '标签层级，取之范围大于等于 1。', + 'description' => '标签层级，取值范围大于等于 1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'centric_score' => [ + 'title' => '标签的中心值分数，指该标签在图片中是否为主体，取值范围为 0~1。', + 'description' => '标签的中心值分数，指该标签在图片中是否为主体，取值范围为 0（主体比重最小）~1（主体比重最大）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.877', + ], + ], + ], + 'TimeRange' => [ + 'title' => '时间范围', + 'type' => 'object', + 'properties' => [ + 'start' => [ + 'title' => '起始时间。格式 RFC3339。', + 'type' => 'string', + ], + 'end' => [ + 'title' => '结束时间。格式 RFC3339。', + 'type' => 'string', + ], + ], + ], + 'Token' => [ + 'title' => 'A short description of struct', + 'description' => '认证成功后返回的对象，包含access_token和refresh_token还有基础用户信息', + 'type' => 'object', + 'properties' => [ + 'access_token' => [ + 'title' => '访问凭证', + 'description' => '访问凭证', + 'type' => 'string', + 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs', + ], + 'refresh_token' => [ + 'title' => '刷新凭证', + 'description' => '刷新凭证', + 'type' => 'string', + 'example' => '060e78d36afb4879b51e4264e9541c16', + ], + 'expires_in' => [ + 'title' => '凭证有效期', + 'description' => '凭证有效期', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'token_type' => [ + 'title' => '凭证类型', + 'description' => '凭证类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Bearer' => 'Bearer', + ], + 'example' => 'Bearer', + ], + 'user_id' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'string', + 'example' => 'DING-xxxxx', + ], + 'user_name' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'example' => 'pdsuser', + ], + 'avatar' => [ + 'title' => '用户头像', + 'description' => '用户头像', + 'type' => 'string', + 'example' => 'aliyunpds.com/a.jpg', + ], + 'nick_name' => [ + 'title' => '用户昵称', + 'description' => '用户昵称', + 'type' => 'string', + 'example' => 'pdsuser', + ], + 'default_drive_id' => [ + 'title' => '用户默认空间ID', + 'description' => '用户默认空间ID', + 'type' => 'string', + 'example' => '1', + ], + 'role' => [ + 'title' => '用户角色', + 'description' => '用户角色', + 'type' => 'string', + 'example' => 'admin', + ], + 'status' => [ + 'title' => '用户状态', + 'description' => '用户状态', + 'type' => 'string', + 'example' => 'enabled', + ], + 'expire_time' => [ + 'title' => '凭证过期时间', + 'description' => '凭证过期时间', + 'type' => 'string', + 'example' => '2019-09-01T06:57:48.813Z', + ], + 'is_first_login' => [ + 'title' => '是否首次登录', + 'description' => '是否首次登录', + 'type' => 'boolean', + 'example' => 'false', + ], + 'device_name' => [ + 'title' => '登录设备名称', + 'description' => '通过oauth device flow绑定的设备名', + 'type' => 'string', + 'example' => '4683C25F', + ], + 'domain_id' => [ + 'title' => '域ID', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'default_sbox_drive_id' => [ + 'title' => '用户默认保险箱ID', + 'description' => '用户默认保险箱ID', + 'type' => 'string', + 'example' => '1', + ], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'description' => '用户自定义数据', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'pin_setup' => [ + 'title' => '用户是否设置过保险箱密码', + 'description' => '用户是否设置过保险箱密码', + 'type' => 'boolean', + 'example' => 'false', + ], + 'need_rp_verify' => [ + 'title' => '用户是否需要进行实人认证', + 'description' => '用户是否需要进行实人认证', + 'type' => 'boolean', + 'example' => 'false', + ], + 'state' => [ + 'title' => '临时权限，用于登录成功后设置密码', + 'description' => '临时权限，用于登录成功后设置密码', + 'type' => 'string', + 'example' => 'klafhjas-asdasd-asd-as-d-asd-asd-asdasd', + ], + 'exist_link' => [ + 'title' => '当前用户已存在的登录方式', + 'description' => '当前用户已存在的登录方式', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LinkInfo', + ], + ], + 'need_link' => [ + 'title' => '是否需要绑定账号', + 'description' => '是否需要绑定账号', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'UncompressConfigResponse' => [ + 'title' => 'UncompressConfigResponse', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => 'enabled', + 'type' => 'boolean', + ], + 'version' => [ + 'title' => 'version', + 'type' => 'string', + ], + ], + ], + 'UncompressedFileInfo' => [ + 'title' => 'A short description of struct', + 'description' => '解压文件信息', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '网盘id', + 'description' => '网盘id', + 'type' => 'string', + 'example' => '5060', + ], + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id', + 'type' => 'string', + 'example' => '66972349b2b12fa309a143fb9db29647b2ddabfd', + ], + 'is_folder' => [ + 'title' => '是否为文件夹', + 'description' => '是否为文件夹', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'name' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => '1.mov', + ], + 'size' => [ + 'title' => '文件大小', + 'description' => '文件大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '218052', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721368014000', + ], + 'items' => [ + 'title' => '子文件', + 'description' => '子文件', + 'type' => 'array', + 'items' => [ + 'description' => '解压文件信息', + '$ref' => '#/components/schemas/UncompressedFileInfo', + ], + ], + ], + ], + 'UploadFormInfo' => [ + 'title' => 'A short description of struct', + 'description' => '表单上传信息', + 'type' => 'object', + 'properties' => [ + 'bucket_name' => [ + 'title' => 'bucket name', + 'type' => 'string', + ], + 'oss_end_point' => [ + 'title' => 'oss 地址', + 'type' => 'string', + ], + 'object_key' => [ + 'title' => 'oss object key', + 'type' => 'string', + ], + 'oss_access_key_id' => [ + 'title' => '上传的 access id', + 'type' => 'string', + ], + 'oss_security_token' => [ + 'title' => '上传的 sts token', + 'type' => 'string', + ], + 'policy' => [ + 'title' => '上传策略', + 'type' => 'string', + ], + 'signature' => [ + 'title' => '上传签名', + 'type' => 'string', + ], + 'endpoint' => [ + 'title' => '数据存储地址', + 'type' => 'string', + ], + 'form_data' => [ + 'title' => '表单上传信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'UploadPartInfo' => [ + 'title' => '分段信息', + 'description' => '分段信息', + 'type' => 'object', + 'properties' => [ + 'part_number' => [ + 'title' => '段编号', + 'description' => '段编号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'part_size' => [ + 'title' => '分段大小', + 'description' => '此字段已废弃，请勿使用。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'upload_url' => [ + 'title' => '上传地址', + 'description' => '上传地址，默认有效时间15分钟，如果链接超时，需要重新调用GetUploadUrl进行获取'."\n" + .'（开启智能数据域名后，根据请求会自适应返回internal_upload_url值在该字段内）', + 'type' => 'string', + 'required' => true, + 'example' => 'https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661', + ], + 'internal_upload_url' => [ + 'title' => '内网上传地址', + 'description' => '内网上传地址，用于VPC网络内部访问'."\n" + .'（开启智能数据域名后将不再使用该字段，根据请求该参数会自适应返回在upload_url字段值内，如需使用该字段请联系PDS技术支持）', + 'type' => 'string', + 'example' => 'https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661'."\n", + ], + 'etag' => [ + 'title' => 'etag', + 'description' => '此字段已废弃，请勿使用。', + 'type' => 'string', + 'example' => '"0CC175B9C0F1B6A831C399E269772661"', + ], + 'parallel_sha1_ctx' => [ + 'title' => '上一个分段的sha1上下文', + 'description' => '上一个分段的sha1上下文，该字段只在多分片并发上传的模式下有效', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'title' => '上一个数据块SHA1的第1-5个32位变量', + 'description' => '上一个数据块SHA1的第1-5个32位变量，该字段只在多分片并发上传的模式下有效', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'part_offset' => [ + 'title' => '到上一个数据块为止的总长度，字节，需要为64的倍数', + 'description' => '到上一个数据块为止的总长度，字节，需要为64的倍数，该字段只在多分片并发上传的模式下有效', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + ], + ], + 'parallel_sha256_ctx' => [ + 'title' => '上一个分段的sha256上下文', + 'description' => '上一个分段的sha256上下文', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'title' => '上一个数据块SHA256的第1-8个32位变量', + 'description' => '上一个数据块SHA256的第1-8个32位变量', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'part_offset' => [ + 'title' => '到上一个数据块为止的总长度，字节，需要为64的倍数', + 'description' => '到上一个数据块为止的总长度，字节，需要为64的倍数', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'User' => [ + 'title' => '用户', + 'description' => '用户', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'user_id' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'avatar' => [ + 'title' => '头像', + 'description' => '头像', + 'type' => 'string', + 'example' => 'http://aa.com/1.jpg', + ], + 'created_at' => [ + 'title' => '创建时间', + 'description' => '创建时间，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579768', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'description' => '修改时间，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579768', + ], + 'email' => [ + 'title' => '邮箱', + 'description' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nick_name' => [ + 'title' => '昵称', + 'description' => '昵称', + 'type' => 'string', + 'example' => '001', + ], + 'phone' => [ + 'title' => '手机号', + 'description' => '手机号', + 'type' => 'string', + 'example' => '13900001111', + ], + 'role' => [ + 'title' => '角色', + 'description' => '角色'."\n" + ."\n" + .'- superadmin（超级管理员）'."\n" + ."\n" + .'- admin（管理员）'."\n" + ."\n" + .'- user（普通用户）', + 'type' => 'string', + 'enumValueTitles' => [ + 'superadmin' => '超级管理员', + 'admin' => '管理员', + 'user' => '普通用户', + ], + 'example' => 'user', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态'."\n" + ."\n" + .'- disabled（禁止）'."\n" + ."\n" + .'- enabled（使能）', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '禁止', + 'enabled' => '使能', + ], + 'example' => 'enabled', + ], + 'user_name' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'example' => 'pds', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vipuser', + ], + 'default_drive_id' => [ + 'title' => '缺省空间id', + 'description' => '缺省空间id', + 'type' => 'string', + 'example' => '1', + ], + 'user_data' => [ + 'title' => '用户自定义数据', + 'description' => '用户自定义数据', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者', + 'type' => 'string', + 'example' => 'user1', + ], + ], + ], + 'UserExtraItem' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Domain ID', + 'type' => 'string', + 'example' => 'hz999', + ], + 'user_id' => [ + 'title' => '用户 ID', + 'type' => 'string', + 'example' => 'ccpuserid', + ], + 'avatar' => [ + 'title' => '头像', + 'type' => 'string', + 'example' => 'http://a.b.c/ccp.jpg', + ], + 'created_at' => [ + 'title' => '用户创建时间', + 'type' => 'string', + 'example' => '1567407718386', + ], + 'updated_at' => [ + 'title' => '用户修改时间', + 'type' => 'string', + 'example' => '1567407718386', + ], + 'email' => [ + 'title' => '邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'nick_name' => [ + 'title' => '昵称', + 'type' => 'string', + 'example' => 'abc', + ], + 'phone' => [ + 'title' => '电话', + 'type' => 'string', + 'example' => '13700000000', + ], + 'phone_region' => [ + 'title' => '国家编码', + 'type' => 'string', + ], + 'role' => [ + 'title' => '角色', + 'type' => 'string', + 'example' => 'user', + ], + 'status' => [ + 'title' => '用户状态', + 'type' => 'string', + 'example' => 'enabled', + ], + 'user_name' => [ + 'title' => '用户名称', + 'type' => 'string', + 'example' => 'name', + ], + 'description' => [ + 'title' => '用户备注信息', + 'type' => 'string', + 'example' => 'ccp team user', + ], + 'default_drive_id' => [ + 'title' => '默认 Drive ID', + 'type' => 'string', + 'example' => '123', + ], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + 'deny_change_password_by_self' => [ + 'title' => '禁止用户自行修改密码', + 'type' => 'boolean', + ], + 'need_change_password_next_login' => [ + 'title' => '下次登录强制修改密码', + 'type' => 'boolean', + ], + 'creator' => [ + 'title' => 'creator', + 'type' => 'string', + 'example' => 'system', + ], + 'expired_at' => [ + 'title' => '用户过期时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => [ + '$ref' => '#/components/schemas/IDPermission', + ], + ], + 'is_sync' => [ + 'title' => 'is_sync', + 'type' => 'boolean', + ], + 'default_location' => [ + 'title' => 'default_location', + 'type' => 'string', + ], + 'last_login_time' => [ + 'title' => 'last_login_time', + 'type' => 'integer', + 'format' => 'int64', + ], + 'path_status' => [ + 'title' => 'path 开启状态', + 'type' => 'string', + ], + 'default_drive' => [ + '$ref' => '#/components/schemas/BaseDriveResponse', + ], + 'parent_group' => [ + 'title' => 'parent_group', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/BaseDriveResponse', + ], + ], + 'account' => [ + 'title' => 'account', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/AccountLinkInfo', + ], + ], + ], + ], + 'UserLogDetail' => [ + 'title' => '用户日志详情', + 'description' => '用户日志详情', + 'type' => 'object', + 'properties' => [ + 'phone' => [ + 'title' => '手机号', + 'type' => 'string', + ], + 'email' => [ + 'title' => '邮箱', + 'type' => 'string', + ], + 'name' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'role_id' => [ + 'title' => '角色类型', + 'type' => 'string', + ], + 'expired_at' => [ + 'title' => '过期时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'update_to' => [ + 'title' => '更新后的用户详情', + 'type' => 'object', + 'properties' => [ + 'phone' => [ + 'title' => '手机号', + 'type' => 'string', + ], + 'email' => [ + 'title' => '邮箱', + 'type' => 'string', + ], + 'name' => [ + 'title' => '用户名', + 'type' => 'string', + ], + 'role_id' => [ + 'title' => '角色类型', + 'type' => 'string', + ], + 'expired_at' => [ + 'title' => '过期时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'UserTag' => [ + 'title' => 'A short description of struct', + 'description' => '用户 tag', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key', + 'description' => 'key，不能为空，不能包含 #。单个元素中的 key 和 value 总长度不能超过 2000 字节', + 'type' => 'string', + 'required' => true, + 'example' => 'topic', + ], + 'value' => [ + 'title' => 'value', + 'description' => 'value', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'VideoMediaAudioStream' => [ + 'title' => '音频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'description' => '音频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '音频时长，单位为秒（s）。', + 'description' => '音频时长，单位为秒（s）。', + 'type' => 'string', + 'example' => '7704.573000', + ], + 'bit_rate' => [ + 'title' => '音频比特率，单位为比特每秒（bps）。', + 'description' => '音频比特率，单位为比特每秒（bps）。', + 'type' => 'string', + 'example' => '129280', + ], + 'code_name' => [ + 'title' => '音频编码模式。', + 'description' => '音频编码模式。', + 'type' => 'string', + 'example' => 'aac', + ], + ], + ], + 'VideoMediaMetadata' => [ + 'title' => '音视频信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'description' => '视频元数据', + 'type' => 'object', + 'properties' => [ + 'width' => [ + 'title' => '视频画面宽度，单位为像素（px）。', + 'description' => '视频画面宽度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'height' => [ + 'title' => '视频画面高度，单位为像素（px）。', + 'description' => '视频画面高度，单位为像素（px）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'video_media_video_stream' => [ + 'title' => '视频流源信息。', + 'description' => '视频流源信息。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/VideoMediaVideoStream', + ], + ], + 'video_media_audio_stream' => [ + 'title' => '音频流源信息。', + 'description' => '音频流源信息。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/VideoMediaAudioStream', + ], + ], + ], + ], + 'VideoMediaVideoStream' => [ + 'title' => '视频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'description' => '视频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '视频流持续时长，单位为秒（s）。', + 'description' => '视频流持续时长，单位为秒（s）。', + 'type' => 'string', + 'example' => '22.88', + ], + 'bitrate' => [ + 'title' => '视频流比特率，单位为比特率每秒（bps）。', + 'description' => '视频流比特率，单位为比特率每秒（bps）。', + 'type' => 'string', + 'example' => '108420', + ], + 'code_name' => [ + 'title' => '视频编码模式。', + 'description' => '视频编码模式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'frame_count' => [ + 'title' => '视频帧数。', + 'description' => '视频帧数。', + 'type' => 'string', + 'example' => '90', + ], + ], + ], + 'VideoPreviewPlayInfo' => [ + 'title' => '播放信息', + 'description' => '播放信息', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'title' => '所属分类', + 'description' => '所属分类', + 'type' => 'string', + 'example' => 'quick_video', + ], + 'meta' => [ + 'title' => '视频元信息', + 'description' => '视频元信息', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '视频长度', + 'description' => '视频长度', + 'type' => 'number', + 'format' => 'double', + 'example' => '4.2898', + ], + 'width' => [ + 'title' => '视频宽度', + 'description' => '视频宽度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1920', + ], + 'height' => [ + 'title' => '视频高度', + 'description' => '视频高度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + ], + ], + 'live_transcoding_task_list' => [ + 'title' => '播放信息', + 'description' => '播放信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'description' => '模板id', + 'type' => 'string', + 'example' => '264_480p', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态。'."\n" + .'枚举值如下：'."\n" + .'- finished, 索引完成，可以获取到url'."\n" + .'- running, 正在索引，请稍等片刻重试'."\n" + .'- failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'type' => 'string', + 'example' => 'finished', + ], + 'url' => [ + 'title' => '播放地址', + 'description' => '播放地址', + 'type' => 'string', + 'example' => 'https://example.data.aliyunpds.com/lt/xxx/media.m3u8', + ], + 'keep_original_resolution' => [ + 'title' => '是否保持原分辨率', + 'description' => '是否保持原分辨率', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + 'quick_video_list' => [ + 'title' => '播放信息', + 'description' => '播放信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'description' => '模板id', + 'type' => 'string', + 'example' => '264_480p', + ], + 'status' => [ + 'title' => '状态', + 'description' => '枚举值如下：'."\n" + .'- finished, 索引完成，可以获取到url'."\n" + .'- running, 正在索引，请稍等片刻重试'."\n" + .'- failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'type' => 'string', + 'example' => 'finished', + ], + 'url' => [ + 'title' => '播放地址', + 'description' => '播放地址', + 'type' => 'string', + 'example' => 'https://example.data.aliyunpds.com/qv/xxx/media.m3u8', + ], + ], + ], + ], + 'offline_video_transcoding_list' => [ + 'title' => '离线转码播放信息', + 'description' => '离线转码播放信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板 ID', + 'description' => '模板 ID', + 'type' => 'string', + 'example' => '264_1080p', + ], + 'status' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'example' => 'finished', + ], + 'keep_original_resolution' => [ + 'title' => '转码视频是否和源视频同分辨率', + 'description' => '转码视频是否和源视频同分辨率', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'url' => [ + 'title' => '播放地址', + 'description' => '播放地址', + 'type' => 'string', + 'example' => 'https://example.data.aliyunpds.com/xxx/master.mp4'."\n", + ], + ], + ], + ], + 'live_transcoding_subtitle_task_list' => [ + 'title' => '边转边播字幕信息', + 'description' => '边转边播字幕信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + ], + ], + 'quick_video_subtitle_list' => [ + 'title' => '快速转码字幕信息', + 'description' => '快速转码字幕信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + ], + ], + 'offline_video_transcoding_subtitle_list' => [ + 'title' => '离线转码字幕信息', + 'description' => '离线转码字幕信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + ], + ], + 'master_url' => [ + 'title' => 'master m3u8 的播放链接', + 'description' => 'master m3u8 的播放链接', + 'type' => 'string', + 'example' => 'https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8', + ], + ], + ], + 'VideoPreviewPlayMeta' => [ + 'title' => '播放元信息', + 'description' => '播放元信息', + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'title' => '视频元信息', + 'description' => '视频元信息', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '视频长度', + 'description' => '视频长度', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + 'width' => [ + 'title' => '视频宽度', + 'description' => '视频宽度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1280', + ], + 'height' => [ + 'title' => '视频高度', + 'description' => '视频高度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '720', + ], + ], + ], + 'live_transcoding_task_list' => [ + 'title' => '边转边播任务状态', + 'description' => '边转边播任务状态', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'description' => '模板id', + 'type' => 'string', + 'example' => '264_720p', + ], + 'status' => [ + 'title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'description' => '状态。'."\n" + .'枚举值如下：'."\n" + .'- finished, 索引完成，可以获取到url'."\n" + .'- running, 正在索引，请稍等片刻重试'."\n" + .'- failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => 'running', + 'finished' => 'finished', + 'failed' => 'failed', + ], + 'example' => 'finished', + ], + 'keep_original_resolution' => [ + 'title' => '是否保持原分辨率', + 'description' => '是否保持原分辨率', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + 'category' => [ + 'title' => '所属分类', + 'description' => '所属分类', + 'type' => 'string', + 'example' => 'live_transcoding', + ], + 'quick_video_list' => [ + 'title' => '快速转码任务状态', + 'description' => '快速转码任务状态', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'description' => '模板id', + 'type' => 'string', + 'example' => '264_720p', + ], + 'status' => [ + 'title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'description' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'type' => 'string', + 'example' => 'finished', + ], + ], + ], + ], + 'offline_video_transcoding_list' => [ + 'title' => '离线转码任务状态', + 'description' => '离线转码任务状态', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板id', + 'description' => '模板id', + 'type' => 'string', + 'example' => '264_720p', + ], + 'status' => [ + 'title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'description' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', + 'type' => 'string', + 'example' => 'finished', + ], + 'keep_original_resolution' => [ + 'title' => '是否保持原分辨率', + 'description' => '是否保持原分辨率', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'VideoPreviewSubtitleInfo' => [ + 'title' => '字幕任务信息', + 'description' => '字幕任务信息', + 'type' => 'object', + 'properties' => [ + 'language' => [ + 'title' => '字幕语言', + 'description' => '字幕语言', + 'type' => 'string', + 'example' => 'en', + ], + 'status' => [ + 'title' => '字幕任务状态', + 'description' => '字幕任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'finished' => 'finished', + 'failed' => 'failed', + ], + 'example' => 'finished', + ], + 'url' => [ + 'title' => '字幕 URL', + 'description' => '字幕 URL', + 'type' => 'string', + 'example' => 'https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt', + ], + ], + ], + 'View' => [ + 'title' => 'view 详情', + 'type' => 'object', + 'properties' => [ + 'view_id' => [ + 'title' => 'view id', + 'type' => 'string', + ], + 'category' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'owner' => [ + 'title' => '所有者', + 'type' => 'string', + ], + 'name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'file_count' => [ + 'title' => '所添加文件数量', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ex_fields_info' => [ + 'title' => '额外属性', + 'type' => 'object', + ], + ], + ], + 'ViewFile' => [ + 'title' => 'view file 详情', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'type' => 'string', + ], + 'drive_id' => [ + 'title' => '空间id', + 'type' => 'string', + ], + 'file_id' => [ + 'title' => '文件id', + 'type' => 'string', + ], + 'name' => [ + 'title' => '名称', + 'type' => 'string', + ], + 'type' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'content_type' => [ + 'title' => '内容类型', + 'type' => 'string', + ], + 'created_at' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'updated_at' => [ + 'title' => '修改时间', + 'type' => 'string', + ], + 'description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'trashed_at' => [ + 'title' => '放入回收站时间', + 'type' => 'string', + ], + 'file_extension' => [ + 'title' => '文件扩展', + 'type' => 'string', + ], + 'hidden' => [ + 'title' => '是否隐藏', + 'type' => 'boolean', + ], + 'size' => [ + 'title' => '大小', + 'type' => 'integer', + 'format' => 'int64', + ], + 'starred' => [ + 'title' => '是否收藏', + 'type' => 'boolean', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + ], + 'labels' => [ + 'title' => '标签', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'upload_id' => [ + 'title' => '上传id', + 'type' => 'string', + ], + 'parent_file_id' => [ + 'title' => '父文件夹id', + 'type' => 'string', + ], + 'crc64_hash' => [ + 'title' => 'crc64', + 'type' => 'string', + ], + 'content_hash' => [ + 'title' => '内容hash', + 'type' => 'string', + ], + 'content_hash_name' => [ + 'title' => '内容hash算法名', + 'type' => 'string', + ], + 'download_url' => [ + 'title' => '下载链接', + 'type' => 'string', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'type' => 'string', + ], + 'category' => [ + 'title' => '分类', + 'type' => 'string', + ], + 'local_created_at' => [ + 'title' => '文件本地创建时间', + 'type' => 'string', + ], + 'local_modified_at' => [ + 'title' => '文件本地修改时间', + 'type' => 'string', + ], + 'revision_id' => [ + 'title' => '版本id', + 'type' => 'string', + ], + 'investigation_info' => [ + 'title' => '审核信息', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '审核状态', + 'type' => 'integer', + 'format' => 'int64', + ], + 'suggestion' => [ + 'title' => '审核建议执行的操作', + 'type' => 'string', + ], + ], + ], + 'thumbnail_urls' => [ + 'title' => '返回的缩略图信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'view_id' => [ + 'title' => 'view id', + 'type' => 'string', + ], + 'joined_at' => [ + 'title' => '加入 view 时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'file_revision_id' => [ + 'title' => '文件版本号', + 'type' => 'string', + ], + 'fields' => [ + 'title' => 'view 相关属性', + 'type' => 'object', + ], + ], + ], + 'WatermarkEnableConfig' => [ + 'title' => 'WatermarkEnableConfig', + 'type' => 'object', + 'properties' => [ + 'enable_doc_preview' => [ + 'title' => 'enable_doc_preview', + 'type' => 'boolean', + ], + 'display_access_user_name' => [ + 'title' => 'display_access_user_name', + 'type' => 'boolean', + ], + 'display_shareLink_creator_name' => [ + 'title' => 'display_shareLink_creator_name', + 'type' => 'boolean', + ], + 'display_custom_text' => [ + 'title' => 'display_custom_text', + 'type' => 'string', + ], + ], + ], + 'WxTrustedDomainConfig' => [ + 'title' => 'WxTrustedDomainConfig', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'content' => [ + 'title' => 'content', + 'type' => 'string', + ], + 'show' => [ + 'title' => 'show', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateDomain' => [ + 'summary' => '创建 domain。', + 'path' => '/v2/domain/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'parent_domain_id' => [ + 'description' => '父 domain id'."\n" + .'如果需要创建子 domain，可以设置该值，一般情况下不需要创建。'."\n" + .'如果需要针对 PDS 做二次运营，可以联系 PDS 官网客服进行咨询。', + 'type' => 'string', + 'required' => false, + 'example' => 'bj1', + ], + 'domain_name' => [ + 'description' => 'domain 名称', + 'type' => 'string', + 'required' => true, + 'example' => 'cloud drive', + ], + 'description' => [ + 'description' => 'domain 描述', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud drive dev', + ], + 'init_drive_enable' => [ + 'description' => '是否开通默认网盘。为true则所有用户在第一次登录后都默认分配一个网盘。默认false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'init_drive_size' => [ + 'description' => 'init\\_drive\\_enable 为true时必选。 创建用户时，默认网盘的大小，单位：Bytes。'."\n" + .'默认为 0，此时创建的 drive 大小为0，不可以上传文件，如果需要初始化 drive， 请设置该值。'."\n" + .'-1则表示不限大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1073741824', + ], + 'user_count_quota' => [ + 'description' => '用户数配额，表示该 domain 允许创建的用户数量，为0表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + 'size_quota' => [ + 'description' => '容量配额，表示 domain 下所有 drive 的总quota 大小，0 表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1099511627776', + ], + 'store_redundancy_type' => [ + 'description' => '指定存储冗余类型。枚举值： '."\n" + .'+ LRS：本地冗余'."\n" + .'+ ZRS：同城冗余', + 'type' => 'string', + 'required' => false, + 'example' => 'LRS', + 'enum' => [], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '创建的域信息', + '$ref' => '#/components/schemas/Domain', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n}","type":"json"}]', + 'title' => '创建Domain', + 'description' => '如果您需要基于 PDS 做二次运营，并想针对您的租户做一些细粒度控制，此时可以使用 PDS 的父子 Domain 功能。'."\n" + .'详情：请联系官方钉钉群进行咨询：23146118', + ], + 'GetDomain' => [ + 'summary' => '获取Domain信息。', + 'path' => '/v2/domain/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => 'domain id', + 'type' => 'string', + 'required' => true, + 'example' => 'bj1', + ], + 'get_quota_used' => [ + 'description' => '是否需要获取domain的已用quota，默认为false。当domain容量配额size_quota大于0时，传true可获取domain已用容量配额。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'fields' => [ + 'description' => '需要获取的 domain 属性字段，英文逗号分隔，为空代表不获取任何枚举字段', + 'type' => 'string', + 'required' => false, + 'example' => 'file_category', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'domain 信息', + '$ref' => '#/components/schemas/Domain', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n}","type":"json"}]', + 'title' => '获取Domain', + ], + 'UpdateDomain' => [ + 'summary' => '更新 domain。', + 'path' => '/v2/domain/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => 'domain id', + 'type' => 'string', + 'required' => true, + 'example' => 'bj1', + ], + 'domain_name' => [ + 'description' => 'domain 名称', + 'type' => 'string', + 'required' => false, + 'example' => '你好企业网盘', + ], + 'description' => [ + 'description' => 'domain 描述', + 'type' => 'string', + 'required' => false, + 'example' => '你好企业网盘调试环境', + ], + 'init_drive_enable' => [ + 'description' => '是否开通默认网盘。为true则所有用户在第一次登录后都默认分配一个网盘。默认false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'init_drive_size' => [ + 'description' => 'init\\_drive\\_enable 为true时必选。 创建用户时，默认网盘的大小，单位：Bytes。'."\n" + .'默认为 0，此时创建的 drive 大小为0，不可以上传文件，如果需要初始化 drive， 请设置该值。'."\n" + .'-1则表示不限大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1073741824', + ], + 'user_count_quota' => [ + 'description' => 'domain 总用户数限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + 'size_quota' => [ + 'description' => '容量配额，表示 domain 下所有 drive 的总quota 大小，0 表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1099511627776', + ], + 'published_app_access_strategy' => [ + 'description' => 'App 访问策略', + 'required' => false, + '$ref' => '#/components/schemas/AppAccessStrategy', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '更新后的 domain 信息', + '$ref' => '#/components/schemas/Domain', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n}","type":"json"}]', + 'title' => '更新Domain', + ], + 'ListDomains' => [ + 'summary' => '列举Domain列表。', + 'path' => '/v2/domain/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'parent_domain_id' => [ + 'description' => '父 domain id', + 'type' => 'string', + 'required' => false, + 'example' => 'bj1', + ], + 'marker' => [ + 'description' => '分页 marker，"" 表示从头开始。该接口会返回 next\\_marker，可将 next\\_marker 设置该值来遍历所有 domain 信息', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '本次分页获取的数量，默认 50，不可超过 100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + 'service_code' => [ + 'description' => '服务代码，默认为pds'."\n" + ."\n" + .'- edm（企业版）'."\n" + .'- pds（开发版）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'pds' => 'pds', + 'edm' => 'edm', + ], + 'example' => 'pds', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的 domain 列表', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '返回的 domain 列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个 domain 信息', + '$ref' => '#/components/schemas/Domain', + ], + ], + 'next_marker' => [ + 'description' => '用作下次遍历的 marker', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举Domain', + ], + 'SearchDomains' => [ + 'summary' => '搜索 domain', + 'path' => '/v2/domain/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '要搜索的 domain 名称，支持模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => '你好网盘', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[0,100\\]，默认100'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + 'order_by' => [ + 'description' => '排序规则，当前仅支持：'."\n" + .'created_at，创建时间', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'domain 列表以及遍历 marker', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '搜索命中的 domain 列表', + 'type' => 'array', + 'items' => [ + 'description' => 'domain 信息', + '$ref' => '#/components/schemas/Domain', + ], + ], + 'next_marker' => [ + 'description' => '用作下次遍历的 marker', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '搜索Domain', + ], + 'DeleteDomain' => [ + 'summary' => '删除 domain', + 'path' => '/v2/domain/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => 'domain id', + 'type' => 'string', + 'required' => false, + 'example' => 'bj1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除Domain', + ], + 'Authorize' => [ + 'summary' => 'OAuth2.0请求授权。', + 'path' => '/v2/oauth/authorize', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'client_id', + 'in' => 'query', + 'schema' => [ + 'description' => '创建App时返回的AppID', + 'type' => 'string', + 'required' => true, + 'example' => '47eUHhrzgWBvlLWj', + ], + ], + [ + 'name' => 'redirect_uri', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址（创建App时填写的回调地址）。请使用urlencode对链接进行处理', + 'type' => 'string', + 'required' => true, + 'example' => 'https%3A%2F%2Fwww.aliyunpds.com%2Fsign%2Fcallback', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '申请的权限列表, 默认为所有权限', + 'type' => 'array', + 'items' => [ + 'description' => '当前仅支持获取App的所有权限，可以传all或者不传此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'required' => false, + ], + ], + [ + 'name' => 'response_type', + 'in' => 'query', + 'schema' => [ + 'description' => '返回类型, 只能填写code', + 'type' => 'string', + 'required' => true, + 'example' => 'code', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义字段，会在请求授权成功后的callback带回', + 'type' => 'string', + 'required' => false, + 'example' => 'customdata', + ], + ], + [ + 'name' => 'login_type', + 'in' => 'query', + 'schema' => [ + 'description' => '认证方式，目前支持以下取值：'."\n" + ."\n" + .'- default （PDS提供的默认登录页面，集成了所有登录方式）'."\n" + ."\n" + .'- ding （PC钉钉扫码登录）'."\n" + ."\n" + .'- ding\\_sns （手机钉钉账号密码登录）'."\n" + ."\n" + .'- ram （阿里云子账号登录）'."\n" + ."\n" + .'- wechat（企业微信扫码登录）'."\n" + ."\n" + .'- wechat\\_app（企业微信内免登）', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'hide_consent', + 'in' => 'query', + 'schema' => [ + 'description' => '是否隐藏同意页面', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 302 => [ + 'headers' => [ + 'location' => [ + 'schema' => [ + 'title' => '重定向的登陆页地址，用户需要在此页面完成认证', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'OAuth请求授权', + 'description' => '<props="china">详细使用方法参考用户指南：[用户指南链接](https://help.aliyun.com/document_detail/175894.html)。</props>'."\n" + ."\n" + .'<props="intl">详细使用方法参考用户指南：[用户指南链接](https://www.alibabacloud.com/help/zh/pds/latest/oauth2-for-web-server-app?spm=a2c63.p38356.0.0.4cce4fccEyosuB)。</props>', + ], + 'Token' => [ + 'summary' => 'OAuth2.0授权流程的获取访问令牌。', + 'path' => '/v2/oauth/token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'grant_type', + 'in' => 'formData', + 'schema' => [ + 'description' => '授权类型，有以下取值：'."\n" + ."\n" + .'authorization\\_code （通过认证完成后获取的code来换取token）'."\n" + ."\n" + .'refresh\\_token（通过上次授权获取的refresh_token来获取token）'."\n" + ."\n" + .'urn:ietf:params:oauth:grant-type:jwt-bearer（通过JWT方式获取token）', + 'type' => 'string', + 'required' => true, + 'example' => 'refresh_token', + ], + ], + [ + 'name' => 'code', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证完成后回调地址中携带的code，当grant\\_type为authorization\\_code时，此参数必传'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0045157fa8e24f4f9a0d9e3ff158c1e0', + ], + ], + [ + 'name' => 'redirect_uri', + 'in' => 'formData', + 'schema' => [ + 'description' => '填写发起authorize时传入的redirect\\_uri，当grant\\_type为authorization\\_code时必填'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyun.com/pds'."\n", + ], + ], + [ + 'name' => 'client_id', + 'in' => 'formData', + 'schema' => [ + 'description' => '在阿里云PDS控制台申请的App对应的ID'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1Zu***flH', + ], + ], + [ + 'name' => 'client_secret', + 'in' => 'formData', + 'schema' => [ + 'description' => '在阿里云PDS控制台申请的App对应的Secret，WebServer类型的App必填此参数'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '80D***3i5'."\n", + ], + ], + [ + 'name' => 'refresh_token', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于刷新Token的令牌，当grant\\_type为refresh\\_token时此参数必传'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '399623e13353490391266c7d48a13ed1', + ], + ], + [ + 'name' => 'assertion', + 'in' => 'formData', + 'schema' => [ + 'description' => '通过JWT私钥签名的字符串，里面包含待授权的用户信息和授权参数，结构参考JWTPayload。当grant_type为urn:ietf:params:oauth:grant-type:jwt-bearer时此参数必填。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ey***asd'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '访问令牌信息', + '$ref' => '#/components/schemas/Token', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"expires_in\\": 0,\\n \\"token_type\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"expire_time\\": \\"\\",\\n \\"is_first_login\\": true,\\n \\"device_id\\": \\"\\",\\n \\"device_name\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"default_sbox_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"pin_setup\\": true,\\n \\"need_rp_verify\\": true,\\n \\"state\\": \\"\\",\\n \\"exist_link\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\"\\n }\\n ],\\n \\"need_link\\": true,\\n \\"device_info\\": \\"\\",\\n \\"device_signature\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取访问令牌', + 'description' => '<props="china">详细使用方法参考用户指南：[用户指南链接](https://help.aliyun.com/document_detail/175894.html)。</props>'."\n" + ."\n" + .'<props="china">JWT方式登录参考文档：[JWT登录链接](https://help.aliyun.com/document_detail/175893.html)。</props>'."\n" + ."\n" + .'<props="intl">详细使用方法参考用户指南：[用户指南链接](https://www.alibabacloud.com/help/zh/pds/latest/oauth2-for-web-server-app?spm=a2c63.p38356.0.0.267148fbJdRB0P)。</props>'."\n" + ."\n" + .'<props="intl">JWT方式登录参考文档：[JWT登录链接](https://www.alibabacloud.com/help/zh/pds/latest/jwt-application?spm=a2c63.p38356.0.0.45ab5f06NnPJqj)。</props>', + ], + 'GetLinkInfoByUserId' => [ + 'summary' => '根据用户ID获取账号信息。', + 'path' => '/v2/account/get_link_info_by_user_id', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '待查询的UserID', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'title' => 'items', + 'description' => '用户账号信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户账号信息', + '$ref' => '#/components/schemas/AccountLinkInfo', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"authentication_type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"display_name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"last_login_time\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '根据用户ID获取账号信息', + ], + 'LinkAccount' => [ + 'summary' => '绑定账号。', + 'path' => '/v2/account/link', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '待绑定的UserID', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + 'type' => [ + 'description' => '账号类型'."\n" + ."\n" + .'- mobile：手机号'."\n" + ."\n" + .'- email：邮箱'."\n" + ."\n" + .'- ding：钉钉'."\n" + ."\n" + .'- ram：阿里云RAM子账号'."\n" + ."\n" + .'- wechat：企业微信'."\n" + ."\n" + .'- ldap：LDAP账号'."\n" + ."\n" + .'- custom：自定义账号', + 'type' => 'string', + 'required' => true, + 'example' => 'ding', + ], + 'identity' => [ + 'description' => '账号的唯一标识，比如手机号', + 'type' => 'string', + 'required' => true, + 'example' => 'eyy***', + ], + 'extra' => [ + 'description' => '账号唯一标识的附加信息，比如当账号为手机号时，此字段填手机的区域编码，比如中国大陆为86，不填写默认为86', + 'type' => 'string', + 'required' => false, + 'example' => '86', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回用户的授权Token信息', + '$ref' => '#/components/schemas/Token', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"expires_in\\": 0,\\n \\"token_type\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"expire_time\\": \\"\\",\\n \\"is_first_login\\": true,\\n \\"device_id\\": \\"\\",\\n \\"device_name\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"default_sbox_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"pin_setup\\": true,\\n \\"need_rp_verify\\": true,\\n \\"state\\": \\"\\",\\n \\"exist_link\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\"\\n }\\n ],\\n \\"need_link\\": true,\\n \\"device_info\\": \\"\\",\\n \\"device_signature\\": \\"\\"\\n}","type":"json"}]', + 'title' => '绑定账号', + ], + 'GetLinkInfo' => [ + 'summary' => '获取账号信息。', + 'path' => '/v2/account/get_link_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '账号类型'."\n" + ."\n" + .'- mobile：手机号'."\n" + ."\n" + .'- email：邮箱'."\n" + ."\n" + .'- ding：钉钉'."\n" + ."\n" + .'- ram：阿里云RAM子账号'."\n" + ."\n" + .'- wechat：企业微信'."\n" + ."\n" + .'- ldap：LDAP账号'."\n" + ."\n" + .'- custom：自定义账号', + 'type' => 'string', + 'required' => true, + 'example' => 'mobile', + ], + 'identity' => [ + 'description' => '账号的唯一标识，比如手机号', + 'type' => 'string', + 'required' => true, + 'example' => '130***', + ], + 'extra' => [ + 'description' => '账号唯一标识的附加信息，比如当账号为手机号时，此字段填手机的区域编码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回用户账号信息', + '$ref' => '#/components/schemas/AccountLinkInfo', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"authentication_type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"display_name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"last_login_time\\": 0\\n}","type":"json"}]', + 'title' => '获取账号信息', + ], + 'UnLinkAccount' => [ + 'summary' => '取消账号绑定。', + 'path' => '/v2/account/unlink', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '用户标识', + 'type' => 'string', + 'required' => true, + 'example' => 'uid1', + ], + 'type' => [ + 'description' => '账号类型'."\n" + ."\n" + .'mobile：手机号'."\n" + ."\n" + .'email：邮箱'."\n" + ."\n" + .'ding：钉钉'."\n" + ."\n" + .'ram：阿里云RAM子账号'."\n" + ."\n" + .'wechat：企业微信'."\n" + ."\n" + .'ldap：LDAP账号'."\n" + ."\n" + .'custom：自定义账号', + 'type' => 'string', + 'required' => true, + 'example' => 'mobile', + ], + 'identity' => [ + 'description' => '账号的唯一标识，比如手机号', + 'type' => 'string', + 'required' => true, + 'example' => '139****'."\n", + ], + 'extra' => [ + 'description' => '账号唯一标识的附加信息，比如当账号为手机号时，此字段填手机的区域编码，比如中国大陆为86，不填写默认为86', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消账号关联', + ], + 'CreateGroup' => [ + 'summary' => '创建群组。', + 'path' => '/v2/group/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_name' => [ + 'description' => '群组名，长度1～128个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'test group', + ], + 'description' => [ + 'description' => '描述信息，长度0～1024个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'test group description', + ], + 'is_root' => [ + 'description' => '是否是根群组，根群组不能加入其他任何群组，一般用于组织架构的顶层组织', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'parent_group_id' => [ + 'description' => '需要加入的父群组ID，传入此字段时，创建完群组后，系统会将此群组自动加入到指定的父群组', + 'type' => 'string', + 'required' => false, + 'example' => '2e43ec8427dd45f19431b7504649a1b3', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '新创建的群组信息', + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '创建群组', + ], + 'UpdateGroup' => [ + 'summary' => '根据群组ID定位到指定的群组，并修改群组信息。', + 'path' => '/v2/group/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '待修改的群组ID', + 'type' => 'string', + 'required' => true, + 'example' => '2e43ec8427dd45f19431b7504649a1b4', + ], + 'group_name' => [ + 'description' => '修改后的群组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test group', + ], + 'description' => [ + 'description' => '修改后的描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test group description', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '修改后的群组信息', + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '修改群组信息', + ], + 'GetGroup' => [ + 'summary' => '获取群组信息。', + 'path' => '/v2/group/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '待获取的群组ID', + 'type' => 'string', + 'required' => true, + 'example' => '2e43ec8427dd45f19431b7504649a1b1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '群组信息', + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '获取群组信息', + ], + 'ListGroup' => [ + 'summary' => '列举群组。', + 'path' => '/v2/group/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限定此次返回资源的数量。如果不设定，默认返回100，最大不能超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。 默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '群组列表', + 'type' => 'array', + 'items' => [ + 'description' => '群组信息', + '$ref' => '#/components/schemas/Group', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举群组', + ], + 'DeleteGroup' => [ + 'summary' => '删除群组接口， 在删除群组前，需保证群组下没有其他群组或用户，否则会导致删除失败。', + 'path' => '/v2/group/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '待删除的群组ID', + 'type' => 'string', + 'required' => true, + 'example' => 'g123', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除群组', + ], + 'AddGroupMember' => [ + 'summary' => '添加成员到群组。', + 'path' => '/v2/group/add_member', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '目标群组ID，表示将成员添加到目标群组下', + 'type' => 'string', + 'required' => true, + 'example' => '3e5***2c2', + ], + 'member_type' => [ + 'description' => '成员类型，当前只能添加用户，群组可以在创建时直接选择加入的父群组'."\n" + ."\n" + .'- user（用户）'."\n" + ."\n\n" + .'注意：群组只能作为一个群组的成员，不能同时成为多个群组的成员。 用户可以同时成为多个群组的成员', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'member_id' => [ + 'description' => '成员ID， 当member\\_type为user时，此字段填对应的userID。 ', + 'type' => 'string', + 'required' => true, + 'example' => '2e4***1b1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '添加群组成员', + ], + 'RemoveGroupMember' => [ + 'summary' => '从群组移除成员。', + 'path' => '/v2/group/remove_member', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '目标群组ID，表示从哪个群组下移除成员', + 'type' => 'string', + 'required' => true, + 'example' => '3e5***2c2', + ], + 'member_type' => [ + 'description' => '成员类型，当前只能移除用户，群组移除可以通过删除群组完成'."\n" + ."\n" + .'- user（用户）'."\n" + ."\n" + .'注意：群组只能作为一个群组的成员，不能同时成为多个群组的成员。 用户可以同时成为多个群组的成员', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + 'member_id' => [ + 'description' => '成员ID， 当member\\_type为user时，此字段填对应的userID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2e4***1b1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '移除群组成员', + ], + 'ListGroupMember' => [ + 'summary' => '列举团队成员。', + 'path' => '/v2/group/list_member', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '目标群组ID，表示将列举哪个群组下的成员', + 'type' => 'string', + 'required' => true, + 'example' => '3e5***2c2', + ], + 'member_type' => [ + 'description' => '列举的成员类型，不传则两种都返回'."\n" + ."\n" + .'- user（用户）'."\n" + ."\n" + .'- group（群组）'."\n" + ."\n" + .'注意：群组只能作为一个群组的成员，不能同时成为多个群组的成员。 用户可以同时成为多个群组的成员', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围[1,100]。'."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。'."\n" + .'<br>默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'user_items' => [ + 'description' => '用户列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + 'group_items' => [ + 'description' => '群组列表', + 'type' => 'array', + 'items' => [ + 'description' => '群组信息', + '$ref' => '#/components/schemas/Group', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"user_items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n }\\n ],\\n \\"group_items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1\\"\\n}","type":"json"}]', + 'title' => '列举群组成员', + ], + 'CreateUser' => [ + 'summary' => '创建用户。', + 'path' => '/v2/user/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'title' => '用户id', + 'description' => '用户id，最长64字符，不能包含字符#', + 'type' => 'string', + 'required' => true, + 'example' => 'pdsuserid1', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'nick_name' => [ + 'title' => '用户昵称', + 'description' => '用户昵称，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'pdsuer', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'status' => [ + 'title' => '用户状态', + 'description' => '用户状态，默认为enabled'."\n" + ."\n" + .'- enabled（正常）'."\n" + ."\n" + .'- disabled（禁止登录）', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + 'default' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'role' => [ + 'title' => '角色', + 'description' => '角色，默认为user'."\n" + ."\n" + .'- superadmin（超级管理员）'."\n" + ."\n" + .'- admin（管理员）'."\n" + ."\n" + .'- user（普通用户）'."\n" + ."\n" + .'如果当前domain支持subdomain。还可以支持 "subdomain\\_super_admin", "subdomain\\_admin”。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'subdomain_super_admin' => 'subdomain超级管理员', + 'subdomain_admin' => 'subdomain管理员', + 'superadmin' => '超级管理员', + 'admin' => '管理员', + 'user' => '普通用户', + ], + 'example' => 'user', + 'default' => 'user', + 'enum' => [ + 'user', + 'admin', + 'superadmin', + 'subdomain_admin', + 'subdomain_super_admin', + ], + ], + 'avatar' => [ + 'title' => '头像地址', + 'description' => '头像地址'."\n" + ."\n" + .'http形式时，以http:// 或https:// 作为前缀，参数长度最长4KB'."\n" + ."\n" + .'data形式时，以data://作为前缀，base64编码，参数长度最长300KB', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.b.c/pds.jpg', + ], + 'phone' => [ + 'title' => '电话', + 'description' => '电话', + 'type' => 'string', + 'required' => false, + 'example' => '13900001111', + ], + 'email' => [ + 'title' => '邮箱地址', + 'description' => '邮箱地址', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'user_data' => [ + 'description' => '用户自定义数据，最长1024字符', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => 'md', + ], + 'group_info_list' => [ + 'description' => '群组信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '群组id', + 'type' => 'string', + 'required' => false, + 'example' => 'g123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'user_name' => [ + 'title' => '用户名', + 'description' => '用户名，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'pdsusername', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'description' => [ + 'title' => '用户描述', + 'description' => '用户描述，最长1024字符', + 'type' => 'string', + 'required' => false, + 'example' => 'VIP用户', + 'maxLength' => 1024, + 'minLength' => 0, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'user_id' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => 'dingding_abc001', + ], + 'avatar' => [ + 'title' => '头像地址', + 'description' => '头像地址', + 'type' => 'string', + 'example' => 'http://aa.com/1.jpg', + ], + 'created_at' => [ + 'description' => '创建时间，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579768', + ], + 'updated_at' => [ + 'description' => '修改时间，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639762579768', + ], + 'nick_name' => [ + 'title' => '昵称', + 'description' => '昵称', + 'type' => 'string', + 'example' => '001', + ], + 'user_name' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'example' => 'pds', + ], + 'phone' => [ + 'title' => '电话', + 'description' => '电话', + 'type' => 'string', + 'example' => '13900001111', + ], + 'email' => [ + 'title' => '邮箱地址', + 'description' => '邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'role' => [ + 'title' => '角色', + 'description' => '角色'."\n" + ."\n" + .'- superadmin（超级管理员）'."\n" + ."\n" + .'- admin（管理员）'."\n" + ."\n" + .'- user（普通用户）', + 'type' => 'string', + 'enumValueTitles' => [ + 'superadmin' => '超级管理员', + 'admin' => '管理员', + 'user' => '普通用户', + ], + 'example' => 'admin', + ], + 'status' => [ + 'title' => '状态', + 'description' => '状态'."\n" + ."\n" + .'- disabled（禁止）'."\n" + ."\n" + .'- enabled（使能）', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '禁止', + 'enabled' => '使能', + ], + 'example' => 'enabled', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vipuser', + ], + 'default_drive_id' => [ + 'title' => '缺省空间id', + 'description' => '缺省空间id', + 'type' => 'string', + 'example' => '1', + ], + 'user_data' => [ + 'description' => '用户自定义数据', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'dog', + 'description' => '自定义项', + ], + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者', + 'type' => 'string', + 'example' => 'user1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"dingding_abc001\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"nick_name\\": \\"001\\",\\n \\"user_name\\": \\"pds\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"role\\": \\"admin\\",\\n \\"status\\": \\"enabled\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"user_data\\": {\\n \\"key\\": \\"dog\\"\\n },\\n \\"creator\\": \\"user1\\"\\n}","type":"json"}]', + 'title' => '创建用户', + ], + 'ImportUser' => [ + 'summary' => '导入用户。', + 'path' => '/v2/user/import', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'authentication_type' => [ + 'description' => '认证类型'."\n" + ."\n" + .'- mobile：手机号'."\n" + ."\n" + .'- email：邮箱'."\n" + ."\n" + .'- ding：钉钉'."\n" + ."\n" + .'- ram：阿里云RAM子账号'."\n" + ."\n" + .'- wechat：企业微信'."\n" + ."\n" + .'- ldap：LDAP账号'."\n" + ."\n" + .'- custom：自定义账号', + 'type' => 'string', + 'required' => true, + 'example' => 'mobile', + ], + 'identity' => [ + 'description' => '唯一身份标识', + 'type' => 'string', + 'required' => true, + 'example' => '130****', + ], + 'authentication_display_name' => [ + 'description' => '认证方式的显示名称', + 'type' => 'string', + 'required' => false, + 'example' => '10000', + ], + 'extra' => [ + 'description' => '额外信息'."\n" + ."\n" + .'authentication\\_type为mobile时，此字段为国家编号，不填默认86。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'nick_name' => [ + 'description' => '昵称', + 'type' => 'string', + 'required' => true, + 'example' => 'pdsuer', + ], + 'auto_create_drive' => [ + 'description' => '自动创建空间', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'drive_total_size' => [ + 'description' => '空间大小，不能小于-1，-1表示无限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10240', + ], + 'parent_group_id' => [ + 'description' => '加入到的分组id', + 'type' => 'string', + 'required' => false, + 'example' => 'g12', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '导入用户', + ], + 'UpdateUser' => [ + 'summary' => '修改用户信息。', + 'path' => '/v2/user/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '用户id，最长64字符，不能包含字符#', + 'type' => 'string', + 'required' => true, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'nick_name' => [ + 'description' => '用户昵称，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'pdsuer', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'status' => [ + 'description' => '用户状态'."\n" + ."\n" + .'- disabled（禁止）'."\n" + ."\n" + .'- enabled（使能）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => '禁止', + 'enabled' => '使能', + ], + 'example' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'role' => [ + 'description' => '角色'."\n" + ."\n" + .'- superadmin（超级管理员）'."\n" + ."\n" + .'- admin（管理员）'."\n" + ."\n" + .'- user（普通用户）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'superadmin' => '超级管理员', + 'admin' => '管理员', + 'user' => '普通用户', + ], + 'example' => 'user', + 'enum' => [ + 'user', + 'admin', + 'superadmin', + 'subdomain_admin', + 'subdomain_super_admin', + ], + ], + 'avatar' => [ + 'description' => '头像地址'."\n" + ."\n" + .'http形式时，以http:// 或https:// 作为前缀，参数长度最长4KB'."\n" + ."\n" + .'data形式时，以data://作为前缀，base64编码，参数长度最长300KB', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.b.c/pds.jpg', + ], + 'description' => [ + 'description' => '描述信息，最长1024字符', + 'type' => 'string', + 'required' => false, + 'example' => 'vip用户', + 'maxLength' => 1024, + 'minLength' => 0, + ], + 'phone' => [ + 'description' => '手机号', + 'type' => 'string', + 'required' => false, + 'example' => '13900001111', + ], + 'email' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'user_data' => [ + 'description' => '用户自定义数据，最长1024字符', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'test', + 'description' => '用户自定义数据', + ], + ], + 'group_info_list' => [ + 'description' => '群组信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '群组信息', + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => '群组id', + 'type' => 'string', + 'required' => false, + 'example' => 'g123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '修改用户信息', + ], + 'GetUser' => [ + 'summary' => '获取用户信息。', + 'path' => '/v2/user/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '用户id。'."\n" + .'使用AK方式访问时，该项必传；使用AccessToken方式访问时，该项不填写，取自己的用户信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => '获取用户信息', + ], + 'ListUser' => [ + 'summary' => '列举用户。', + 'path' => '/v2/user/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '查询数量，取值范围：1~100。默认值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'next_marker' => [ + 'title' => 'Id of the request', + 'description' => '下一页起始资源标识符, 最后一页该值为空', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'items' => [ + 'description' => '用户信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举用户', + ], + 'SearchUser' => [ + 'summary' => '搜索用户。', + 'path' => '/v2/user/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'nick_name' => [ + 'description' => '用户昵称，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'pdsuer', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'nick_name_for_fuzzy' => [ + 'description' => '昵称-模糊搜索，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'la', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'user_name' => [ + 'description' => '用户名称，最长128字符', + 'type' => 'string', + 'required' => false, + 'example' => 'pds', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'phone' => [ + 'description' => '手机号', + 'type' => 'string', + 'required' => false, + 'example' => '13900001111', + ], + 'email' => [ + 'description' => '邮箱地址', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'status' => [ + 'description' => '用户状态'."\n" + ."\n" + .'- disabled（禁止）'."\n" + ."\n" + .'- enabled（使能）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => '禁止', + 'enabled' => '使能', + ], + 'example' => 'enabled', + ], + 'role' => [ + 'description' => '角色'."\n" + ."\n" + .'- superadmin（超级管理员）'."\n" + ."\n" + .'- admin（管理员）'."\n" + ."\n" + .'- user（用户）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'superadmin' => '超级管理员', + 'admin' => '管理员', + 'user' => '用户', + ], + 'example' => 'user', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围为[1,100]，默认返回100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'next_marker' => [ + 'title' => 'Id of the request', + 'description' => '下一页起始资源标识符, 最后一页该值为空', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'items' => [ + 'description' => '用户信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息', + '$ref' => '#/components/schemas/User', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '搜索用户', + ], + 'DeleteUser' => [ + 'summary' => '删除用户。', + 'path' => '/v2/user/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '用户id', + 'type' => 'string', + 'required' => true, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除用户', + ], + 'CreateDrive' => [ + 'summary' => '创建空间。', + 'path' => '/v2/drive/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'drive_name' => [ + 'description' => '空间名称，最长 128 字符', + 'type' => 'string', + 'required' => true, + 'example' => '我的个人空间', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'owner' => [ + 'description' => '归属者ID', + 'type' => 'string', + 'required' => true, + 'example' => '3b3d7245c159488da17d081ad6c64687', + ], + 'owner_type' => [ + 'description' => '归属者类型，可选值如下：'."\n" + ."\n" + .'user：用户'."\n" + .'group：团队', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'user' => 'user', + 'group' => 'group', + ], + 'example' => 'user', + 'enum' => [ + 'user', + 'group', + ], + ], + 'description' => [ + 'description' => '描述信息，最长 1024 字符', + 'type' => 'string', + 'required' => false, + 'example' => 'vip空间', + 'maxLength' => 1024, + ], + 'drive_type' => [ + 'description' => '空间类型，当前只支持 normal', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => 'normal', + ], + 'example' => 'normal', + 'default' => 'normal', + 'enum' => [], + ], + 'status' => [ + 'description' => '状态，可选值如下：'."\n" + ."\n" + .'enabled：可用'."\n" + .'disabled：禁用'."\n" + ."\n" + .'默认为 enabled', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => 'disabled', + 'enabled' => 'enabled', + ], + 'example' => 'enabled', + 'default' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'total_size' => [ + 'description' => '总大小，单位为字节，默认不限大小', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1024', + ], + 'default' => [ + 'description' => '是否是默认空间，默认为 false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'drive_name' => [ + 'description' => '空间名称', + 'type' => 'string', + 'example' => '我的个人空间'."\n", + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'vip空间'."\n", + ], + 'owner' => [ + 'description' => '归属者ID', + 'type' => 'string', + 'example' => '3b3d7245c159488da17d081ad6c64687'."\n", + ], + 'owner_type' => [ + 'description' => '归属者类型', + 'type' => 'string', + 'example' => 'user', + ], + 'drive_type' => [ + 'description' => '空间类型', + 'type' => 'string', + 'example' => 'normal', + ], + 'used_size' => [ + 'description' => '使用空间大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'total_size' => [ + 'description' => '总空间大小，单位为字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'creator' => [ + 'description' => '创建者ID。', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'created_at' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-08-14T03:14:28.109Z', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'enabled', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"我的个人空间\\\\n\\",\\n \\"description\\": \\"vip空间\\\\n\\",\\n \\"owner\\": \\"3b3d7245c159488da17d081ad6c64687\\\\n\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"used_size\\": 1024,\\n \\"total_size\\": 1024,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"created_at\\": \\"2024-08-14T03:14:28.109Z\\",\\n \\"status\\": \\"enabled\\"\\n}","type":"json"}]', + 'title' => '创建空间', + 'description' => '创建空间前确保操作对应用户/团队未被分配空间。', + ], + 'UpdateDrive' => [ + 'summary' => '修改空间信息。', + 'path' => '/v2/drive/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'drive_name' => [ + 'description' => '空间名称，最长 128 字符', + 'type' => 'string', + 'required' => false, + 'example' => '我的个人空间', + 'maxLength' => 128, + ], + 'description' => [ + 'description' => '描述，最长 1024 字符', + 'type' => 'string', + 'required' => false, + 'example' => 'vip空间', + 'maxLength' => 1024, + ], + 'status' => [ + 'description' => '空间状态，可选值如下：'."\n" + ."\n" + .'enabled：可用'."\n" + .'disabled：禁用', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => '禁止', + 'enabled' => '使能', + ], + 'example' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'total_size' => [ + 'description' => '总大小，单位为字节，不限制大小时填 -1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10240', + ], + 'owner' => [ + 'description' => '归属者'."\n" + .'注意，当前只允许通过 ak 来修改个人 drive 的所有者。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => '修改空间信息', + ], + 'GetDrive' => [ + 'summary' => '获取空间信息。', + 'path' => '/v2/drive/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取空间信息', + ], + 'ListDrive' => [ + 'summary' => '列举空间。', + 'path' => '/v2/drive/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限定此次返回资源的数量，范围为 [1,100]，默认返回100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '100', + 'default' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'owner' => [ + 'description' => '归属者，不设置时返回所有 drive', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'owner_type' => [ + 'description' => '归属者类型，可选值如下：'."\n" + ."\n" + .'user：用户'."\n" + .'group：团队'."\n" + ."\n" + .'默认返回所有归属者类型的 drive', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + 'enum' => [ + 'user', + 'group', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '空间信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '空间信息', + '$ref' => '#/components/schemas/Drive', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举空间', + ], + 'GetDefaultDrive' => [ + 'summary' => '获取指定用户的缺省空间。', + 'path' => '/v2/drive/get_default_drive', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => '用户 id，AK 访问时必填，AccessToken 访问时可选（默认取 AccessToken 关联的用户 id）', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取缺省空间', + ], + 'ListMyDrives' => [ + 'summary' => '列举登录用户自己的空间列表。', + 'path' => '/v2/drive/list_my_drives', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限制返回的数量。默认为100，取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '100', + 'default' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'."\n", + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '空间信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '空间信息', + '$ref' => '#/components/schemas/Drive', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举我的空间', + ], + 'SearchDrive' => [ + 'summary' => '搜索空间。', + 'path' => '/v2/drive/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_name' => [ + 'description' => '空间名称', + 'type' => 'string', + 'required' => false, + 'example' => '我的个人空间', + ], + 'limit' => [ + 'description' => '异步调用的返回个数。默认返回100个，取值范围\\[1,100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '100', + 'default' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'owner' => [ + 'description' => '归属者', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'owner_type' => [ + 'description' => '归属者类型，可选值如下：'."\n" + ."\n" + .'user：用户'."\n" + .'group：团队', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + 'enum' => [ + 'user', + 'group', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '空间信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '空间信息', + '$ref' => '#/components/schemas/Drive', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '搜索空间', + ], + 'DeleteDrive' => [ + 'summary' => '删除空间。', + 'path' => '/v2/drive/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除空间', + ], + 'CreateFile' => [ + 'summary' => '创建文件或文件夹。', + 'path' => '/v2/file/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '文件或文件夹名称', + 'description' => '文件名称，按照 utf8 编码最长 1024 字节，不能包含 /', + 'type' => 'string', + 'required' => true, + 'example' => 'a.txt', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'type' => [ + 'title' => '类型', + 'description' => '文件类型，可选值如下：'."\n" + ."\n" + .'file：文件'."\n" + .'folder：文件夹', + 'type' => 'string', + 'required' => true, + 'example' => 'file', + 'enum' => [ + 'file', + 'folder', + ], + ], + 'parent_file_id' => [ + 'title' => '父文件夹id', + 'description' => '父目录id，上传到根目录时填写 root', + 'type' => 'string', + 'required' => true, + 'example' => 'fileid1', + ], + 'drive_id' => [ + 'title' => '用户空间id', + 'description' => '空间 id，除通过分享链接上传之外，必填', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'pattern' => '^[0-9]*$', + ], + 'share_id' => [ + 'title' => '共享id', + 'description' => '分享 id，当通过分享链接上传时必填', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'size' => [ + 'title' => '文件大小', + 'description' => '文件大小，单位为 byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1024', + ], + 'content_type' => [ + 'title' => '文件类型', + 'description' => '文件内容类型，默认值 application/oct-stream<props="china">，常见的 content_type 可以参考 OSS [《如何设置Content-Type（MIME）？》](https://help.aliyun.com/document_detail/39522.htm?spm=a2c4g.11186623.0.0.5a0b7dbb1TPnWF#concept-5041)。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'application/json', + ], + 'part_info_list' => [ + 'description' => '分片信息列表，最多 10000 个分片，当不填时，默认返回 1 个分片', + 'type' => 'array', + 'items' => [ + 'description' => '分片信息', + 'type' => 'object', + 'properties' => [ + 'part_number' => [ + 'description' => '分片序列号，从 1 开始', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'parallel_sha1_ctx' => [ + 'description' => '该分片前所有数据的SHA1上下文，该字段只在多分片并发上传的模式下有效', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'description' => '该分片前所有数据的SHA1上下文的第1-5个32位变量，该字段只在多分片并发上传的模式下有效', + 'type' => 'array', + 'items' => [ + 'description' => '该分片前所有数据的SHA1上下文的第1-5个32位变量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'part_offset' => [ + 'description' => '到上一个数据块为止的总长度，字节，需要为64的倍数，该字段只在多分片并发上传的模式下有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10240', + ], + ], + 'required' => false, + ], + 'content_md5' => [ + 'description' => '分片的 MD5, 需要在上传分片时校验分片的MD5时填写。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'ASKJDJSKDJJSJDJS', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'user_tags' => [ + 'title' => '用户打标', + 'description' => '用户自定义 tag，最多 1000 个 tag', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义 tag', + 'required' => false, + '$ref' => '#/components/schemas/UserTag', + ], + 'required' => false, + ], + 'hidden' => [ + 'description' => '是否隐藏，默认不隐藏', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '文件描述信息，最长 1024 字符，默认为空', + 'type' => 'string', + 'required' => false, + 'example' => '团队文件', + 'maxLength' => 1024, + ], + 'content_hash' => [ + 'title' => '内容hash', + 'description' => '文件内容 hash 值，需要根据 content_hash_name 指定的算法计算', + 'type' => 'string', + 'required' => false, + 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8941B', + ], + 'content_hash_name' => [ + 'title' => '内容hash算法名', + 'description' => '文件内容hash算法名，当前只支持 sha1', + 'type' => 'string', + 'required' => false, + 'example' => 'sha1', + 'enum' => [ + 'sha1', + ], + ], + 'pre_hash' => [ + 'description' => '使用预秒传功能时填写，为文件前1KB sha1值，当远端没有匹配上时，客户端无需再计算文件完整 sha1 去尝试秒传。', + 'type' => 'string', + 'required' => false, + 'example' => '7C4A8D09CA3762AF61E59520943DC26494F89411', + ], + 'check_name_mode' => [ + 'title' => '重命名模式', + 'description' => '同名文件处理模式，可选值如下：'."\n" + ."\n" + .'ignore：允许同名文件；'."\n" + ."\n" + .'auto_rename：当发现同名文件是，云端自动重命名，默认为追加当前时间点，如 xxx _20060102_150405；'."\n" + ."\n" + .'refuse：当云端存在同名文件时，拒绝创建新文件，返回客户端已存在同名文件的详细信息。'."\n" + ."\n" + .'默认为 ignore', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'refuse' => 'refuse', + 'auto_rename' => 'auto_rename', + 'ignore' => 'ignore', + ], + 'example' => 'ignore', + 'enum' => [ + 'ignore', + 'auto_rename', + 'refuse', + ], + ], + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id，覆盖写时必填', + 'type' => 'string', + 'required' => false, + 'example' => '9520943DC264', + ], + 'local_created_at' => [ + 'title' => '文件本地创建时间', + 'description' => '文件本地创建时间，默认为空，格式为：yyyy-MM-ddTHH:mm:ssZ，采用 UTC +0 时区', + 'type' => 'string', + 'required' => false, + 'example' => '2023-10-04T14:30:00Z', + ], + 'local_modified_at' => [ + 'title' => '本地文件修改时间', + 'description' => '文件本地修改时间，默认为空，格式为：yyyy-MM-ddTHH:mm:ssZ，采用 UTC +0 时区', + 'type' => 'string', + 'required' => false, + 'example' => '2023-10-04T14:30:00Z', + ], + 'image_media_metadata' => [ + 'description' => '客户端指定的图片信息', + 'required' => false, + '$ref' => '#/components/schemas/ImageMediaMetadata', + ], + 'video_media_metadata' => [ + 'description' => '客户端指定的视频信息', + 'required' => false, + '$ref' => '#/components/schemas/VideoMediaMetadata', + ], + 'parallel_upload' => [ + 'description' => '是否开启并行上传分片功能', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + 'custom_updated_at' => [ + 'type' => 'string', + 'required' => false, + ], + 'custom_created_at' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'parent_file_id' => [ + 'title' => '父目录文件id', + 'description' => '父目录id', + 'type' => 'string', + 'example' => 'fileid5', + ], + 'part_info_list' => [ + 'title' => '分段信息', + 'description' => '分段信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '分段信息', + '$ref' => '#/components/schemas/UploadPartInfo', + ], + ], + 'upload_id' => [ + 'title' => '上传id', + 'description' => '上传id', + 'type' => 'string', + 'example' => 'uploadid1', + ], + 'rapid_upload' => [ + 'title' => '是否已经秒传', + 'description' => '是否已经秒传', + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'file', + ], + 'file_id' => [ + 'title' => '文件id', + 'description' => '文件id', + 'type' => 'string', + 'example' => 'fileid1', + ], + 'domain_id' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'title' => '空间id', + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_name' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'a.txt', + ], + 'status' => [ + 'title' => '文件状态', + 'description' => '文件状态', + 'type' => 'string', + 'example' => 'uploading', + ], + 'exist' => [ + 'title' => '文件是否存在', + 'description' => '文件是否存在', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_file_id\\": \\"fileid5\\",\\n \\"part_info_list\\": [\\n {\\n \\"part_number\\": 1,\\n \\"part_size\\": 1024,\\n \\"upload_url\\": \\"\\",\\n \\"internal_upload_url\\": \\"\\",\\n \\"etag\\": \\"0CC175B9C0F1B6A831C399E269772661\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n },\\n \\"upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"internal_upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"signature_info\\": {\\n \\"auth_type\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"sts_token\\": \\"\\"\\n },\\n \\"parallel_sha256_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n }\\n }\\n ],\\n \\"upload_id\\": \\"uploadid1\\",\\n \\"rapid_upload\\": true,\\n \\"type\\": \\"file\\",\\n \\"file_id\\": \\"fileid1\\",\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_name\\": \\"a.txt\\",\\n \\"status\\": \\"uploading\\",\\n \\"exist\\": false\\n}","type":"json"}]', + 'title' => '创建文件或文件夹', + 'description' => '文件创建使用方法参考最佳实践：[文件上传](~~175888~~)。'."\n" + ."\n" + .'文件上传过程中，已上传的文件分片会产生存储费用。分片将保留10天，直到文件上传完成或10天后分片过期被清理。', + ], + 'DeleteFile' => [ + 'summary' => '删除文件或文件夹。', + 'path' => '/v2/file/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => 'drive id 如果要删除drive下的文件时，drive_id时必需的参数', + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + 'pattern' => '^[0-9]*$', + ], + 'file_id' => [ + 'title' => 'file_id是文件的唯一标识，删除文件或者目录时必须指定file_id', + 'description' => '文件或文件夹id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => '9520943DC264', + ], + 'async_task_id' => [ + 'description' => '异步任务id，只有异步处理的场景才会返回。后续可以调用 [GetAsyncTask](~~440456~~)，传递异步任务 id，获取任务信息。', + 'type' => 'string', + 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"9520943DC264\\",\\n \\"async_task_id\\": \\"000e89fb-cf8f-11e9-8ab4-b6e980803a3b\\"\\n}","type":"json"}]', + 'title' => '删除文件或文件夹', + ], + 'UpdateFile' => [ + 'summary' => '修改文件信息，非数据。', + 'path' => '/v2/file/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'name' => [ + 'description' => '文件名称，按照 utf8 编码规则最长 1024 字节', + 'type' => 'string', + 'required' => false, + 'example' => 'a.jpg', + 'maxLength' => 102, + 'minLength' => 1, + ], + 'description' => [ + 'description' => '文件描述信息，最长 1024 字符', + 'type' => 'string', + 'required' => false, + 'example' => 'VIP用户', + 'maxLength' => 1024, + ], + 'labels' => [ + 'description' => '标签列表，最多 100 个标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签，最长 128 字符', + 'type' => 'string', + 'required' => false, + 'example' => '动物', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'check_name_mode' => [ + 'description' => '同名文件处理模式，可选值如下：'."\n" + ."\n" + .'ignore：允许同名文件；'."\n" + ."\n" + .'auto_rename：当发现同名文件时，云端自动重命名，默认为追加当前时间点，如 xxx\\_20060102\\_150405；'."\n" + ."\n" + .'refuse：当云端存在同名文件时，拒绝创建新文件，返回客户端已存在同名文件的详细信息。'."\n" + ."\n" + .'默认为 ignore', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'refuse' => 'refuse', + 'auto_rename' => 'auto_rename', + 'ignore' => 'ignore', + ], + 'example' => 'ignore', + 'enum' => [ + 'ignore', + 'auto_rename', + 'refuse', + ], + ], + 'local_modified_at' => [ + 'description' => '文件本地修改时间，格式为：yyyy-MM-ddTHH:mm:ssZ，采用 UTC +0 时区', + 'type' => 'string', + 'required' => false, + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'hidden' => [ + 'description' => '是否隐藏', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'starred' => [ + 'description' => '是否收藏', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '修改文件信息', + ], + 'SearchFile' => [ + 'summary' => '搜索文件。', + 'path' => '/v2/file/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'query' => [ + 'description' => '搜索条件，可以根据文件名或目录名模糊查询，最长 4096 字符', + 'type' => 'string', + 'required' => true, + 'example' => 'name="123"', + 'maxLength' => 4096, + ], + 'order_by' => [ + 'description' => '排序字段，默认根据 created_at 排序，可选值如下：'."\n" + .'- created\\_at：根据创建时间排序'."\n" + .'- updated\\_at：根据更新时间排序'."\n" + .'- size：根据文件大小排序'."\n" + .'- name：根据文件名排序'."\n" + ."\n\n" + .'排序方向，可选值如下：'."\n" + .'- ASC代表正序'."\n" + .'- DESC代表逆序'."\n" + ."\n\n" + .'order\\_by语法为：字段名+空格+ASC/DESC，如果多个字段排序则需要用逗号隔开，前面的规则优先级高。如：'."\n" + .'- 按名称正序：name ASC'."\n" + .'- 按创建时间逆序： created_at DESC'."\n" + .'- 先按创建时间逆序，如果创建时间相同，则按名称正序：created_at DESC,name ASC', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'name ASC', + 'enum' => [ + 'name', + 'type', + 'created_at', + 'updated_at', + 'size', + 'image_time', + 'last_access_at', + 'custom_type', + 'custom_field_1', + 'custom_field_2', + 'image_overall_score', + ], + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '50', + 'default' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'return_total_count' => [ + 'description' => '是否返回检索到的文件总数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'recursive' => [ + 'description' => '当 query 中设置了 parent_file_id= xxx 时，设置该字段可以对文件夹进行递归搜索', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'thumbnail_processes' => [ + 'description' => '缩略图配置，可一次性返回最多5个缩略图，map的key可以自定义，返回时按key返回对应的缩略图链接', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + '$ref' => '#/components/schemas/ImageProcess', + 'description' => '定义图片、视频、文档的缩略图处理规则', + ], + ], + 'fields' => [ + 'description' => '设置 fields 时，可以返回文件的额外信息时，支持的字段为：'."\n" + .'* dir_size 响应中返回每个子文件夹的统计信息'."\n" + .'* id_path 响应中返回每个子对象的 id_path'."\n" + .'* name_path 响应中返回每个子对象的 name_path'."\n" + ."\n" + .'当需要多个信息时，不同字段以逗号分割，如 "id_path,name_path,dir_size"', + 'type' => 'string', + 'required' => false, + 'example' => 'id_path,name_path', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '文件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'total_count' => [ + 'description' => '命中的文件总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1022', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 1022\\n}","type":"json"}]', + 'title' => '搜索文件', + 'description' => '<props="china">最佳实践可参考：[搜索文件](https://help.aliyun.com/document_detail/175890.html)。</props>', + ], + 'ListFile' => [ + 'summary' => '直接文件夹下列举文件和文件夹。', + 'path' => '/v2/file/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间 id。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'parent_file_id' => [ + 'description' => '父文件夹 id，当父文件为根目录时，填写 root', + 'type' => 'string', + 'required' => true, + 'example' => 'root', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'status' => [ + 'description' => '文件状态，可选字段如下：'."\n" + ."\n" + .'available：只返回正常文件'."\n" + .'uploading：只返回上传中文件'."\n" + ."\n" + .'默认只返回 available 状态文件', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'available' => '正常', + 'uploading' => '上传中', + ], + 'example' => 'available', + 'enum' => [ + 'uploading', + 'available', + ], + ], + 'order_by' => [ + 'description' => '排序字段，可选值如下：'."\n" + ."\n" + .'created\\_at：根据创建时间排序'."\n" + .'updated\\_at：根据更新时间排序'."\n" + .'size：根据文件大小排序'."\n" + .'name：根据文件名排序'."\n" + ."\n" + .'默认根据 created_at 排序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'updated_at' => '修改时间', + 'size' => '大小', + 'name' => '名称', + 'created_at' => '创建时间', + ], + 'example' => 'updated_at', + ], + 'order_direction' => [ + 'description' => '排序方向，可选字段为：'."\n" + ."\n" + .'ASC：正序'."\n" + .'DESC：倒序'."\n" + ."\n" + .'默认值为ASC', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '正序', + 'DESC' => '倒序', + ], + 'example' => 'ASC', + 'enum' => [ + 'ASC', + 'DESC', + ], + ], + 'category' => [ + 'description' => '文件分类，可选字段如下：'."\n" + ."\n" + .'app：安装包'."\n" + .'zip：压缩包'."\n" + .'image：图片'."\n" + .'doc：文档'."\n" + .'video：视频'."\n" + .'audio：音频'."\n" + .'others：其他'."\n" + ."\n" + .'默认返回所有分类文件', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'app' => 'app', + 'zip' => 'zip', + 'image' => 'image', + 'doc' => 'doc', + 'video' => 'video', + 'audio' => 'audio', + 'others' => 'others', + ], + 'example' => 'image', + 'enum' => [ + 'image', + 'video', + 'audio', + 'doc', + 'app', + 'zip', + 'others', + ], + ], + 'type' => [ + 'description' => '文件类型，可选字段如下：'."\n" + ."\n" + .'file：只返回文件'."\n" + .'folder：只返回文件夹'."\n" + ."\n" + .'默认返回所有类型文件', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'file' => '文件', + 'folder' => '文件夹', + ], + 'example' => 'file', + 'enum' => [ + 'file', + 'folder', + ], + ], + 'fields' => [ + 'description' => '设置 fields 时，可以返回子对象的额外信息时，支持的字段为：'."\n" + .'- url 响应中返回文件缩略图地址，下载地址'."\n" + .'- exif 响应中返回文件的 exif 信息'."\n" + .'- cropping\\_suggestion 响应中返回文件的裁剪建议信息'."\n" + .'- characteristic\\_hash 响应中返回文件的特征 hash 值'."\n" + .'- video\\_metadata 响应中返回视频文件的 meta 信息，比如视频时长，比特率，高度，宽度等'."\n" + .'- video\\_preview_metadata 响应中返回视频文件的转码信息，比如每个清晰度的转码信息'."\n" + .'- investigation_info 响应中返回 investigation_info字段'."\n" + .'- dir_size 响应中返回每个子文件夹的统计信息'."\n" + .'- user_tags 响应中返回每个子对象的 user_tags'."\n" + ."\n" + .'当需要多个信息时，不同字段以逗号分割，如 "url,dir_size,user_tags"', + 'type' => 'string', + 'required' => false, + 'example' => 'url,dir_size,user_tags', + ], + 'thumbnail_processes' => [ + 'description' => '缩略图配置，可一次性返回最多5个缩略图，map的key可以自定义，返回时按key返回对应的缩略图链接', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + '$ref' => '#/components/schemas/ImageProcess', + 'description' => '定义图片、视频、文档的缩略图处理规则', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举文件', + ], + 'GetFile' => [ + 'summary' => '获取文件详情。', + 'path' => '/v2/file/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'url_expire_sec' => [ + 'description' => '过期时间，单位为秒，取值范围为：[10,14400] 秒', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '14400', + 'minimum' => '10', + 'example' => '100', + ], + 'fields' => [ + 'description' => '筛选返回字段：'."\n" + ."\n" + .'1. 当填 * 时，返回文件所有字段（必须在请求中填写的除外）；'."\n" + .'2. 当只需要特定字段时，可填写为：url、thumbnail、exif、cropping\\_suggestion、characteristic\\_hash、video\\_metadata、video\\_preview_metadata，当需要多个字段时，以逗号 , 分割，如 url,thumbnail；'."\n" + .'3. 必须填写investigation_info字符串，才会在响应中返回investigation_info字段。'."\n" + ."\n" + .'默认返回所有字段（必须进行填写的除外）', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + 'thumbnail_processes' => [ + 'description' => '缩略图配置，可一次性返回最多5个缩略图，map的key可以自定义，返回时按key返回对应的缩略图链接', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + '$ref' => '#/components/schemas/ImageProcess', + 'description' => '定义图片、视频、文档的缩略图处理规则', + ], + ], + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + '$ref' => '#/components/schemas/File', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取文件详情', + ], + 'DownloadFile' => [ + 'summary' => '下载文件。', + 'path' => '/v2/file/download', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'share_id', + 'in' => 'query', + 'schema' => [ + 'description' => '分享id。 如果通过分享操作文件，请携带`x-share-token header`鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。 `share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + ], + [ + 'name' => 'drive_id', + 'in' => 'query', + 'schema' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'file_id', + 'in' => 'query', + 'schema' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + [ + 'name' => 'image_thumbnail_process', + 'in' => 'query', + 'schema' => [ + 'description' => '图片处理样式，设置后会跳转至处理后的缩略图地址', + 'type' => 'string', + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', + ], + ], + [ + 'name' => 'video_thumbnail_process', + 'in' => 'query', + 'schema' => [ + 'description' => '视频处理样式，设置后会跳转至处理后的缩略图地址', + 'type' => 'string', + 'required' => false, + 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', + ], + ], + [ + 'name' => 'office_thumbnail_process', + 'in' => 'query', + 'schema' => [ + 'description' => '文档处理样式，设置后会跳转至处理后的缩略图地址', + 'type' => 'string', + 'required' => false, + 'example' => 'image/resize,m_lfit,w_256,limit_0/format,jpg|image/format,webp', + ], + ], + ], + 'responses' => [ + 302 => [ + 'headers' => [ + 'location' => [ + 'schema' => [ + 'title' => '下载地址', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '下载文件', + 'description' => '<props="china">最佳实践可参考：[文件下载](~~175889~~)。</props>', + ], + 'GetUploadUrl' => [ + 'summary' => '获取上传地址。', + 'path' => '/v2/file/get_upload_url', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', + ], + 'upload_id' => [ + 'description' => '上传 id', + 'type' => 'string', + 'required' => true, + 'example' => '10166D06127B413BA1EC8ABB1144D111', + ], + 'part_info_list' => [ + 'description' => '分片信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '分片信息', + 'type' => 'object', + 'properties' => [ + 'part_number' => [ + 'description' => '段编号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'parallel_sha1_ctx' => [ + 'description' => '该分片前所有数据的SHA1上下文，该字段只在多分片并发上传的模式下有效', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'description' => '该分片前所有数据的SHA1上下文的第1-5个32位变量，该字段只在多分片并发上传的模式下有效', + 'type' => 'array', + 'items' => [ + 'description' => '该分片前所有数据的SHA1上下文的第1-5个32位变量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'part_offset' => [ + 'description' => '到上一个数据块为止的总长度，单位为字节，需要为64的倍数，该字段只在多分片并发上传的模式下有效', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10240', + ], + ], + 'required' => false, + ], + 'content_md5' => [ + 'type' => 'string', + 'required' => false, + ], + 'content_type' => [ + 'type' => 'string', + 'required' => false, + ], + 'parallel_sha256_ctx' => [ + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + 'required' => false, + ], + 'part_offset' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', + ], + 'upload_id' => [ + 'description' => '上传id', + 'type' => 'string', + 'example' => '10166D06127B413BA1EC8ABB1144D111', + ], + 'create_at' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2019-09-11T16:34:36.977Z', + ], + 'part_info_list' => [ + 'description' => '分段信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '分段信息', + '$ref' => '#/components/schemas/UploadPartInfo', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"upload_id\\": \\"10166D06127B413BA1EC8ABB1144D111\\",\\n \\"create_at\\": \\"2019-09-11T16:34:36.977Z\\",\\n \\"part_info_list\\": [\\n {\\n \\"part_number\\": 1,\\n \\"part_size\\": 1024,\\n \\"upload_url\\": \\"\\",\\n \\"internal_upload_url\\": \\"\\",\\n \\"etag\\": \\"0CC175B9C0F1B6A831C399E269772661\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n },\\n \\"upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"internal_upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"signature_info\\": {\\n \\"auth_type\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"sts_token\\": \\"\\"\\n },\\n \\"parallel_sha256_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取上传地址', + ], + 'ListUploadedParts' => [ + 'summary' => '列举已上传成功的多段。', + 'path' => '/v2/file/list_uploaded_parts', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'part_number_marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。 默认值：无'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量。如果不设定，默认返回100，最大不能超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'upload_id' => [ + 'description' => '上传id', + 'type' => 'string', + 'required' => true, + 'example' => '00166D06127B413BA1EC8ABB1144D101', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2', + ], + 'drive_id' => [ + 'description' => '空间 id，除根据分享链接上传之外的其他场景，必填', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'share_id' => [ + 'description' => '分享 id，当根据分享链接上传时必填', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'title' => 'Id of the request', + 'description' => '文件id', + 'type' => 'string', + 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2', + ], + 'upload_id' => [ + 'description' => '上传id', + 'type' => 'string', + 'example' => '00166D06127B413BA1EC8ABB1144D101', + ], + 'uploaded_parts' => [ + 'description' => '分段信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '分段信息', + '$ref' => '#/components/schemas/UploadPartInfo', + ], + ], + 'next_part_number_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'parallel_upload' => [ + 'description' => '是否并行上传', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"file_id\\": \\"322fb07b975f4b0ae1b543fe8475eee4c19eb2b2\\",\\n \\"upload_id\\": \\"00166D06127B413BA1EC8ABB1144D101\\",\\n \\"uploaded_parts\\": [\\n {\\n \\"part_number\\": 1,\\n \\"part_size\\": 1024,\\n \\"upload_url\\": \\"\\",\\n \\"internal_upload_url\\": \\"\\",\\n \\"etag\\": \\"0CC175B9C0F1B6A831C399E269772661\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n },\\n \\"upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"internal_upload_form_info\\": {\\n \\"bucket_name\\": \\"\\",\\n \\"oss_end_point\\": \\"\\",\\n \\"object_key\\": \\"\\",\\n \\"oss_access_key_id\\": \\"\\",\\n \\"oss_security_token\\": \\"\\",\\n \\"policy\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"signature_info\\": {\\n \\"auth_type\\": \\"\\",\\n \\"signature\\": \\"\\",\\n \\"sts_token\\": \\"\\"\\n },\\n \\"parallel_sha256_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n }\\n }\\n ],\\n \\"next_part_number_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"parallel_upload\\": false\\n}","type":"json"}]', + 'title' => '列举已上传分片', + ], + 'CompleteFile' => [ + 'summary' => '完成文件上传。', + 'path' => '/v2/file/complete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'upload_id' => [ + 'description' => '上传id', + 'type' => 'string', + 'required' => true, + 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'crc64_hash' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '完成文件上传', + 'description' => '使用方法参考最佳实践：[文件上传](~~175888~~)。'."\n" + ."\n" + .'文件上传过程中，已上传的文件分片会产生存储费用。分片将保留10天，直到文件上传完成或10天后分片过期被清理。', + ], + 'MoveFile' => [ + 'summary' => '移动文件或文件夹。', + 'path' => '/v2/file/move', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'to_parent_file_id' => [ + 'description' => '目的父文件夹 id，当移入根目录时，填 root', + 'type' => 'string', + 'required' => true, + 'example' => '6520943DC261', + ], + 'check_name_mode' => [ + 'description' => '同名文件处理模式，可选值如下：'."\n" + ."\n" + .'ignore：允许同名文件；'."\n" + ."\n" + .'auto\\_rename：当发现同名文件时，云端自动重命名，默认为追加当前时间点，如 xxx\\_20060102\\_150405；'."\n" + ."\n" + .'refuse：当云端存在同名文件时，拒绝创建新文件，返回客户端已存在同名文件的详细信息。'."\n" + ."\n" + .'默认为 ignore', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + 'enum' => [ + 'ignore', + 'auto_rename', + 'refuse', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => 'fileid1', + ], + 'async_task_id' => [ + 'description' => '异步任务id。'."\n" + ."\n" + .'如果返回为空字符串，表示直接移动成功。'."\n" + ."\n" + .'如果返回非空字符串，表示需要经过异步处理。调用GetAsyncTask，传递异步任务id，获取任务信息。', + 'type' => 'string', + 'example' => '23ebd1a24dba4166b1527add476ef2866051b4d5del106', + ], + 'exist' => [ + 'description' => '文件是否已存在', + 'type' => 'boolean', + 'example' => 'false', + ], + 'revision_id' => [ + 'type' => 'string', + ], + 'file_name' => [ + 'type' => 'string', + ], + 'updated_at' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"fileid1\\",\\n \\"async_task_id\\": \\"23ebd1a24dba4166b1527add476ef2866051b4d5del106\\",\\n \\"exist\\": false,\\n \\"revision_id\\": \\"\\",\\n \\"file_name\\": \\"\\",\\n \\"updated_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '移动文件或文件夹', + ], + 'CopyFile' => [ + 'summary' => '拷贝文件或目录。', + 'path' => '/v2/file/copy', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件或文件夹 id', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'to_drive_id' => [ + 'description' => '拷贝到的空间id。'."\n" + .'默认值同drive_id。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'to_parent_file_id' => [ + 'description' => '目的父文件夹 id，当复制进根目录时，填 root', + 'type' => 'string', + 'required' => true, + 'example' => '6520943DC261', + ], + 'auto_rename' => [ + 'description' => '当目标文件夹下存在同名文件时，是否自动重命名，默认为 false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '复制后的新文件或文件夹 id', + 'type' => 'string', + 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + 'async_task_id' => [ + 'description' => '异步任务id。'."\n" + ."\n" + .'当复制的是文件时，不返回该字段；当复制的是文件夹时，为后台异步复制，会返回该字段，调用GetAsyncTask，传递异步任务id，获取任务信息。', + 'type' => 'string', + 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"4221bf6e6ab43a255edc4463bffa6f5f5d317401\\",\\n \\"async_task_id\\": \\"000e89fb-cf8f-11e9-8ab4-b6e980803a3b\\"\\n}","type":"json"}]', + 'title' => '复制文件或文件夹', + ], + 'GetDownloadUrl' => [ + 'summary' => '获取文件下载地址。', + 'path' => '/v2/file/get_download_url', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间 id。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id。', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'file_name' => [ + 'description' => '文件名，最长 1024 字符。', + 'type' => 'string', + 'required' => false, + 'example' => '1.txt', + 'maxLength' => 1024, + 'minLength' => 1, + ], + 'expire_sec' => [ + 'description' => '下载地址过期时间，单位为秒，最长115200秒，默认为900秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '115200', + 'minimum' => '1', + 'example' => '100', + 'default' => '900', + ], + 'response_content_type' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'video/mp4', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'url' => [ + 'title' => 'Id of the request', + 'description' => '公网下载地址'."\n" + .'（开启智能数据域名后，根据客户网络情况选取最优线路，返回对应域名下载地址）。', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt', + ], + 'internal_url' => [ + 'description' => 'vpc内下载地址'."\n" + .'（开启智能数据域名后将不使用该字段，根据请求该参数会自适应返回在URL字段值内，如需使用该字段请联系PDS技术支持）。', + 'type' => 'string', + 'example' => 'https://data-vpc.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt', + ], + 'cdn_url' => [ + 'description' => 'cdn下载地址'."\n" + .'（开启智能数据域名后不使用该字段，根据请求该参数会自适应返回在URL字段值内，如需使用该字段请联系PDS技术支持）。', + 'type' => 'string', + 'example' => 'https://data-cdn.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt', + ], + 'expiration' => [ + 'description' => '下载链接的过期时间。', + 'type' => 'string', + 'example' => '2022-01-02T15:04:05.999Z07:00', + ], + 'size' => [ + 'description' => '文件大小，单位：byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'crc64_hash' => [ + 'description' => 'crc64值。', + 'type' => 'string', + 'example' => '5498595269368962671', + ], + 'content_hash' => [ + 'description' => '文件内容hash。', + 'type' => 'string', + 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA1', + ], + 'content_hash_name' => [ + 'description' => '文件内容hash算法名。', + 'type' => 'string', + 'example' => 'sha1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt\\",\\n \\"internal_url\\": \\"https://data-vpc.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt\\",\\n \\"cdn_url\\": \\"https://data-cdn.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt\\",\\n \\"expiration\\": \\"2022-01-02T15:04:05.999Z07:00\\",\\n \\"size\\": 10,\\n \\"crc64_hash\\": \\"5498595269368962671\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA1\\",\\n \\"content_hash_name\\": \\"sha1\\"\\n}","type":"json"}]', + 'title' => '获取文件下载地址', + ], + 'FilePutUserTags' => [ + 'summary' => '对文件添加自定义标签。', + 'path' => '/v2/file/put_usertags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'user_tags' => [ + 'description' => '待添加的标签列表。'."\n" + .'数组不能为空，且数量上限为 1000。'."\n" + .'数组中不能存在同名标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签名和标签值的长度之和不能超过 2000 字节。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签名。'."\n" + .'不能为空，且不能含有 # 字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag', + 'pattern' => '^[^#]+$', + ], + 'value' => [ + 'description' => '标签值。'."\n" + .'不能含有 # 字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + 'pattern' => '^[^#]+$', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 1000, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'title' => 'Id of the request', + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"file_id\\": \\"9520943DC264\\"\\n}","type":"json"}]', + 'title' => '添加文件自定义标签', + 'description' => '此接口为增量更新操作：'."\n" + ."\n" + .'- 若此次请求中存在同名标签则会覆盖之前的值'."\n" + ."\n" + .'- 若标签不存在则新增'."\n" + ."\n" + .'- 历史非同名标签不受影响。', + ], + 'FileDeleteUserTags' => [ + 'summary' => '删除文件自定义标签。', + 'path' => '/v2/file/delete_usertags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'key_list' => [ + 'description' => '待删除的标签列表。'."\n" + .'数组不能为空，且数量上限为 1000。', + 'type' => 'array', + 'items' => [ + 'description' => '标签名。'."\n" + .'不能带有 # 字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'tag', + 'pattern' => '^[^#]+$', + ], + 'required' => true, + 'maxItems' => 1000, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除文件自定义标签', + ], + 'VideoDRMLicense' => [ + 'summary' => '获取视频的DRM License。', + 'path' => '/v2/file/video_drm_license', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drmType' => [ + 'description' => 'DRM 加密类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'fairplay' => 'fairplay', + 'widevine' => 'widevine', + ], + 'example' => 'widevine', + ], + 'licenseRequest' => [ + 'description' => '获取 license 请求体。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAES6B8SQgpACioSENGxDhqCLIVwwCBOyPayyWoSENGxDhqCLIVwwCBOyPayyWpI88aJmwYQARoQdRV32', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回的DRM License。', + 'type' => 'string', + 'example' => 'cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3', + ], + 'states' => [ + 'description' => 'DRM Server 返回的请求状态。', + 'type' => 'string', + 'example' => '0', + ], + 'device_info' => [ + 'description' => '发起 DRM 请求的设备信息。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3\\",\\n \\"states\\": \\"0\\",\\n \\"device_info\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '获取视频DRMLicense', + ], + 'DeleteRevision' => [ + 'summary' => '删除历史版本，不支持删除最新版本。', + 'path' => '/v2/file/revision/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除历史版本', + ], + 'UpdateRevision' => [ + 'summary' => '更新版本信息，设置版本为永久保留，或者添加版本描述信息。支持将一个文件的最多50个版本设置为永久保留。', + 'path' => '/v2/file/revision/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + 'keep_forever' => [ + 'description' => '是否永久保留'."\n" + ."\n" + .'默认不传递该参数，表示不修改版本的永久保留属性。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'revision_description' => [ + 'description' => '版本描述信息，最长1024字符'."\n" + ."\n" + .'默认不传递该参数，表示不修改版本的版本描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'aaa', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '版本信息', + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => '更新版本信息', + ], + 'RestoreRevision' => [ + 'summary' => '将文件的某个历史版本，还原为文件的最新版本，还原时生成一个新版本，被还原的版本不变。不支持还原最新版本。', + 'path' => '/v2/file/revision/restore', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '版本信息', + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => '还原历史版本', + ], + 'ListRevision' => [ + 'summary' => '列举版本信息。', + 'path' => '/v2/file/revision/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + ."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => '40CB7794C929', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + ."\n" + .'默认值为50'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '100', + ], + 'fields' => [ + 'description' => '筛选返回字段'."\n" + ."\n" + .'默认为空。当填 * 时，返回所有字段，会比为空时多返回创建者名称。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '版本信息数组', + 'type' => 'array', + 'items' => [ + 'description' => '版本信息', + '$ref' => '#/components/schemas/Revision', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举版本', + ], + 'GetRevision' => [ + 'summary' => '获取版本详情。', + 'path' => '/v2/file/revision/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + 'url_expire_sec' => [ + 'description' => '过期时间，单位为秒，最短 10 秒，最长 86400 秒'."\n" + ."\n" + .'默认15分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '900', + ], + 'fields' => [ + 'description' => '筛选返回字段'."\n" + ."\n" + .'默认为空。当填 * 时，返回所有字段，会比为空时多返回创建者名称', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '版本信息', + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取版本信息', + ], + 'ScanFile' => [ + 'summary' => '扫描文件。', + 'path' => '/v2/file/scan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '50', + 'default' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'fields' => [ + 'title' => 'scan file 想要获取的文件属性，'."\n" + .'1. 如果想要获取所有属性使用‘*’，'."\n" + .' 2.不传默认返回以下属性：'."\n" + .' file_id, drive_id, parent_file_id, type,'."\n" + .' created_at, updated_at, file_extention, size, starred, status,deleting, category, permissions'."\n" + .' 3 用户也可以指定属性进行返回，多个属性之间用，隔开'."\n" + .' '."\n", + 'description' => 'scan file 想要获取的文件属性。'."\n" + .'- 如果想要获取所有属性使用‘*’。'."\n" + .'- 不传默认返回以下属性：'."\n" + .' - file_id, '."\n" + .' - drive_id, '."\n" + .' - parent_file_id, '."\n" + .' - type, '."\n" + .' - created_at, '."\n" + .' - updated_at, '."\n" + .' - file_extention, '."\n" + .' - size, '."\n" + .' - starred, '."\n" + .' - status,'."\n" + .' - category, '."\n" + .' - permissions。'."\n" + .'- 用户也可以指定属性进行返回，多个属性之间用\',\'隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '扫描文件', + ], + 'ListDelta' => [ + 'summary' => '列举增量信息。', + 'path' => '/v2/file/list_delta', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '云端Drive id'."\n", + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'sync_root_id' => [ + 'title' => '如果是同步目录的增量信息，必须设置同步目录对应的云端根目录', + 'description' => '同步文件夹根节点文件id', + 'type' => 'string', + 'required' => false, + 'example' => '622fb09598ae66777c7040109a16f49381f6abe1', + ], + 'cursor' => [ + 'title' => '增量信息的起始游标', + 'description' => '游标', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'title' => '获取增量信息的条数限制', + 'description' => '限定此次返回资源的数量，取值范围\\[0,100\\]，默认值为 100。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '增量信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'title' => '文件唯一id', + 'description' => '文件id', + 'type' => 'string', + 'example' => '122fb09598ae66777c7040109a16f49381f6abe2', + ], + 'op' => [ + 'title' => '文件操作，主要包括', + 'description' => '执行的操作。具体包括以下操作：'."\n" + .'- create'."\n" + .'- overwrite'."\n" + .'- delete'."\n" + .'- update'."\n" + .'- move'."\n" + .'- trash'."\n" + .'- restore'."\n" + .'- rename', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'create', + ], + 'file' => [ + 'description' => '涉及的文件信息', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + 'has_more' => [ + 'description' => '是否还有更多信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cursor' => [ + 'description' => '游标', + 'type' => 'string', + 'example' => '1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"items\\": [\\n {\\n \\"file_id\\": \\"122fb09598ae66777c7040109a16f49381f6abe2\\",\\n \\"op\\": \\"create\\",\\n \\"file\\": {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n }\\n ],\\n \\"has_more\\": true,\\n \\"cursor\\": \\"1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDeltaResponse>\\n <items>\\n <file_id>122fb09598ae66777c7040109a16f49381f6abe2</file_id>\\n <op>create</op>\\n <file/>\\n </items>\\n <has_more>true</has_more>\\n <cursor>1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg</cursor>\\n</ListDeltaResponse>","errorExample":""}]', + 'title' => '列举增量信息', + ], + 'DeltaGetLastCursor' => [ + 'summary' => '获取增量操作游标。', + 'path' => '/v2/file/get_last_cursor', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '云端 drive id', + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'sync_root_id' => [ + 'title' => '同步目录的对应的云端跟目录', + 'description' => '同步文件夹根节点文件id', + 'type' => 'string', + 'required' => false, + 'example' => '622fb09598ae66777c7040109a16f49381f6abe1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'cursor' => [ + 'title' => '当前增量变化的最新游标', + 'description' => '指定drive或者指定同步目录下增量信息的最新游标', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cursor\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '获取增量操作游标', + ], + 'ListReceivedFile' => [ + 'summary' => '收到的共享， 可通过此接口获取到从个人空间授权给此用户的文件列表。', + 'path' => '/v2/file/list_received_file', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限定此次返回资源的数量。如果不设定，默认返回100，最大不能超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'marker' => [ + 'description' => '设置此字段后，数据会从上次返回的位置开始继续返回。如果不设定，则从头开始返回数据。 默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'eym***', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '返回的文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回的文件信息', + 'example' => ' ', + '$ref' => '#/components/schemas/File', + ], + ], + 'next_marker' => [ + 'description' => '本次返回记录的断点，可用于下次继续查询', + 'type' => 'string', + 'example' => 'eym***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"eym***\\"\\n}","type":"json"}]', + 'title' => '收到的共享文件夹列表', + ], + 'ListMyGroupDrive' => [ + 'summary' => '列举被授权的团队空间列表。', + 'path' => '/v2/drive/list_my_group_drive', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限定此次返回资源的数量。如果不设定，默认返回100，最大不能超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'marker' => [ + 'description' => '设置此字段后，数据会从上次返回的位置开始继续返回。如果不设定，则从头开始返回数据。 默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'drive_name' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '返回的空间信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回的空间信息', + '$ref' => '#/components/schemas/Drive', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'root_group_drive' => [ + 'description' => '企业空间信息。', + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"root_group_drive\\": {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '收到的授权团队空间列表', + ], + 'FileRemovePermission' => [ + 'summary' => '取消文件共享授权。', + 'path' => '/v2/file/remove_permission', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'member_list' => [ + 'description' => '共享的用户对象集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'description' => '可授权对象，表示一个用户或者一个群组', + 'required' => true, + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'description' => '目前支持两种方式设置权限，一种是通过指定角色设置权限，另一种是自定义操作权限，此字段用于指定角色设置权限，与action\\_list互斥，当两个字段同时设置时，以此字段为准'."\n" + ."\n" + .'目前支持：'."\n" + ."\n" + .'SystemFileOwner（文件协同）'."\n" + ."\n" + .'SystemFileDownloader（下载者）'."\n" + ."\n" + .'SystemFileEditor（编辑者）'."\n" + ."\n" + .'SystemFileEditorWithoutDelete（无删除编辑者）'."\n" + ."\n" + .'SystemFileEditorWithoutShareLink（无分享编辑者）'."\n" + ."\n" + .'SystemFileMetaViewer（可见列表）'."\n" + ."\n" + .'SystemFileUploader（上传者）、SystemFileUploaderAndDownloader（上传/下载者）'."\n" + ."\n" + .'SystemFileDownloaderWithShareLink（下载/分享者）'."\n" + ."\n" + .'SystemFileUploaderAndDownloaderWithShareLink（上传/下载/分享者）'."\n" + ."\n" + .'SystemFileUploaderAndViewer（预览/上传者）'."\n" + ."\n" + .'SystemFileUploaderWithShareLink（上传/分享者）'."\n" + ."\n" + .'SystemFileViewer（预览者）', + 'type' => 'string', + 'required' => true, + 'example' => 'SystemFileDownloader', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消文件共享授权', + ], + 'FileAddPermission' => [ + 'summary' => '文件夹授权。单Drive下最多可支持1000条授权记录，超出后授权不生效。', + 'path' => '/v2/file/add_permission', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件夹id， 当授权整个团队空间时，此字段填root。 个人空间共享不支持填root', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'member_list' => [ + 'description' => '被授权的成员列表', + 'type' => 'array', + 'items' => [ + 'description' => '授权信息', + 'required' => false, + '$ref' => '#/components/schemas/FilePermissionMember', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '文件共享授权给用户或组', + 'description' => '单Drive下最多可支持1000条授权记录，超出后授权不生效。', + ], + 'FileListPermission' => [ + 'summary' => '列举文件的共享或授权记录。', + 'path' => '/v2/file/list_permission', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '文件权限信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件权限信息', + '$ref' => '#/components/schemas/FilePermissionMember', + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"identity\\": {\\n \\"identity_type\\": \\"IT_User\\",\\n \\"identity_id\\": \\"\\"\\n },\\n \\"role_id\\": \\"\\",\\n \\"expire_time\\": 0,\\n \\"disinherit_sub_group\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ]\\n }\\n]","type":"json"}]', + 'title' => '列举文件的共享或授权记录', + ], + 'ListAssignment' => [ + 'summary' => '列举已分配的角色列表。', + 'path' => '/v2/role/list_assignment', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'manage_resource_type' => [ + 'description' => '管理的资源类型，目前支持：'."\n" + ."\n" + .'- RT\\_Group（群组）'."\n" + ."\n" + .'- RT\\_KnowledgeBase（知识库）'."\n" + ."\n" + .'- RT\\_KnowledgeCategory（知识分类）', + 'type' => 'string', + 'required' => true, + 'example' => 'RT_Group', + ], + 'manage_resource_id' => [ + 'description' => '管理的资源ID，比如群组的ID', + 'type' => 'string', + 'required' => true, + 'example' => '105***b82', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'assignment_list' => [ + 'description' => '授权信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => '域id', + 'type' => 'string', + 'example' => 'hz1', + ], + 'identity' => [ + 'description' => '被授权的对象，表示一个用户或者一个群组', + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'description' => '被授权的角色ID', + 'type' => 'string', + 'example' => 'SystemGroupAdmin', + ], + 'manage_resource_type' => [ + 'description' => '管理的资源类型，比如： RT_Group，表示群组类型', + 'type' => 'string', + 'example' => 'RT_Group', + ], + 'manage_resource_id' => [ + 'description' => '管理的资源ID，比如群组的ID', + 'type' => 'string', + 'example' => '105***b82', + ], + 'creator' => [ + 'description' => '创建者ID', + 'type' => 'string', + 'example' => '216***c83', + ], + 'created_at' => [ + 'description' => '创建时间，从1970年1月1日0点到当前的毫秒时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1622682267564', + ], + ], + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"assignment_list\\": [\\n {\\n \\"domain_id\\": \\"hz1\\",\\n \\"identity\\": {\\n \\"identity_type\\": \\"IT_User\\",\\n \\"identity_id\\": \\"\\"\\n },\\n \\"role_id\\": \\"SystemGroupAdmin\\",\\n \\"manage_resource_type\\": \\"RT_Group\\",\\n \\"manage_resource_id\\": \\"105***b82\\",\\n \\"creator\\": \\"216***c83\\",\\n \\"created_at\\": 1622682267564\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举已分配的角色列表', + ], + 'AssignRole' => [ + 'summary' => '当前支持将用户设置为团队管理员角色。', + 'path' => '/v2/role/assign', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'description' => '唯一身份标识，当前仅支持设置某个用户作为团队管理员', + 'required' => true, + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'description' => '给用户分配的角色ID，当前仅支持填：SystemGroupAdmin（团队管理员）', + 'type' => 'string', + 'required' => true, + 'example' => 'SystemGroupAdmin', + ], + 'manage_resource_type' => [ + 'description' => '管理的资源类型，当前仅支持：RT_Group（团队）', + 'type' => 'string', + 'required' => true, + 'example' => 'RT_Group', + ], + 'manage_resource_id' => [ + 'description' => '管理的资源ID，当前仅支持填Group ID。', + 'type' => 'string', + 'required' => true, + 'example' => '105***b82', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '分配角色', + 'description' => '当前支持将用户设置为团队管理员角色。', + ], + 'CancelAssignRole' => [ + 'summary' => '当前仅支持取消团队管理员角色。', + 'path' => '/v2/role/cancel_assign', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'description' => '唯一身份标识，当前仅支持取消用户的角色', + 'required' => true, + '$ref' => '#/components/schemas/Identity', + ], + 'role_id' => [ + 'description' => '取消用户已分配的角色ID，当前仅支持填：SystemGroupAdmin（团队管理员）', + 'type' => 'string', + 'required' => true, + 'example' => 'SystemGroupAdmin', + ], + 'manage_resource_type' => [ + 'description' => '被取消角色管理的资源类型，当前仅支持：RT_Group（团队）', + 'type' => 'string', + 'required' => true, + 'example' => 'RT_Group', + ], + 'manage_resource_id' => [ + 'description' => '被取消角色管理的资源ID，当前仅支持填Group ID', + 'type' => 'string', + 'required' => true, + 'example' => '105***b82', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消分配的角色', + 'description' => '当前仅支持取消团队管理员角色。', + ], + 'CreateShareLink' => [ + 'summary' => '创建分享。', + 'path' => '/v2/share_link/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'share_all_files' => [ + 'description' => '是否分享整个drive中的文件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'file_id_list' => [ + 'description' => '分享父路径文件id列表。'."\n" + .'父路径文件个数范围[1, 100]。'."\n" + .'如果`share_all_files=true`，那么此字段无效，否则必须要填写', + 'type' => 'array', + 'items' => [ + 'description' => '分享父路径文件id', + 'type' => 'string', + 'required' => false, + 'example' => '9520943DC264', + ], + 'required' => false, + 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', + ], + 'user_id' => [ + 'description' => '用户id。使用AK方式请求时，必填', + 'type' => 'string', + 'required' => false, + 'example' => 'u123', + ], + 'share_pwd' => [ + 'description' => '提取码。'."\n" + .'提取码长度范围[0, 64]字节'."\n" + .'不设置或者设置为空表示无提取码，在获取分享令牌的时候也不用设置提取码参数。'."\n" + .'要求使用ASCII可见字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcF123x', + ], + 'expiration' => [ + 'description' => '失效时间点。'."\n" + .'RFC3339格式，比如："2020-06-28T11:33:00.000+08:00"。'."\n" + .'当expiration取值""时，表示永久有效', + 'type' => 'string', + 'required' => false, + 'example' => '2020-06-28T11:33:00.000+08:00', + ], + 'description' => [ + 'description' => '分享描述。'."\n" + .'长度范围[0, 1024]字符', + 'type' => 'string', + 'required' => false, + 'example' => '百家讲坛合集', + ], + 'share_name' => [ + 'description' => '分享名。'."\n" + .'如果未设置，默认使用file\\_id\\_list中的第一个id对应的文件名。'."\n" + .'长度范围[0, 128]字符', + 'type' => 'string', + 'required' => false, + 'example' => '百家讲坛-1.MP4', + ], + 'disable_preview' => [ + 'description' => '禁止预览分享中的文件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'disable_save' => [ + 'description' => '禁止转存分享中的文件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'disable_download' => [ + 'description' => '禁止下载分享中的文件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'preview_limit' => [ + 'description' => '分享预览次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'save_limit' => [ + 'description' => '分享转存次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'download_limit' => [ + 'description' => '分享下载次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'require_login' => [ + 'description' => '登录后才允许访问分享', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'office_editable' => [ + 'description' => '允许在线编辑分享的文档', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'creatable' => [ + 'description' => '允许在分享中的文件夹中创建文件；creatable为true时，需要同时传creatable_file_id_list参数', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'creatable_file_id_list' => [ + 'description' => '允许上传的文件夹file id列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件夹file id', + 'type' => 'string', + 'required' => false, + 'example' => '9520943DC264', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息', + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => '创建分享', + 'description' => '分享又称之为文件分享，是一个文件视图容器，通过其可将用户空间中的一个或多个文件暴露给匿名用户访问，匿名用户在分享权限的约束下访问其中的文件。', + ], + 'UpdateShareLink' => [ + 'summary' => '修改分享。', + 'path' => '/v2/share_link/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + 'share_pwd' => [ + 'description' => '提取码。'."\n" + .'提取码长度范围[0, 64]。'."\n" + .'长度0表示提取码是""'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcF123x', + ], + 'expiration' => [ + 'description' => '失效时间点。'."\n" + .'RFC3339格式，比如："2020-06-28T11:33:00.000+08:00"。'."\n" + .'""表示永久有效'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-06-28T11:33:00.000+08:00', + ], + 'description' => [ + 'description' => '描述。'."\n" + .'长度范围[0, 1024]'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '百家讲坛全集', + ], + 'share_name' => [ + 'description' => '分享名。'."\n" + .'默认使用第一个文件名。'."\n" + .'长度范围[0, 128]', + 'type' => 'string', + 'required' => false, + 'example' => '百家讲坛-1.mp4', + ], + 'status' => [ + 'description' => '分享状态。'."\n" + .'枚举值如下：'."\n" + .'- disabled（已取消）'."\n" + .'- enabled（有效）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => '已取消', + 'enabled' => '有效', + ], + 'example' => 'enabled', + ], + 'preview_count' => [ + 'description' => '预览次数。'."\n" + .'次数要求>=0', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'save_count' => [ + 'description' => '转存次数。'."\n" + .'次数要求>=0'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'download_count' => [ + 'description' => '下载次数。'."\n" + .'次数要求>=0'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'report_count' => [ + 'description' => '举报次数。'."\n" + .'次数要求>=0'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'video_preview_count' => [ + 'description' => '视频预览次数。'."\n" + .'次数要求>=0'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'disable_preview' => [ + 'description' => '禁止预览', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'disable_save' => [ + 'description' => '禁止转存', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'disable_download' => [ + 'description' => '禁止下载', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'preview_limit' => [ + 'description' => '分享预览次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'save_limit' => [ + 'description' => '分享转存次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'download_limit' => [ + 'description' => '分享下载次数限制。'."\n" + .'次数要求>=0。'."\n" + .'次数0表示不限制'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'office_editable' => [ + 'description' => '允许在线编辑分享的文档', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息', + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => '修改分享', + ], + 'SearchShareLink' => [ + 'summary' => '搜索分享。', + 'path' => '/v2/share_link/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。如果没有填写，默认取值100。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'return_total_count' => [ + 'description' => '是否返回搜到到的总记录数', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'order_by' => [ + 'description' => '排序字段。'."\n" + .'默认按照创建时间倒序排列。'."\n" + .'枚举值如下：'."\n" + .'- share_name（分享名称）'."\n" + .'- updated_at（修改时间）'."\n" + .'- description（描述）'."\n" + .'- created_at（创建时间）'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'share_name' => '分享名称', + 'updated_at' => '修改时间', + 'description' => '描述', + 'created_at' => '创建时间', + ], + 'example' => 'created_at', + ], + 'order_direction' => [ + 'description' => '排序方式。'."\n" + .'如果是排序字段是created\\_at或者updated\\_at，则默认是倒序，其他排序字段默认是升序。'."\n" + .'枚举值如下：'."\n" + .'- ASC（升序）'."\n" + .'- DESC（降序）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '升序', + 'DESC' => '降序', + ], + 'example' => 'ASC', + ], + 'creators' => [ + 'description' => '分享创建者（user_id）'."\n" + .'1）如果不指定, 那么会根据用户本身的权限进行查询'."\n" + .'1.1 网盘管理员/超管：所有成员'."\n" + .'1.2 团队管理员：团队成员'."\n" + .'1.3 普通用户：自身'."\n" + ."\n" + .'2）如果指定, 那么只能指定那些有权限的成员, 参考1）', + 'type' => 'array', + 'items' => [ + 'description' => '分享创建者', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'required' => false, + ], + 'query' => [ + 'description' => '查询条件'."\n" + .'1）支持字段：'."\n" + .'1.1 created\\_at 创建时间'."\n" + .'1.2 updated\\_at 更新时间'."\n" + .'1.3 share\\_name\\_for\\_fuzzy 分享名, 支持模糊匹配（match）'."\n" + .'1.4 status 分享状态, '."\n" + .'枚举值 enabled（分享中）/disabled（已取消）'."\n" + .'1.5 expired\\_time 超时时间'."\n" + .'永不过期：expired\\_time=\'1970-01-01T00:00:00\', 返回的expiration=""'."\n" + .'expired_time<\'1970-01-02T00:00:00\'系统保留使用,不表示具体时间', + 'type' => 'string', + 'required' => false, + 'example' => 'created_at>=\'2022-01-18T02:50:00\' and created_at<\'2022-01-19T09:45:28\' and share_name_for_fuzzy match \'HD.mp4\' and status in [\'enabled\', \'disabled\'] and expired_time=\'1970-01-01T00:00:00\'', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '分享列表', + 'type' => 'array', + 'items' => [ + 'description' => '分享', + '$ref' => '#/components/schemas/ShareLink', + ], + ], + 'next_marker' => [ + 'description' => '下次起始点', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'total_count' => [ + 'description' => '总数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 101\\n}","type":"json"}]', + 'title' => '搜索分享', + ], + 'CancelShareLink' => [ + 'summary' => '删除分享。', + 'path' => '/v2/share_link/cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + '_' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消分享', + ], + 'ListShareLink' => [ + 'summary' => '列举分享。', + 'path' => '/v2/share_link/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'creator' => [ + 'description' => '创建者', + 'type' => 'string', + 'required' => false, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[0,100\\]。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'<br>默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'order_by' => [ + 'description' => '排序字段。'."\n" + .'默认按照创建时间倒序排列。'."\n" + .'枚举值如下：'."\n" + .'- share_name（分享名称）'."\n" + .'- updated_at（分享修改时间）'."\n" + .'- description（分享描述）'."\n" + .'- created_at（分享创建时间）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'share_name' => '分享名称', + 'updated_at' => '分享修改时间', + 'description' => '分享描述', + 'created_at' => '分享创建时间', + ], + 'example' => 'share_name', + ], + 'order_direction' => [ + 'description' => '排序方式。'."\n" + .'如果是排序字段是created_at或者updated_at，则默认是倒序，其他排序字段默认是升序。'."\n" + .'枚举值如下：'."\n" + .'- ASC（升序）'."\n" + .'- DESC（降序）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '升序', + 'DESC' => '降序', + ], + 'example' => 'ASC', + ], + 'include_cancelled' => [ + 'description' => '是否包含已取消的分享', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '结果对象。', + 'type' => 'array', + 'items' => [ + 'description' => '分享信息', + '$ref' => '#/components/schemas/ShareLink', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举分享', + 'description' => 'Deprecated, 请使用分享SearchShareLink代替此接口。', + ], + 'GetShareLink' => [ + 'summary' => '获取分享信息。', + 'path' => '/v2/share_link/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息', + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取分享信息', + ], + 'GetShareLinkByAnonymous' => [ + 'summary' => '匿名查看分享信息。', + 'path' => '/v2/share_link/get_by_anonymous', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'creator_id' => [ + 'description' => '创建者id', + 'type' => 'string', + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + 'creator_name' => [ + 'description' => '创建者名字（已脱敏）', + 'type' => 'string', + 'example' => 'AB***CD', + ], + 'creator_phone' => [ + 'description' => '创建者手机号（已脱敏）', + 'type' => 'string', + 'example' => '136****00', + ], + 'expiration' => [ + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2020-08-20T06:51:27.292Z', + ], + 'updated_at' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'avatar' => [ + 'description' => '创建者头像', + 'type' => 'string', + 'example' => 'https://aliyunpds.com/a.jpg', + ], + 'share_name' => [ + 'description' => '分享名称', + 'type' => 'string', + 'example' => '百家讲坛-1.MP4', + ], + 'preview_count' => [ + 'description' => '预览次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'save_count' => [ + 'description' => '转存次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'download_count' => [ + 'description' => '下载次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'report_count' => [ + 'description' => '被举报次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'video_preview_count' => [ + 'description' => '视频预览次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'access_count' => [ + 'description' => '访问次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'disable_preview' => [ + 'description' => '禁止预览', + 'type' => 'boolean', + 'example' => 'false', + ], + 'disable_save' => [ + 'description' => '禁止转存', + 'type' => 'boolean', + 'example' => 'false', + ], + 'disable_download' => [ + 'description' => '禁止下载', + 'type' => 'boolean', + 'example' => 'false', + ], + 'preview_limit' => [ + 'description' => '预览次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'save_limit' => [ + 'description' => '转存次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'download_limit' => [ + 'description' => '下载次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'save_download_limit' => [ + 'description' => '转存和下载总次数限制', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'has_pwd' => [ + 'description' => '分享是否设置了提取码', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"creator_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"creator_name\\": \\"AB***CD\\",\\n \\"creator_phone\\": \\"136****00\\",\\n \\"expiration\\": \\"2020-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"avatar\\": \\"https://aliyunpds.com/a.jpg\\",\\n \\"share_name\\": \\"百家讲坛-1.MP4\\",\\n \\"preview_count\\": 80,\\n \\"save_count\\": 2,\\n \\"download_count\\": 50,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 5,\\n \\"access_count\\": 30,\\n \\"disable_preview\\": false,\\n \\"disable_save\\": false,\\n \\"disable_download\\": false,\\n \\"preview_limit\\": 100,\\n \\"save_limit\\": 100,\\n \\"download_limit\\": 100,\\n \\"save_download_limit\\": 200,\\n \\"has_pwd\\": true\\n}","type":"json"}]', + 'title' => '匿名查看分享信息', + ], + 'GetShareLinkToken' => [ + 'summary' => '匿名获取分享令牌。', + 'path' => '/v2/share_link/get_share_token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + 'share_pwd' => [ + 'description' => '提取码', + 'type' => 'string', + 'required' => false, + 'example' => 'abcF123x', + ], + 'expire_sec' => [ + 'description' => '令牌有效时长。参数合法范围是(0, 7200]；参数为0或缺省时默认7200秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7200', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'share_token' => [ + 'title' => 'Id of the request', + 'description' => 'jwt格式的令牌', + 'type' => 'string', + 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs', + ], + 'expires_in' => [ + 'description' => '多长时间失效，比如7200秒（2个小时）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_token\\": \\"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs\\",\\n \\"expires_in\\": 7200\\n}","type":"json"}]', + 'title' => '获取分享令牌', + 'description' => '文件分享中文件访问流程要求必须先获取share token，即使此分享的share_pwd=""(非私密分享)。', + ], + 'TrashFile' => [ + 'summary' => '文件或文件夹放入回收站。', + 'path' => '/v2/recyclebin/trash', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件或文件夹ID', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'custom_trashed_at' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件或文件夹ID', + 'type' => 'string', + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'async_task_id' => [ + 'description' => '异步任务ID'."\n" + ."\n" + .'如果返回为空字符串，表示直接放入回收站成功。'."\n" + ."\n" + .'如果返回非空字符串，表示需要经过异步处理。调用GetAsyncTask，传递异步任务ID，获取任务信息。', + 'type' => 'string', + 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', + ], + ], + ], + ], + 204 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d317406\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', + 'title' => '放入回收站', + ], + 'ClearRecyclebin' => [ + 'summary' => '清空回收站中所有文件和文件夹。', + 'path' => '/v2/recyclebin/clear', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '1', + ], + 'async_task_id' => [ + 'description' => '异步任务ID'."\n" + ."\n" + .'调用GetAsyncTask，传递异步任务ID，获取任务信息', + 'type' => 'string', + 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', + 'title' => '清空回收站', + ], + 'ListRecyclebin' => [ + 'summary' => '列举回收站。', + 'path' => '/v2/recyclebin/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,200\\]，缺省50。'."\n" + ."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + 'fields' => [ + 'description' => '筛选返回字段：'."\n" + ."\n" + .'1\\. 当填 * 时，返回文件所有字段；'."\n" + ."\n" + .'2\\. 当填空值或不填时，返回的信息不包含文件创建者、文件修改者、用户自定义标签等字段'."\n" + ."\n" + .'默认为空值，只返回部分字段。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + 'thumbnail_processes' => [ + 'description' => '缩略图配置，可一次性返回最多5个缩略图，map的key可以自定义，返回时按key返回对应的缩略图链接', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + '$ref' => '#/components/schemas/ImageProcess', + 'description' => '定义图片、视频、文档的缩略图处理规则', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '回收站中的文件和文件夹列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件或文件夹信息', + '$ref' => '#/components/schemas/File', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1\\"\\n}","type":"json"}]', + 'title' => '列举回收站', + ], + 'RestoreFile' => [ + 'summary' => '从回收站恢复文件或文件夹。', + 'path' => '/v2/recyclebin/restore', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件或文件夹ID', + 'type' => 'string', + 'required' => true, + 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域ID', + 'type' => 'string', + 'example' => 'bj1', + ], + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件或文件夹ID', + 'type' => 'string', + 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + 'async_task_id' => [ + 'description' => '异步任务 ID'."\n" + ."\n" + .'如果返回为空字符串，表示直接从回收站恢复成功。'."\n" + ."\n" + .'如果返回非空字符串，表示需要经过异步处理。调用 GetAsyncTask，传递异步任务 ID，获取任务信息。', + 'type' => 'string', + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + ], + ], + ], + 204 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"4221bf6e6ab43a255edc4463bffa6f5f5d317401\\",\\n \\"async_task_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d317406\\"\\n}","type":"json"}]', + 'title' => '恢复文件或文件夹', + ], + 'UpdateFacegroup' => [ + 'summary' => '更新人脸分组信息。', + 'path' => '/v2/image/update_facegroup_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'group_id' => [ + 'description' => '人脸分组id, 通过列举人脸分组接口返回的结果中获取', + 'type' => 'string', + 'required' => true, + 'example' => 'group-abc', + ], + 'group_name' => [ + 'description' => '人脸分组名称，长度最大128字符', + 'type' => 'string', + 'required' => false, + 'example' => '张三人脸', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'group_cover_face_id' => [ + 'description' => '人脸分组封面人脸ID, 通过文件接口file/get,file/list,file/search的返回结果**ImageMediaMetadata**字段中进行获取'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'face1', + ], + 'remarks' => [ + 'description' => '备注，长度最大128字符', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => 'Id of the request', + 'description' => '空间ID', + 'type' => 'string', + 'example' => '1', + ], + 'group_id' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'group-abc', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"group_id\\": \\"group-abc\\"\\n}","type":"json"}]', + 'title' => '更新人脸分组信息', + ], + 'ListTags' => [ + 'summary' => '列举标签分组。', + 'path' => '/v2/image/list_tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'image_thumbnail_process' => [ + 'description' => '图片缩略图处理', + 'type' => 'string', + 'required' => false, + 'example' => 'image/resize,w_200', + ], + 'video_thumbnail_process' => [ + 'description' => '视频缩略图处理', + 'type' => 'string', + 'required' => false, + 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'tags' => [ + 'description' => '分组列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + '$ref' => '#/components/schemas/ImageTag', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tags\\": [\\n {\\n \\"name\\": \\"动物\\",\\n \\"count\\": 10,\\n \\"cover_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"cover_file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"cover_file_category\\": \\"image\\",\\n \\"cover_tag_confidence\\": 1,\\n \\"cover_overall_score\\": 0.736\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举标签分组', + 'description' => '标签分组接口结果是一次性返回指定的drive内聚合的结果，按照分组内照片数取前top2000个返回。', + ], + 'ListAddressGroups' => [ + 'summary' => '列举地点聚类。', + 'path' => '/v2/image/list_address_groups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量。如果不设定，默认返回100，最大不能超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'image_thumbnail_process' => [ + 'description' => '图片缩略图处理样式', + 'type' => 'string', + 'required' => false, + 'example' => 'image/resize,w_200', + ], + 'video_thumbnail_process' => [ + 'description' => '视频缩略图处理样式', + 'type' => 'string', + 'required' => false, + 'example' => 'video_thumbnail_process', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '地点聚类列表', + 'type' => 'array', + 'items' => [ + 'description' => '地点聚类', + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"count\\": 0,\\n \\"cover_url\\": \\"\\",\\n \\"cover_file_id\\": \\"\\",\\n \\"address_detail\\": {\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"余杭区\\",\\n \\"township\\": \\"文一西路\\"\\n }\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '列举地点聚类', + ], + 'ListFacegroups' => [ + 'summary' => '列举人脸分组。', + 'path' => '/v2/image/list_facegroups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'remarks' => [ + 'description' => '查询过滤使用， 长度最大128字符，采用的是精确匹配过滤', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + 'maxLength' => 128, + 'minLength' => 1, + ], + 'limit' => [ + 'description' => 'limit值，n的取值范围：1~100, 默认100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'marker' => [ + 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" + .'默认值：无', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'return_total_count' => [ + 'description' => '是否返回搜到的文件总数', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '人脸分组列表', + 'type' => 'array', + 'items' => [ + 'description' => '人脸分组', + '$ref' => '#/components/schemas/FaceGroup', + ], + ], + 'next_marker' => [ + 'description' => '下一页起始资源标识符, 最后一页该值为空。', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'total_count' => [ + 'description' => '命中的文件总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"group_id\\": \\"Cluster-ae6e3472-999e-410b-b54e-cd5dba****\\",\\n \\"group_name\\": \\"name\\",\\n \\"image_count\\": 10,\\n \\"created_at\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"updated_at\\": \\"2022-01-14T10:10:52.83948013+08:00\\",\\n \\"group_cover_url\\": \\"https://xxx\\",\\n \\"group_cover_file_id\\": \\"6549c959640fbd517c9b4d93b3b36aecc45xxxxx\\",\\n \\"group_cover_width\\": 1920,\\n \\"group_cover_height\\": 1080,\\n \\"group_cover_face_boundary\\": {\\n \\"Width\\": 200,\\n \\"Height\\": 300,\\n \\"Top\\": 30,\\n \\"Left\\": 10\\n },\\n \\"remarks\\": \\"\\",\\n \\"remarks_array\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 30\\n}","type":"json"}]', + 'title' => '列举人脸分组', + ], + 'SearchAddressGroups' => [ + 'summary' => '根据地点列表查询地点聚类。', + 'path' => '/v2/image/search_address_groups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'tl_geo_point' => [ + 'description' => '矩形的左顶点位置（维度，经度）', + 'type' => 'string', + 'required' => false, + 'example' => '39.121,101.2121', + ], + 'br_geo_point' => [ + 'description' => '矩形的右底点位置（维度，经度）', + 'type' => 'string', + 'required' => false, + 'example' => '40.121,105.2121', + ], + 'address_level' => [ + 'description' => '查询的地点级别', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'country' => 'country', + 'province' => 'province', + 'city' => 'city', + 'district' => 'district', + 'township' => 'township', + ], + 'example' => 'city '."\n" + .'一共有5个值可选：如下所示'."\n" + .'- country'."\n" + .'- province'."\n" + .'- city'."\n" + .'- district'."\n" + .'- township', + ], + 'address_names' => [ + 'description' => '地点列表', + 'type' => 'array', + 'items' => [ + 'description' => '地点列表, 数组内个数最多10个， 内部的值需要与address_level 级别对应，'."\n" + .'该参数与上边tl_geo_point和br_geo_point参数互斥，二者选其一', + 'type' => 'string', + 'required' => false, + 'example' => '["杭州市","北京市"]', + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + 'image_thumbnail_process' => [ + 'description' => '图片缩略图处理样式', + 'type' => 'string', + 'required' => false, + 'example' => 'image/resize,w_200', + ], + 'video_thumbnail_process' => [ + 'description' => '视频缩略图处理样式', + 'type' => 'string', + 'required' => false, + 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '地点聚类列表', + 'type' => 'array', + 'items' => [ + 'description' => '地点聚类', + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"count\\": 0,\\n \\"cover_url\\": \\"\\",\\n \\"cover_file_id\\": \\"\\",\\n \\"address_detail\\": {\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"余杭区\\",\\n \\"township\\": \\"文一西路\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '根据地点列表查询地点聚类', + ], + 'RemoveFaceGroupFile' => [ + 'summary' => '删除人脸分组中的文件。', + 'path' => '/v2/albums/unassign_facegroup_item', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + 'face_group_id' => [ + 'description' => '人脸分组 id', + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster-abc', + ], + 'file_id' => [ + 'description' => '需要被移除人脸分组的文件id', + 'type' => 'string', + 'required' => true, + 'example' => 'abcd', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除人脸分组文件', + ], + 'CreateStory' => [ + 'summary' => '创建推荐故事。'."\n" + .'PDS 会根据请求参数中的故事类型和时间范围筛选 drive 空间下的图片和视频，将符合条件的图片、视频加入该故事的文件列表。'."\n" + .'若没有符合条件的图片、视频，则会创建空故事。', + 'path' => '/v2/image/create_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id。由用户指定。', + 'type' => 'string', + 'required' => false, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'story_type' => [ + 'description' => '故事类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PeopleMemory' => '人物故事', + 'TagMemory' => '标签故事', + 'TimeMemory' => '时光故事', + 'TravelMemory' => '旅行故事', + ], + 'example' => 'TagMemory', + 'enum' => [ + 'TimeMemory', + 'PeopleMemory', + 'TagMemory', + 'TravelMemory', + ], + ], + 'story_sub_type' => [ + 'description' => '故事子类型。其值取决于故事类型，详情可见请求参数补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'Food', + ], + 'story_name' => [ + 'description' => '故事名称。'."\n" + .'长度不超过 1024 个字节。', + 'type' => 'string', + 'required' => false, + 'example' => '美食', + ], + 'story_start_time' => [ + 'description' => '创建故事照片或视频的开始时间。RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-30T16:00:00Z', + ], + 'story_end_time' => [ + 'description' => '创建故事照片或视频的结束时间。RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-30T16:00:00Z', + ], + 'min_image_count' => [ + 'description' => '创建故事照片或视频文件最小个数。'."\n" + .'须大于 0，小于等于 max\\_image\\_count，空值默认为 1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + 'max_image_count' => [ + 'description' => '创建故事照片或视频文件最大个数。'."\n" + .'须小于等于 100，大于等于 min\\_image\\_count，空值默认 30。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'example' => '30', + 'default' => '30', + ], + 'custom_labels' => [ + 'description' => '自定义标签。'."\n" + .'标签数量不能超过 20 个。', + 'type' => 'object', + 'deprecated' => true, + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'label_value', + 'description' => '自定义标签', + ], + ], + 'address' => [ + 'description' => '地址信息', + 'required' => false, + '$ref' => '#/components/schemas/Address', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '创建推荐故事', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。故事相关接口限时免费。'."\n" + ."\n" + .'用户创建故事时可自己指定故事 id：'."\n" + .'- 若指定故事 id：'."\n" + .' - 若故事 id 不存在，则使用该 id 创建新故事；'."\n" + .' - 若故事 id 存在，则会根据新条件生成故事并覆盖更新该故事；'."\n" + .'- 若不指定 id，则会由 PDS 生成故事 id。'."\n" + ."\n\n" + .'> '."\n" + .'> - 该接口为异步接口，用户创建推荐故事后需要等待一定时间生成该故事。用户可以通过 GetStory 接口或者 FindStories 接口去查询创建故事的进度。', + 'requestParamsDescription' => '### 故事类型'."\n" + ."\n" + .'- TimeMemory：时光故事'."\n" + ."\n" + .'- PeopleMemory：人物故事'."\n" + ."\n" + .'- TagMemory：标签故事'."\n" + ."\n" + .'- TravelMemory：旅行故事'."\n" + ."\n" + .'### 故事子类型'."\n" + ."\n" + .'TimeMemory：空'."\n" + ."\n" + .'PeopleMemory：'."\n" + ."\n" + .'- Solo：人物故事，单人故事。搜索数据集里人脸数目最多的人物，根据已做过的人脸聚类的结果生成人物故事，可支持通过时间参数StoryStartTime和StoryEndTime传入时间间隔，即在某段时间间隔内，照片数量最多的人物为候选人物，不会关注是否已有该人物的故事生成'."\n" + ."\n" + .'TagMemory：'."\n" + ."\n" + .'- Food：美食标签故事'."\n" + ."\n" + .'- Pet：宠物标签故事'."\n" + ."\n" + .'- PetDog：宠物狗标签故事'."\n" + ."\n" + .'- PetCat：宠物猫标签故事'."\n" + ."\n" + .'- Scenery：风景标签故事'."\n" + ."\n" + .'TravelMemory：空', + ], + 'CreateCustomizedStory' => [ + 'summary' => '创建自定义故事。'."\n" + .'区别于推荐故事，自定义故事下面的文件列表由用户指定。', + 'path' => '/v2/image/create_customized_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_type' => [ + 'description' => '故事类型。由用户自定义。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_created', + ], + 'story_sub_type' => [ + 'description' => '故事子类型。由用户自定义。', + 'type' => 'string', + 'required' => true, + 'example' => 'user_created', + ], + 'story_name' => [ + 'description' => '故事名称。'."\n" + .'长度不能超过 1024 字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_name', + ], + 'story_cover' => [ + 'description' => '故事封面。该封面必须在故事文件列表中。', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '文件版本 id', + 'type' => 'string', + 'required' => false, + 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', + ], + ], + 'required' => true, + ], + 'story_files' => [ + 'description' => '故事文件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '文件版本 id', + 'type' => 'string', + 'required' => false, + 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + 'custom_labels' => [ + 'description' => '自定义标签。'."\n" + .'标签数量不能超过 20 个。', + 'type' => 'object', + 'deprecated' => true, + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'label_value', + 'description' => '自定义标签', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => '创建自定义故事', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。故事相关接口限时免费。'."\n" + ."\n" + .'用户通过传入指定文件列表创建自定义故事。其中故事类型和故事子类型用户可自定义，不再有约束。'."\n" + ."\n" + .'><notice>通过该接口指定故事封面时，该封面文件必须存在于故事列表中，否则会返回错误。></notice>'."\n" + .'><notice>自定义故事列表中的文件类型只能为图片。></notice>', + ], + 'SearchStories' => [ + 'summary' => '根据用户指定的条件，查询指定 drive 空间下的故事列表。', + 'path' => '/v2/image/find_stories', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => false, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'story_type' => [ + 'description' => '故事类型。由用户创建时指定。', + 'type' => 'string', + 'required' => false, + 'example' => 'PeopleMemory', + ], + 'story_name' => [ + 'description' => '故事名称。'."\n" + .'长度不超过 1024 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '美食', + ], + 'story_start_time_range' => [ + 'description' => '创建故事照片或视频的开始时间范围', + 'type' => 'object', + 'properties' => [ + 'start' => [ + 'description' => '起始时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-31T00:00:00+08:00', + ], + 'end' => [ + 'description' => '结束时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-31T00:00:00+08:00', + ], + ], + 'required' => false, + ], + 'story_end_time_range' => [ + 'description' => '创建故事照片或视频的结束时间范围', + 'type' => 'object', + 'properties' => [ + 'start' => [ + 'description' => '起始时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-31T00:00:00+08:00', + ], + 'end' => [ + 'description' => '结束时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-31T00:00:00+08:00', + ], + ], + 'required' => false, + ], + 'create_time_range' => [ + 'description' => '创建故事时间范围', + 'type' => 'object', + 'properties' => [ + 'start' => [ + 'description' => '起始时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2016-12-31T00:00:00+08:00', + ], + 'end' => [ + 'description' => '结束时间。时间格式为 RFC3339。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-31T00:00:00+08:00', + ], + ], + 'required' => false, + ], + 'face_group_ids' => [ + 'description' => '人脸分组列表。'."\n" + .'查询人物故事时使用。', + 'type' => 'array', + 'items' => [ + 'description' => '人脸分组 id', + 'type' => 'string', + 'required' => false, + 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', + ], + 'required' => false, + ], + 'custom_labels' => [ + 'description' => '自定义标签。'."\n" + .'可查询多个字段，使用 "," 分隔。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'key1=value1,key2!=value2', + ], + 'with_empty_stories' => [ + 'description' => '是否返回空故事。默认 false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'marker' => [ + 'description' => '查询的起始位置。若为空则表示从头开始查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDODBhNDQ2Nzhl***', + ], + 'limit' => [ + 'description' => '限定此次返回资源的数量，取值范围\\[1,100\\]。'."\n" + .'默认 100。'."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + 'default' => '100', + ], + 'sort' => [ + 'description' => '排序字段', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'StoryName' => '按故事名称排序', + 'StoryEndTime' => '按故事结束时间排序', + 'CreateTime' => '按故事创建时间排序', + 'StoryStartTime' => '按故事开始时间排序', + ], + 'example' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'StoryName', + 'StoryStartTime', + 'StoryEndTime', + ], + ], + 'order' => [ + 'description' => '排序方式', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序', + 'desc' => '降序', + ], + 'example' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + 'cover_image_thumbnail_process' => [ + 'description' => '图片封面缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + 'cover_video_thumbnail_process' => [ + 'description' => '视频封面缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', + ], + 'url_expire_sec' => [ + 'description' => '缩略图过期时间。单位为秒，最短 10 秒，最长 86400 秒。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'maximum' => '86400', + 'minimum' => '10', + 'example' => '900', + 'default' => '900', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '故事列表', + 'type' => 'array', + 'items' => [ + 'description' => '故事详情', + '$ref' => '#/components/schemas/Story', + ], + ], + 'next_marker' => [ + 'description' => '下次查询位置', + 'type' => 'string', + 'example' => 'Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"story_id\\": \\"\\",\\n \\"story_type\\": \\"\\",\\n \\"story_sub_type\\": \\"\\",\\n \\"story_name\\": \\"\\",\\n \\"story_start_time\\": \\"\\",\\n \\"story_end_time\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"face_group_ids\\": [\\n \\"\\"\\n ],\\n \\"cover_file_id\\": \\"\\",\\n \\"cover_file_thumbnail_url\\": \\"\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"custom_id\\": \\"\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ],\\n \\"next_marker\\": \\"Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***\\"\\n}","type":"json"}]', + 'title' => '查询故事列表', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'使用查询故事列表前，需要用户调用 CreateStory 或 CreateCustomizedStory 接口创建故事，否则返回空列表。', + ], + 'GetStory' => [ + 'summary' => '获取指定故事详情，包含封面、文件列表等。', + 'path' => '/v2/image/get_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'cover_image_thumbnail_process' => [ + 'description' => '图片封面缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + 'cover_video_thumbnail_process' => [ + 'description' => '视频封面缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', + ], + 'image_url_process' => [ + 'description' => '故事文件图片URL控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + 'image_thumbnail_process' => [ + 'description' => '故事文件图片缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + 'video_thumbnail_process' => [ + 'description' => '故事文件视频缩略图控制参数', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', + ], + 'url_expire_sec' => [ + 'description' => '缩略图过期时间。单位为秒，最短 10 秒，最长 86400 秒'."\n" + ."\n" + .'默认15分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'maximum' => '86400', + 'minimum' => '10', + 'example' => '900', + 'default' => '900', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '故事详情', + '$ref' => '#/components/schemas/Story', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"story_id\\": \\"\\",\\n \\"story_type\\": \\"\\",\\n \\"story_sub_type\\": \\"\\",\\n \\"story_name\\": \\"\\",\\n \\"story_start_time\\": \\"\\",\\n \\"story_end_time\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"face_group_ids\\": [\\n \\"\\"\\n ],\\n \\"cover_file_id\\": \\"\\",\\n \\"cover_file_thumbnail_url\\": \\"\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"custom_id\\": \\"\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取故事详情', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'用户传入指定故事的 id，以获取该故事的详情。', + ], + 'UpdateStory' => [ + 'summary' => '更新指定故事的信息，包含名称、标签、自定义 id、封面等。', + 'path' => '/v2/image/update_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'story_name' => [ + 'description' => '故事名称。'."\n" + .'长度不超过 1024 字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + 'custom_labels' => [ + 'description' => '自定义标签。'."\n" + .'标签数不超过 20 个。', + 'type' => 'object', + 'deprecated' => true, + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'label_value', + 'description' => '自定义标签', + ], + ], + 'cover' => [ + 'description' => '故事封面', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => false, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => false, + 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => '更新故事', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。', + ], + 'DeleteStory' => [ + 'summary' => '删除指定故事。', + 'path' => '/v2/image/delete_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求数据', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '删除故事', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。', + ], + 'AddStoryFiles' => [ + 'summary' => '给指定故事添加文件。', + 'path' => '/v2/image/add_story_files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'files' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => false, + 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'files' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '添加到故事中的文件信息', + '$ref' => '#/components/schemas/AddStoryFile', + ], + ], + 'request_id' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\",\\n \\"files\\": [\\n {\\n \\"file_id\\": \\"63e5e4340f76cb3ead5f40f68163f0f967c1a7bf\\",\\n \\"revision_id\\": \\"642a88dd06e49d9c0a14411ebae606f70edd9a59\\",\\n \\"error_code\\": \\"\\",\\n \\"error_message\\": \\"\\"\\n }\\n ],\\n \\"request_id\\": \\"\\"\\n}","type":"json"}]', + 'title' => '故事中添加文件', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'用户在创建故事后，可以手动给指定故事添加想要的文件。', + ], + 'RemoveStoryFiles' => [ + 'summary' => '移除指定故事中的文件。', + 'path' => '/v2/image/remove_story_files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'files' => [ + 'description' => '文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息', + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '文件 id', + 'type' => 'string', + 'required' => true, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '版本 id', + 'type' => 'string', + 'required' => false, + 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '故事 id', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => '故事中移除文件', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'用户在创建故事后，可以根据需求移除故事中不需要的文件。', + ], + 'CreateSimilarImageClusterTask' => [ + 'summary' => '用户可以发起创建相似图片聚类任务，该任务会将指定 drive 空间下相似的图片聚类在一起。', + 'path' => '/v2/image/create_similar_image_cluster_task', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'description' => '任务 id', + 'type' => 'string', + 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"task_id\\": \\"i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb\\"\\n}","type":"json"}]', + 'title' => '创建相似图片聚类任务', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能，此功能目前限时免费。'."\n" + ."\n" + .'使用步骤：'."\n" + ."\n" + .'- 创建相似图片聚类任务'."\n" + .'- 通过 GetTaskStatus 接口查询相似图片聚类任务是否执行完成'."\n" + .'- 通过 SearchSimilarImageClusters 接口获取相似图片聚类结果'."\n" + ."\n" + .'同一 drive 同一时刻只能有一个相似图片聚类任务运行，若上一任务未结束，再次调用相似图片聚类任务会返回失败。', + ], + 'GetTaskStatus' => [ + 'summary' => '查询增值服务异步任务执行状态。'."\n" + .'目前支持的接口有：CreateSimilarImageClusterTask。', + 'path' => '/v2/image/get_task_status', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'task_id' => [ + 'description' => '任务 id', + 'type' => 'string', + 'required' => true, + 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'running' => '运行中', + 'failed' => '失败', + 'succeeded' => '成功', + ], + 'example' => 'running', + 'enum' => [ + 'running', + 'succeeded', + 'failed', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"running\\"\\n}","type":"json"}]', + 'title' => '查询任务状态', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'该接口旨在查询增值服务异步任务状态，调用该接口前需先创建增值服务异步任务，如 CreateSimilarImageClusterTask，拿到 task id，再查询任务运行状态，判断该任务是否运行成功。', + ], + 'SearchSimilarImageClusters' => [ + 'summary' => '获取指定 drive 空间下的相似图片。', + 'path' => '/v2/image/query_similar_image_clusters', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'marker' => [ + 'description' => '分页标记，从指定位置查询结果。若为空则表示从头开始查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'YWRzX3VzZXJfcHJvZmlsZV9je1bnQh***', + ], + 'limit' => [ + 'description' => '限定此次返回结果的数量，取值范围\\[1,100\\]，默认50。'."\n" + .'返回结果可以小于指定的数量，但不能多于指定的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '50', + 'default' => '50', + ], + 'order' => [ + 'description' => '排序顺序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序', + 'desc' => '降序', + ], + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + 'image_thumbnail_process' => [ + 'description' => '图片缩略图处理样式', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'similar_image_clusters' => [ + 'description' => '相似图片聚类列表', + 'type' => 'array', + 'items' => [ + 'description' => '相似图片聚类详情', + 'type' => 'object', + 'properties' => [ + 'files' => [ + 'description' => '相似图片列表', + 'type' => 'array', + 'items' => [ + 'description' => '文件详情', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + 'next_marker' => [ + 'description' => '用作下次遍历的 marker', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"similar_image_clusters\\": [\\n {\\n \\"files\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***\\"\\n}","type":"json"}]', + 'title' => '查询相似图片聚类结果', + 'description' => '**请确保在使用该接口前，已充分了解 PDS 的收费方式和[价格](~~425220~~)**。'."\n" + ."\n" + .'使用此功能须开通增值服务图片处理功能。'."\n" + ."\n" + .'查询相似图片聚类结果前，需调用 CreateSimilarImageClusterTask 接口创建相似图片聚类任务，拿到 task_id，通过 GetTaskStatus 接口查询该聚类任务是否成功。待聚类任务成功后，再通过 SearchSimilarImageClusters 接口获取相似图片结果。'."\n" + ."\n" + .'><notice>'."\n" + .'- 未执行聚类任务调用该接口返回空列表。'."\n" + .'- 相似图片聚类任务是增量更新聚类结果。若本次聚类任务未完成，则返回上一次聚类结果。'."\n" + .'></notice>', + ], + 'GetAsyncTask' => [ + 'summary' => '获取异步任务信息。', + 'path' => '/v2/async_task/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'async_task_id' => [ + 'description' => '异步任务id', + 'type' => 'string', + 'required' => true, + 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'async_task_id' => [ + 'title' => 'Id of the request', + 'description' => '异步任务id', + 'type' => 'string', + 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + ], + 'status' => [ + 'description' => '<warning>已废弃（推荐使用state字段替代）</warning>'."\n" + ."\n" + .'任务状态'."\n" + ."\n" + .'- Failed（失败）'."\n" + ."\n" + .'- Running（运行中）'."\n" + ."\n" + .'- PartialSucceed（部分成功）'."\n" + ."\n" + .'- Succeed（成功）', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '失败', + 'Running' => '运行中', + 'PartialSucceed' => '部分成功', + 'Succeed' => '成功', + ], + 'example' => 'Succeed', + ], + 'state' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- Failed（失败）'."\n" + ."\n" + .'- Running（运行中）'."\n" + ."\n" + .'- PartialSucceed（部分成功）'."\n" + ."\n" + .'- Succeed（成功）', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'message' => [ + 'description' => '<warning>已废弃（推荐使用error_message字段替代）</warning>'."\n" + .'异步任务错误信息', + 'type' => 'string', + 'example' => 'The request has been failed due to some unknown error. Please try again later.', + ], + 'err_code' => [ + 'description' => '<warning>已废弃（推荐使用error_code字段替代）</warning>'."\n" + .'异步任务错误码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '404', + ], + 'total_process' => [ + 'description' => '异步任务需处理总量，如服务端打包下载需打包的文件量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'consumed_process' => [ + 'description' => '异步任务已处理总量，如服务端打包下载已打包的文件量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'url' => [ + 'description' => '异步任务生成数据的下载地址，如服务端打包下载任务生成下载地址', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + 'error_code' => [ + 'description' => '任务错误码', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'error_message' => [ + 'description' => '任务错误信息', + 'type' => 'string', + 'example' => 'The request has been failed due to some unknown error. Please try again later.', + ], + 'uncompress_file_list' => [ + 'description' => '解压文件信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '解压文件信息', + '$ref' => '#/components/schemas/UncompressedFileInfo', + ], + ], + 'category' => [ + 'description' => '任务自定义类别', + 'type' => 'string', + 'example' => 'album', + ], + 'created_at' => [ + 'description' => '任务创建时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'started_at' => [ + 'description' => '任务开始时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'finished_at' => [ + 'description' => '任务完成时间，ISO格式， 如：2019-03-28T13:03:29.298Z', + 'type' => 'string', + 'example' => '2019-08-20T06:51:27.292Z', + ], + 'skipped_process' => [ + 'description' => '异步任务已跳过处理的数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'failed_process' => [ + 'description' => '异步任务已处理失败的数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"async_task_id\\": \\"000e89fb-cf8f-11e9-8ab4-b6e980803a3b\\",\\n \\"status\\": \\"Succeed\\",\\n \\"state\\": \\"Succeed\\",\\n \\"message\\": \\"The request has been failed due to some unknown error. Please try again later.\\",\\n \\"err_code\\": 404,\\n \\"total_process\\": 1000,\\n \\"consumed_process\\": 100,\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"error_code\\": \\"InternalError\\",\\n \\"error_message\\": \\"The request has been failed due to some unknown error. Please try again later.\\",\\n \\"uncompress_file_list\\": [\\n {\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"\\",\\n \\"size\\": 0,\\n \\"updated_at\\": 0,\\n \\"items\\": [\\n {\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"\\",\\n \\"size\\": 0,\\n \\"updated_at\\": 0,\\n \\"items\\": [\\n {\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"\\",\\n \\"size\\": 0,\\n \\"updated_at\\": 0,\\n \\"items\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"category\\": \\"album\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"started_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"finished_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"skipped_process\\": 0,\\n \\"failed_process\\": 0\\n}","type":"json"}]', + 'title' => '获取异步任务信息', + ], + 'GetVideoPreviewPlayMeta' => [ + 'summary' => '获取视频播放元信息。', + 'path' => '/v2/file/get_video_preview_play_meta', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'category' => [ + 'description' => '所属分类。'."\n" + .'需要开通对应的转码功能，枚举如下：'."\n" + .'- live_transcoding（live边转边播）'."\n" + .'- quick_video（quick边转边播）'."\n" + .'- offline_audio（离线音频转码）'."\n" + .'- offline_video（离线视频转码）', + 'type' => 'string', + 'required' => true, + 'example' => 'live_transcoding', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'title' => 'Id of the request', + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'share_id' => [ + 'description' => '分享id', + 'type' => 'string', + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => 'fileid1', + ], + 'video_preview_play_meta' => [ + 'description' => '播放元信息', + '$ref' => '#/components/schemas/VideoPreviewPlayMeta', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"fileid1\\",\\n \\"video_preview_play_meta\\": {\\n \\"meta\\": {\\n \\"duration\\": 10,\\n \\"width\\": 1280,\\n \\"height\\": 720\\n },\\n \\"live_transcoding_task_list\\": [\\n {\\n \\"template_id\\": \\"264_720p\\",\\n \\"status\\": \\"finished\\",\\n \\"keep_original_resolution\\": true\\n }\\n ],\\n \\"category\\": \\"live_transcoding\\",\\n \\"quick_video_list\\": [\\n {\\n \\"template_id\\": \\"264_720p\\",\\n \\"status\\": \\"finished\\"\\n }\\n ],\\n \\"offline_video_transcoding_list\\": [\\n {\\n \\"template_id\\": \\"264_720p\\",\\n \\"status\\": \\"finished\\",\\n \\"keep_original_resolution\\": \\"true\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取视频播放元信息', + 'description' => '<props="china">详细请参考最佳实践文档：[在线预览视频](~~427477~~)。</props>', + ], + 'GetVideoPreviewPlayInfo' => [ + 'summary' => '获取视频播放信息。', + 'path' => '/v2/file/get_video_preview_play_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => '分享id。'."\n" + .'如果通过分享操作文件，请携带`x-share-token` header鉴权并传递此字段，此时`drive_id`无效。否则请使用`aksk`或者`access_token`方式鉴权，并传递`drive_id`字段。'."\n" + .'`share_id`和`drive_id`两者必须有一个字段赋值。', + 'type' => 'string', + 'required' => false, + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'category' => [ + 'description' => '所属分类。'."\n" + .'需要开通对应的转码功能，枚举如下：'."\n" + .'- live_transcoding（live边转边播）'."\n" + .'- quick_video（quick边转边播）'."\n" + .'- offline_audio（离线音频转码）'."\n" + .'- offline_video（离线视频转码）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'quick_video', + ], + 'template_id' => [ + 'description' => '清晰度模板id。'."\n" + .'填空表示取所有可用清晰度模板', + 'type' => 'string', + 'required' => false, + 'example' => '264_480p', + ], + 'get_without_url' => [ + 'description' => '是否不获取播放url。'."\n" + .'如果填true，只会获取转码元信息，并不会触发ts转码，返回的信息中没有播放url。否则会返回播放url，如果此template_id的视频还未转码，后台将触发器转码。'."\n" + .'转码会产生对应的增值服务费用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'url_expire_sec' => [ + 'description' => 'url超时时间，单位：秒。'."\n" + .'默认15分钟，最大4小时。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + 're_transcode' => [ + 'description' => '是否发起重转。设置为 true 时会对文件发起重转，固定响应 202 等待重试。使用该参数前请先联系我们配置开启支持。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'get_master_url' => [ + 'description' => '是否获取 master m3u8 的 url，仅在 category = quick_video 时有效', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => '域id', + 'type' => 'string', + 'example' => 'bj1', + ], + 'share_id' => [ + 'title' => 'Id of the request', + 'description' => '分享id', + 'type' => 'string', + 'example' => '7JQX1FswpQ8', + ], + 'drive_id' => [ + 'description' => '空间id', + 'type' => 'string', + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'example' => 'fileid1', + ], + 'video_preview_play_info' => [ + 'description' => '播放信息', + '$ref' => '#/components/schemas/VideoPreviewPlayInfo', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"fileid1\\",\\n \\"video_preview_play_info\\": {\\n \\"category\\": \\"live_transcoding\\",\\n \\"meta\\": {\\n \\"duration\\": 0,\\n \\"width\\": 0,\\n \\"height\\": 0\\n },\\n \\"live_transcoding_task_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"keep_original_resolution\\": true,\\n \\"preview_url\\": \\"\\"\\n }\\n ],\\n \\"quick_video_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"preview_url\\": \\"\\"\\n }\\n ],\\n \\"offline_video_transcoding_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"keep_original_resolution\\": true,\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"live_transcoding_subtitle_task_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"quick_video_subtitle_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"offline_video_transcoding_subtitle_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"master_url\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取视频播放信息', + 'description' => '- **请确保在使用该接口前，已充分了解网盘与相册服务产品的收费方式和[价格](~~425220~~)。**'."\n" + ."\n" + .'- 调用该接口前，请确保当前 domain 已开通对应 category 的转码功能。转码功能开通和转码模板配置请联系我们的技术支持，详情参考[联系我们](~~175917~~)。'."\n" + ."\n" + .'- 该接口为同步接口。如果请求时对应文件在对应转码方式上尚未转码，则接口会响应 **202 VideoPreviewWaitAndRetry** 提示等待重试。如果请求时对应文件在对应转码方式上无法转码，则接口会响应 **404 NotFound.VideoPreviewInfo**。'."\n" + ."\n" + .'- 该接口会产生转码数据并保存到租户 domain 的增值数据空间，以供最终用户进行音视频在线播放。对于特定的转码方式，该接口提供了 domain 级去重转码能力。'."\n" + ."\n" + .'- 该接口返回的播放链接在转码类型为 quick_video 时，将包含未进行 URL 编码的 `{ `和` }`字符。IOS 平台开发时请注意先对返回链接进行 URL 解码和编码以避免系统 NSURL 库解码失败。'."\n" + ."\n" + .'- 该接口返回的播放链接在转码类型为 quick_video 时，根据链接对应 m3u8 内容获取分片内容时将不支持 Range Get。'."\n" + ."\n" + .'<props="china">更多详细内容请参考最佳实践文档：[在线预览视频](~~427477~~)。</props>', + ], + 'CreateIdentityToBenefitPkgMapping' => [ + 'summary' => '创建实体和权益包关联，可用于给用户绑定权益包。', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'description' => '实体的类型'."\n" + ."\n" + .'管理用户权益时，传user', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + ], + ], + 'identity_id' => [ + 'description' => '实体的唯一标识'."\n" + ."\n" + .'管理用户权益时，传user_id', + 'type' => 'string', + 'required' => true, + 'example' => 'user123', + ], + 'benefit_pkg_id' => [ + 'description' => '权益包的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '40cb7794c9294', + ], + 'amount' => [ + 'description' => '权益包数量'."\n" + ."\n" + .'对资源类权益包生效，非必填参数，默认为1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'expire_time' => [ + 'description' => '权益包超期时间的时间戳，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数'."\n" + ."\n" + .'默认永不过期', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1633167071000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '创建实体和权益包关联', + 'description' => '如果您需要基于PDS做面向大量用户的二次运营，可以基于权益对用户可使用的功能和配额进行控制。 详情请联系官方钉钉群进行咨询：23146118', + ], + 'UpdateIdentityToBenefitPkgMapping' => [ + 'summary' => '更新实体和权益包关联，可用于给用户绑定权益包。', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'description' => '实体的类型'."\n" + .'管理用户权益，传user', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + ], + ], + 'identity_id' => [ + 'description' => '实体的唯一标识'."\n" + ."\n" + .'管理用户权益时，传user_id', + 'type' => 'string', + 'required' => true, + 'example' => 'user123', + ], + 'benefit_pkg_id' => [ + 'description' => '权益包的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '40cb7794c9294', + ], + 'amount' => [ + 'description' => '权益包数量'."\n" + ."\n" + .'对资源类权益包生效，非必填参数，默认为1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'expire_time' => [ + 'description' => '权益包超期时间的时间戳，格林威治时间1970年01月01日00时00分00秒起至现在的毫秒数'."\n" + ."\n" + .'默认永不过期', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1633167071000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新实体和权益包关联', + ], + 'GetIdentityToBenefitPkgMapping' => [ + 'summary' => '获取实体和权益包关联，可用于获取用户绑定的权益包。', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'description' => '实体的类型'."\n" + .'管理用户权益，传user', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + ], + ], + 'identity_id' => [ + 'description' => '实体的唯一标识'."\n" + ."\n" + .'管理用户权益时，传user_id', + 'type' => 'string', + 'required' => true, + 'example' => 'user123', + ], + 'benefit_pkg_id' => [ + 'description' => '权益包的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '40cb7794c9294', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实体绑定的权益包信息', + '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"identity_type\\": \\"\\",\\n \\"identity_id\\": \\"\\",\\n \\"benefit_pkg_owner_id\\": \\"\\",\\n \\"benefit_pkg_id\\": \\"\\",\\n \\"benefit_pkg_type\\": \\"\\",\\n \\"benefit_pkg_name\\": \\"\\",\\n \\"benefit_pkg_priority\\": 0,\\n \\"benefit_pkg_computation_rule\\": \\"\\",\\n \\"delivery_info_list\\": [\\n {\\n \\"amount\\": 0,\\n \\"is_permanent\\": true,\\n \\"expire_time\\": \\"\\",\\n \\"created_at\\": \\"\\"\\n }\\n ],\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '获取实体和权益包关联', + ], + 'ListIdentityToBenefitPkgMapping' => [ + 'summary' => '列举实体和权益包关联，可用于获取用户绑定的权益包列表。', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'identity_type' => [ + 'description' => '实体的类型'."\n" + .'管理用户权益，传user', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + 'enum' => [ + 'user', + ], + ], + 'identity_id' => [ + 'description' => '实体的唯一标识'."\n" + ."\n" + .'管理用户权益时，传user_id', + 'type' => 'string', + 'required' => true, + 'example' => 'user123', + ], + 'include_expired' => [ + 'description' => '是否返回已经超期的权益包，默认为false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '实体绑定的权益包信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '实体绑定的权益包信息', + '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"identity_type\\": \\"\\",\\n \\"identity_id\\": \\"\\",\\n \\"benefit_pkg_owner_id\\": \\"\\",\\n \\"benefit_pkg_id\\": \\"\\",\\n \\"benefit_pkg_type\\": \\"\\",\\n \\"benefit_pkg_name\\": \\"\\",\\n \\"benefit_pkg_priority\\": 0,\\n \\"benefit_pkg_computation_rule\\": \\"\\",\\n \\"delivery_info_list\\": [\\n {\\n \\"amount\\": 0,\\n \\"is_permanent\\": true,\\n \\"expire_time\\": \\"\\",\\n \\"created_at\\": \\"\\"\\n }\\n ],\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举实体和权益包关联', + ], + 'InvestigateFile' => [ + 'summary' => '将未经审核的文件送审。', + 'path' => '/v2/csi/investigate_file', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'drive_file_ids' => [ + 'description' => '空间和文件ID的组合，至多5个。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件ID', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 202 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '审核文件', + 'description' => '可对图片和视频（不含音频）进行审核。动图、长图的截帧/切割频率为1，最多100张；视频的截帧频率为3秒，最多1500帧。审核结果可以通过列举文件、获取文件详情和获取文件内容安全详情接口查询以及使用事件通知功能推送。请勿使用此接口集中的批量送审文件，以免受资源限制导致审核失败。', + ], + 'CsiGetFileInfo' => [ + 'summary' => '获取文件的内容安全详情。', + 'path' => '/v2/csi/get_file_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '空间 id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '文件id', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'url_expire_sec' => [ + 'description' => '可选填下载链接过期时间，单位为秒，取值范围为：[10,14400] 秒。'."\n" + .'填写此字段时提供下载链接，默认不提供下载链接。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '14400', + 'minimum' => '10', + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'investigation_info' => [ + 'description' => '审核信息', + '$ref' => '#/components/schemas/InvestigationInfo', + ], + 'url' => [ + 'description' => '文件下载链接', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\",\\n \\"video_detail\\": {\\n \\"block_frames\\": [\\n {\\n \\"rate\\": 0,\\n \\"offset\\": 0,\\n \\"label\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\"\\n}","type":"json"}]', + 'title' => '获取文件内容安全详情', + ], + 'Batch' => [ + 'summary' => '支持批量调用部分API，提升调用效率。', + 'path' => '/v2/batch', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'resource' => [ + 'description' => '请求的资源，支持的资源类型包括：'."\n" + ."\n" + .'- file（文件）'."\n" + .'- drive（个人/团队云盘）'."\n" + .'- user（用户）'."\n" + .'- group（群组）'."\n" + .'- membership（群组成员）'."\n" + .'- share\\_link（分享）'."\n" + .'- async\\_task（异步任务）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'share_link' => '分享', + 'file' => '文件', + 'async_task' => '异步任务', + 'membership' => '群组成员', + 'drive' => '个人/团队云盘', + 'user' => '用户', + 'group' => '群组', + ], + 'example' => 'file', + ], + 'requests' => [ + 'description' => '子请求合集'."\n" + ."\n" + .'子请求的数量，有效范围是[1,100]', + 'type' => 'array', + 'items' => [ + 'description' => '一个子请求内容', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '子请求 id，用于request 和 response关联， 不允许重复', + 'type' => 'string', + 'required' => true, + 'example' => '93433894994ad2e1', + ], + 'method' => [ + 'description' => '子请求的方法，支持：'."\n" + ."\n" + .'- POST'."\n" + .'- GET'."\n" + .'- PUT'."\n" + .'- DELETE'."\n" + .'- HEAD'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'HEAD' => 'HEAD', + 'DELETE' => 'DELETE', + 'POST' => 'POST', + 'GET' => 'GET', + 'PUT' => 'PUT', + ], + 'example' => 'POST', + ], + 'url' => [ + 'description' => 'url 子请求的api path路径， 支持：'."\n" + ."\n" + .'- /file/get（获取文件详情）'."\n" + .'- /file/update（修改文件信息）'."\n" + .'- /file/search（搜索文件）'."\n" + .'- /file/copy（复制文件或文件夹）'."\n" + .'- /file/move（移动文件或文件夹）'."\n" + .'- /file/delete（删除文件或文件夹）'."\n" + .'- /file/get_download_url（获取文件下载地址）'."\n" + .'- /file/get_share_link_download_url（获取分享下载地址）'."\n" + .'- /recyclebin/trash（放入回收站）'."\n" + .'- /recyclebin/restore（恢复文件或文件夹）'."\n" + .'- /file/put_usertags（设置用户标签）'."\n" + .'- /file/delete_usertags（删除用户标签）'."\n" + .'- /drive/get（获取空间信息）'."\n" + .'- /user/get（获取用户信息）'."\n" + .'- /group/get（获取群组信息）'."\n" + .'- /share_link/create（创建分享）'."\n" + .'- /share_link/update（修改分享）'."\n" + .'- /share_link/cancel（取消分享）'."\n" + .'- /share_link/list（列举分享）'."\n" + .'- /share_link/get（获取分享信息）'."\n" + .'- /share_link/get_share_token（获取分享令牌）'."\n" + .'- /async_task/get（获取异步任务信息）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + '/file/copy' => '复制文件或文件夹', + '/file/get_share_link_download_url' => '获取分享下载地址', + '/file/move' => '移动文件或文件夹', + '/share_link/create' => '创建分享', + '/share_link/update' => '修改分享', + '/async_task/get' => '获取异步任务信息', + '/drive/get' => '获取空间信息', + '/group/get' => '获取群组信息', + '/share_link/list' => '列举分享', + '/file/delete' => '删除文件或文件夹', + '/share_link/get' => '获取分享信息', + '/file/get' => '获取文件详情', + '/file/get_download_url' => '获取文件下载地址', + '/recyclebin/restore' => '恢复文件或文件夹', + '/file/update' => '修改文件信息', + '/recyclebin/trash' => '放入回收站', + '/file/search' => '搜索文件', + '/user/get' => '获取用户信息', + '/share_link/get_share_token' => '获取分享令牌', + '/share_link/cancel' => '取消分享', + ], + 'example' => '/file/get', + ], + 'body' => [ + 'description' => '子请求的请求参数JSON字符串，可参考相应子请求API文档'."\n" + ."\n" + .'当指定了body必须传headers："Content-Type" 对应的类型，目前子请求入参是"application/json"', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '子请求的请求body', + 'example' => '{"domain_id":"1","drive_id":"1"}', + ], + ], + 'headers' => [ + 'description' => '子请求的请求头，表示body传入数据的类型', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '子请求的请求headers', + 'example' => '{"Content-Type":"application/json"}', + ], + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'responses' => [ + 'description' => '子请求的响应合集', + 'type' => 'array', + 'items' => [ + 'description' => '一个子请求响应内容', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '子请求 id，和request进行关联', + 'type' => 'string', + 'example' => '93433894994ad2e1', + ], + 'status' => [ + 'description' => '子请求的返回状态码，可参考相应子请求API文档', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'body' => [ + 'description' => '子请求的响应结果，可参考相应子请求API文档', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '子请求的响应body', + 'example' => '{"domain_id":"1","drive_id":"1","file_id":"9520943DC264"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"responses\\": [\\n {\\n \\"id\\": \\"93433894994ad2e1\\",\\n \\"status\\": 200,\\n \\"body\\": {\\n \\"key\\": \\"{\\\\\\"domain_id\\\\\\":\\\\\\"1\\\\\\",\\\\\\"drive_id\\\\\\":\\\\\\"1\\\\\\",\\\\\\"file_id\\\\\\":\\\\\\"9520943DC264\\\\\\"}\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量调用API', + ], + 'AuditLogExport' => [ + 'summary' => '导出审计日志。', + 'path' => '/v2/audit_log/export', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'query' => [ + 'description' => '支持根据以下字段组合查询：'."\n" + .'- drive_id（空间ID，string）'."\n" + .'- actor_id（操作者ID，string）'."\n" + .'- acted_at（操作时间，date，格式"2006-01-02T00:00:00"，只支持零时区）'."\n" + .'- action_type（操作类型，string）', + 'type' => 'string', + 'required' => false, + 'example' => 'acted_at > \'2025-03-10T16:00:00\' and acted_at < \'2025-03-17T15:59:59\'', + ], + 'order_by' => [ + 'description' => '排序字段，支持操作时间（acted_at）排序。默认值：空，按照操作时间逆序排序。支持参数：'."\n" + ."\n" + .'- acted_at DESC（按操作时间逆序）'."\n" + .'- acted_at ASC（按操作时间正序）', + 'type' => 'string', + 'required' => false, + 'example' => 'acted_at DESC', + ], + 'file_name' => [ + 'description' => '导出的文件名，长度不超过1024。默认为log.csv', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-log.csv', + ], + 'language' => [ + 'description' => '导出语言，默认中文。支持参数：'."\n" + ."\n" + .'- zh_CN（中文）'."\n" + .'- en_US（英文）', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'async_task_id' => [ + 'title' => 'Id of the request', + 'description' => '审计日志导出的异步任务 id', + 'type' => 'string', + 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d31****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"async_task_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d31****\\"\\n}","type":"json"}]', + 'title' => '导出审计日志', + 'description' => '网盘与相册服务开发版，日志审计属于增值功能，请确保在使用该接口前，已充分了解<props="china">[增值服务计费项](https://help.aliyun.com/zh/pds/drive-and-photo-service-dev/product-overview/billable-items-for-value-added-features)</props><props="intl">[增值服务计费项](https://www.alibabacloud.com/help/document_detail/425220.html)</props>。', + ], + 'GetDomainQuota' => [ + 'summary' => '获取domain限额', + 'path' => '/v2/domain/get_quota', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'size_quota' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'size_used' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'user_count_quota' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'user_count_used' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '', + ], + 'GroupUpdateName' => [ + 'summary' => '更新用户组名字', + 'path' => '/v2/group/update_name', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'type' => 'string', + 'required' => true, + ], + 'name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + '$ref' => '#/components/schemas/BaseGroupResponse', + ], + ], + ], + 'responseDemo' => '', + ], + 'PunishFile' => [ + 'summary' => '处罚文件。', + 'path' => '/v2/csi/business/punish_file', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => '域id', + 'description' => '域id', + 'type' => 'string', + 'required' => false, + 'example' => 'bj2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体', + 'description' => '域id', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '处罚的文件所属空间 ID', + 'description' => '处罚的文件所属drive_id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'title' => '处罚的文件 ID', + 'description' => '处罚的文件file_id', + 'type' => 'string', + 'required' => true, + 'example' => '2498DZ2', + ], + 'action_code' => [ + 'title' => '处罚动作，枚举值：'."\n" + .'pds_file_meta_frozen: 冻结文件'."\n" + .'pds_file_meta_share_forbidden: 禁止分享'."\n" + .'pds_file_meta_remove_punish：解除处罚'."\n" + .'pds_file_frozen：冻结文件（文件内容级别）'."\n" + .'pds_fileshare_forbidden：禁止分享（文件内容级别）'."\n" + .'pds_file_remove_punish：解除处罚（文件内容级别）', + 'description' => '处罚动作，可选的值：'."\n" + .'`pds_file_meta_frozen`: 冻结文件'."\n" + .'`pds_file_meta_share_forbidden`: 禁止分享 '."\n" + .'`pds_file_meta_remove_punish`：解除处罚'."\n" + .'`pds_file_frozen`：冻结文件（文件内容级别）'."\n" + .'`'."\0".'pds_fileshare_forbidden`：禁止分享（文件内容级别）'."\n" + .'`pds_file_remove_punish`：解除处罚（文件内容级别）'."\n" + .'文件内容级别的处罚会影响所有内容相同的文件，非文件内容级别的处罚只影响指定的文件。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'pds_file_remove_punish' => 'pds_file_remove_punish', + 'pds_fileshare_forbidden' => 'pds_fileshare_forbidden', + 'pds_file_frozen' => 'pds_file_frozen', + 'pds_file_meta_frozen' => 'pds_file_meta_frozen', + 'pds_file_meta_remove_punish' => 'pds_file_meta_remove_punish', + 'pds_file_meta_share_forbidden' => 'pds_file_meta_share_forbidden', + ], + 'example' => 'pds_file_meta_frozen', + ], + 'punish_reason' => [ + 'title' => '处罚原因', + 'description' => '处罚的原因', + 'type' => 'string', + 'required' => false, + 'example' => 'illegal', + ], + ], + 'required' => false, + 'example' => 'bj2', + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '处罚文件', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cn-shenzhen.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cn-beijing.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cn-zhangjiakou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cn-hangzhou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cn-shanghai.admin.aliyunpds.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ap-southeast-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'cn-guangzhou.admin.aliyunpds.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cn-hongkong.admin.aliyunpds.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'us-west-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'eu-central-1.admin.aliyunpds.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ap-southeast-5.admin.aliyunpds.com', + ], + ], +]; |