diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/pds/2022-03-01 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/pds/2022-03-01')
| -rw-r--r-- | data/en_us/pds/2022-03-01/api-docs.php | 19043 |
1 files changed, 6139 insertions, 12904 deletions
diff --git a/data/en_us/pds/2022-03-01/api-docs.php b/data/en_us/pds/2022-03-01/api-docs.php index 3f6be60..1d8eb92 100644 --- a/data/en_us/pds/2022-03-01/api-docs.php +++ b/data/en_us/pds/2022-03-01/api-docs.php @@ -1,253 +1,91 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'PDS', - 'product' => 'pds', - 'version' => '2022-03-01', - ], + 'info' => ['style' => 'ROA', 'product' => 'pds', 'version' => '2022-03-01'], 'directories' => [ [ - 'id' => 181654, - 'title' => 'Domain Management', + 'children' => ['UpdateDomain', 'ListDomains', 'GetDomain', 'DeleteDomain', 'CreateDomain', 'SearchDomains'], 'type' => 'directory', - 'children' => [ - 'CreateDomain', - 'GetDomain', - 'UpdateDomain', - 'ListDomains', - 'SearchDomains', - 'DeleteDomain', - ], + 'title' => 'Domain management', ], [ - 'id' => 165270, - 'title' => 'Authentication and Authorization', + 'children' => ['Authorize', 'Token'], 'type' => 'directory', - 'children' => [ - 'Authorize', - 'Token', - ], + 'title' => 'Authentication and authorization', ], [ - 'id' => 163808, - 'title' => 'Account Management', + 'children' => ['GetLinkInfoByUserId', 'LinkAccount', 'GetLinkInfo', 'UnLinkAccount'], 'type' => 'directory', - 'children' => [ - 'GetLinkInfoByUserId', - 'LinkAccount', - 'GetLinkInfo', - 'UnLinkAccount', - ], + 'title' => 'Account management', ], [ - 'id' => 165207, - 'title' => 'Group Management', + 'children' => ['UpdateGroup', 'GetGroup', 'DeleteGroup', 'CreateGroup', 'GroupUpdateName', 'ListGroup', 'AddGroupMember', 'RemoveGroupMember', 'ListGroupMember'], 'type' => 'directory', - 'children' => [ - 'CreateGroup', - 'UpdateGroup', - 'GetGroup', - 'ListGroup', - 'DeleteGroup', - 'AddGroupMember', - 'RemoveGroupMember', - 'ListGroupMember', - ], + 'title' => 'Group management', ], [ - 'id' => 163812, - 'title' => 'User Management', + 'children' => ['GetUser', 'CreateUser', 'ImportUser', 'UpdateUser', 'DeleteUser', 'ListUser', 'SearchUser'], 'type' => 'directory', - 'children' => [ - 'CreateUser', - 'ImportUser', - 'UpdateUser', - 'GetUser', - 'ListUser', - 'SearchUser', - 'DeleteUser', - ], + 'title' => 'User management', ], [ - 'id' => 163815, - 'title' => 'Space Management', + 'children' => ['DeleteDrive', 'CreateDrive', 'UpdateDrive', 'GetDrive', 'ListDrive', 'GetDefaultDrive', 'ListMyDrives', 'SearchDrive'], 'type' => 'directory', - 'children' => [ - 'CreateDrive', - 'UpdateDrive', - 'GetDrive', - 'ListDrive', - 'GetDefaultDrive', - 'ListMyDrives', - 'SearchDrive', - 'DeleteDrive', - ], + 'title' => 'Space management', ], [ - 'id' => 163817, - 'title' => 'File Management', + 'children' => ['ListFile', 'CreateFile', 'DeleteFile', 'UpdateFile', 'SearchFile', 'GetFile', 'DownloadFile', 'GetUploadUrl', 'ListUploadedParts', 'CompleteFile', 'MoveFile', 'CopyFile', 'GetDownloadUrl', 'FilePutUserTags', 'FileDeleteUserTags', 'VideoDRMLicense'], 'type' => 'directory', - 'children' => [ - 'CreateFile', - 'DeleteFile', - 'UpdateFile', - 'SearchFile', - 'ListFile', - 'GetFile', - 'DownloadFile', - 'GetUploadUrl', - 'ListUploadedParts', - 'CompleteFile', - 'MoveFile', - 'CopyFile', - 'GetDownloadUrl', - 'FilePutUserTags', - 'FileDeleteUserTags', - 'VideoDRMLicense', - ], - ], - [ - 'id' => 168925, - 'title' => 'File multi-version management', - 'type' => 'directory', - 'children' => [ - 'DeleteRevision', - 'UpdateRevision', - 'RestoreRevision', - 'ListRevision', - 'GetRevision', - ], - ], - [ - 'id' => 165276, - 'title' => 'Incremental processing', - 'type' => 'directory', - 'children' => [ - 'ScanFile', - 'ListDelta', - 'DeltaGetLastCursor', - ], + 'title' => 'File management', ], [ - 'id' => 164951, - 'title' => 'Permission Management', + 'children' => ['DeleteRevision', 'UpdateRevision', 'RestoreRevision', 'ListRevision', 'GetRevision'], 'type' => 'directory', - 'children' => [ - 'ListReceivedFile', - 'ListMyGroupDrive', - 'FileRemovePermission', - 'FileAddPermission', - 'FileListPermission', - 'ListAssignment', - 'AssignRole', - 'CancelAssignRole', - ], + 'title' => 'File versioning management', ], [ - 'id' => 164958, - 'title' => 'ShareLink Management', + 'children' => ['ScanFile', 'ListDelta', 'DeltaGetLastCursor'], 'type' => 'directory', - 'children' => [ - 'CreateShareLink', - 'UpdateShareLink', - 'SearchShareLink', - 'CancelShareLink', - 'ListShareLink', - 'GetShareLink', - 'GetShareLinkByAnonymous', - 'GetShareLinkToken', - ], + 'title' => 'Incremental processing', ], [ - 'id' => 164964, - 'title' => 'Recycle Bin Management', + 'children' => ['ListReceivedFile', 'ListMyGroupDrive', 'FileRemovePermission', 'FileAddPermission', 'FileListPermission', 'ListAssignment', 'AssignRole', 'CancelAssignRole'], 'type' => 'directory', - 'children' => [ - 'TrashFile', - 'ClearRecyclebin', - 'ListRecyclebin', - 'RestoreFile', - ], + 'title' => 'Permission management', ], [ - 'id' => 163810, - 'title' => 'Image AI Management', + 'children' => ['CreateShareLink', 'UpdateShareLink', 'SearchShareLink', 'CancelShareLink', 'ListShareLink', 'GetShareLink', 'GetShareLinkByAnonymous', 'GetShareLinkToken'], 'type' => 'directory', - 'children' => [ - 'UpdateFacegroup', - 'ListTags', - 'ListAddressGroups', - 'ListFacegroups', - 'SearchAddressGroups', - 'RemoveFaceGroupFile', - 'CreateStory', - 'CreateCustomizedStory', - 'SearchStories', - 'GetStory', - 'UpdateStory', - 'DeleteStory', - 'AddStoryFiles', - 'RemoveStoryFiles', - 'CreateSimilarImageClusterTask', - 'GetTaskStatus', - 'SearchSimilarImageClusters', - ], + 'title' => 'Share management', ], [ - 'id' => 165162, - 'title' => 'Job Management', + 'children' => ['TrashFile', 'ClearRecyclebin', 'ListRecyclebin', 'RestoreFile'], 'type' => 'directory', - 'children' => [ - 'GetAsyncTask', - ], + 'title' => 'Recycle bin management', ], [ - 'id' => 166916, - 'title' => 'Online Video Preview', + 'children' => ['UpdateFacegroup', 'ListTags', 'ListAddressGroups', 'ListFacegroups', 'SearchAddressGroups', 'RemoveFaceGroupFile', 'CreateStory', 'CreateCustomizedStory', 'SearchStories', 'GetStory', 'UpdateStory', 'DeleteStory', 'AddStoryFiles', 'RemoveStoryFiles', 'CreateSimilarImageClusterTask', 'GetTaskStatus', 'SearchSimilarImageClusters'], 'type' => 'directory', - 'children' => [ - 'GetVideoPreviewPlayMeta', - 'GetVideoPreviewPlayInfo', - ], + 'title' => 'Image AI management', ], [ - 'id' => 182149, - 'title' => 'Benefit Management', + 'children' => ['GetVideoPreviewPlayMeta', 'GetVideoPreviewPlayInfo'], 'type' => 'directory', - 'children' => [ - 'CreateIdentityToBenefitPkgMapping', - 'UpdateIdentityToBenefitPkgMapping', - 'GetIdentityToBenefitPkgMapping', - 'ListIdentityToBenefitPkgMapping', - ], + 'title' => 'Online video preview', ], [ - 'id' => 182158, - 'title' => 'Content Security Management', + 'children' => ['CreateIdentityToBenefitPkgMapping', 'UpdateIdentityToBenefitPkgMapping', 'GetIdentityToBenefitPkgMapping', 'ListIdentityToBenefitPkgMapping'], 'type' => 'directory', - 'children' => [ - 'InvestigateFile', - 'CsiGetFileInfo', - ], + 'title' => 'Quota management', ], [ - 'id' => 172104, - 'title' => 'Other', + 'children' => ['PunishFile', 'InvestigateFile', 'CsiGetFileInfo'], 'type' => 'directory', - 'children' => [ - 'Batch', - 'AuditLogExport', - 'GetDomainQuota', - 'GroupUpdateName', - ], + 'title' => 'Content security management', ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['Batch', 'AuditLogExport', 'GetDomainQuota', 'ArchiveFiles', 'GetAsyncTask'], 'type' => 'directory', - 'children' => [ - 'PunishFile', - ], + 'title' => 'Others', ], ], 'components' => [ @@ -255,209 +93,78 @@ 'AccountLinkInfo' => [ 'title' => 'A short description of struct', 'description' => 'The information about the associated account.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - 'backendName' => 'domain_id', - ], - 'authentication_type' => [ - 'title' => '', - 'description' => 'The type of the account. Valid values:'."\n" - ."\n" - .'* mobile: mobile number'."\n" - .'* email: email address'."\n" - .'* ding: DingTalk account'."\n" - .'* ram: Alibaba Cloud Resource Access Management (RAM) user'."\n" - .'* wechat: WeCom account'."\n" - .'* ldap: Lightweight Directory Access Protocol (LDAP) account'."\n" - .'* custom: custom account'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'mobile', - 'backendName' => 'authentication_type', - ], - 'identity' => [ - 'title' => '', - 'description' => 'The unique identifier of the account.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '136***000', - 'backendName' => 'identity', - ], - 'extra' => [ - 'title' => '', - 'description' => 'The additional information about the account. If the account type is a mobile number, the value of this parameter indicates the country code. For example, the country code in the Chinese mainland is 86 and a value of 86 is returned only if authentication_type is set to mobile.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '86', - 'backendName' => 'extra', - ], - 'user_id' => [ - 'title' => '', - 'description' => 'The user ID of the account.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '00016a587b62b50003deea299a4f5b50', - 'backendName' => 'user_id', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639762579768', - 'backendName' => 'created_at', - ], - 'display_name' => [ - 'title' => '', - 'description' => 'The display name of the account. For example, the unique identifier of an LDAP account is its UID, but the account display name can be the job number or other information.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '001', - 'backendName' => 'display_name', - ], + 'domain_id' => ['title' => '域ID', 'description' => 'The domain ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'bj1', 'backendName' => 'domain_id'], + 'authentication_type' => ['title' => '账号类型', 'description' => 'The type of the account. Valid values:'."\n" + ."\n" + .'* mobile: mobile number'."\n" + .'* email: email address'."\n" + .'* ding: DingTalk account'."\n" + .'* ram: Alibaba Cloud Resource Access Management (RAM) user'."\n" + .'* wechat: WeCom account'."\n" + .'* ldap: Lightweight Directory Access Protocol (LDAP) account'."\n" + .'* custom: custom account'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'mobile', 'backendName' => 'authentication_type'], + 'identity' => ['title' => '账号唯一标识', 'description' => 'The unique identifier of the account.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '136***000', 'backendName' => 'identity'], + 'extra' => ['title' => '账号附加信息', 'description' => 'The additional information about the account. If the account type is a mobile number, the value of this parameter indicates the country code. For example, the country code in the Chinese mainland is 86 and a value of 86 is returned only if authentication_type is set to mobile.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '86', 'backendName' => 'extra'], + 'user_id' => ['title' => '账号对应的用户ID', 'description' => 'The user ID of the account.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '00016a587b62b50003deea299a4f5b50', 'backendName' => 'user_id'], + 'created_at' => ['title' => '账号创建时间', 'description' => 'The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579768', 'backendName' => 'created_at'], + 'display_name' => ['title' => '账号显示名', 'description' => 'The display name of the account. For example, the unique identifier of an LDAP account is its UID, but the account display name can be the job number or other information.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '001', 'backendName' => 'display_name'], + 'status' => ['title' => '账号状态', 'description' => '账号状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'normal'], + 'last_login_time' => ['title' => '账号最后一次登录的时间', 'description' => '账号最后一次登录的时间，从1970年1月1日0点到现在的毫秒时间戳', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579769'], ], ], 'Address' => [ - 'title' => '', + 'title' => '地点', 'description' => 'The address.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'country' => [ - 'title' => '', - 'description' => 'The country or region.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None ', - ], - 'province' => [ - 'title' => '', - 'description' => 'The province.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None', - ], - 'city' => [ - 'title' => '', - 'description' => 'The city.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None', - ], - 'district' => [ - 'title' => '', - 'description' => 'The district.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None', - ], - 'township' => [ - 'title' => '', - 'description' => 'The street.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None'."\n", - ], + 'country' => ['title' => '国家或地区', 'description' => 'The country or region.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'None '], + 'province' => ['title' => '省', 'description' => 'The province.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'None'], + 'city' => ['title' => '城市', 'description' => 'The city.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'None'], + 'district' => ['title' => '区', 'description' => 'The district.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'None'], + 'township' => ['title' => '街道', 'description' => 'The street.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'None'."\n"], ], 'nullable' => true, ], 'AddressGroup' => [ - 'title' => '', - 'description' => 'The information about the site group.'."\n", - 'visibility' => 'public', + 'title' => '地点分组', + 'description' => 'Location group', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The name of the site.'."\n", - 'visibility' => 'public', - 'type' => 'string', - ], - 'location' => [ - 'title' => '', - 'description' => 'The latitude and longitude of the site.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '30.12231,120.1212', - ], - 'count' => [ - 'title' => '', - 'description' => 'The number of files in the site group.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'cover_url' => [ - 'title' => '', - 'description' => 'The URL of the cover image of the site.'."\n", - 'visibility' => 'public', - 'type' => 'string', - ], - 'cover_file_id' => [ - 'title' => '', - 'description' => 'The ID of the cover image of the site.'."\n", - 'visibility' => 'public', - 'type' => 'string', - ], - 'address_detail' => [ - 'title' => '', - 'description' => 'The information about the site.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Address', - ], - ], + 'name' => ['title' => '地点名称', 'description' => 'Name of the location', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'location' => ['title' => '经纬度', 'description' => 'Latitude and longitude', 'type' => 'string', 'example' => '30.12231,120.1212', 'visibility' => 'Public'], + 'count' => ['title' => '地点数量', 'description' => 'Number of files in the address group', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public'], + 'cover_url' => ['title' => '地点封面图片地址', 'description' => 'Address thumbnail image URL', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'cover_file_id' => ['title' => '地点封面图片文件ID', 'description' => 'The ID of the location\'s thumbnail file.', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'address_detail' => ['title' => '地点详细信息', 'description' => 'Address details', '$ref' => '#/components/schemas/Address', 'example' => '', 'visibility' => 'Public'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'AddStoryFile' => [ - 'title' => '', - 'description' => 'Returns the files added to the story and their success or failure'."\n", - 'visibility' => 'Private', + 'title' => '向故事中添加文件的相关返回信息', + 'description' => 'Returns the file added to the story and whether the operation succeeded', 'type' => 'object', 'properties' => [ - 'file_id' => [ - 'title' => '', - 'description' => 'The file ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'title' => '', - 'description' => 'File version.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', - ], - 'error_code' => [ - 'title' => '', - 'description' => 'Error codes when adding a single file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - ], - 'error_message' => [ - 'title' => '', - 'description' => 'Error message when adding a single file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - ], + 'file_id' => ['title' => '文件id', 'description' => 'File ID', 'type' => 'string', 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'visibility' => 'Public'], + 'revision_id' => ['title' => '文件版本号', 'description' => 'File version number', 'type' => 'string', 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', 'visibility' => 'Public'], + 'error_code' => ['title' => '添加单文件时的错误码', 'description' => 'Error code for adding a single file', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'error_message' => ['title' => '添加单文件时的错误信息', 'description' => 'Error message for adding a single file', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'AppAccessStrategy' => [ - 'title' => '', + 'title' => 'App访问策略', 'description' => 'The information about the access policy of the application.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'effect' => [ - 'title' => '', + 'title' => 'App 访问策略', 'description' => 'The global access policy of the application. Valid values:'."\n" ."\n" .'* allow: The domain allows access from all applications.'."\n" @@ -467,1247 +174,332 @@ ."\n" .'1. Set effect to deny.'."\n" .'2. Specify except_app_id_list to allow specific applications to access the domain. Example: \\["appid1", "appid2"].'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'allow' => '', - 'deny' => '', - ], + 'enumValueTitles' => ['allow' => '允许', 'deny' => '拒绝'], 'example' => 'deny', ], 'except_app_id_list' => [ - 'title' => '', + 'title' => '白名单或黑名单AppID列表', 'description' => 'The IDs of applications excluded from the global access policy.'."\n" ."\n" .'* If you set effect to allow, which indicates that the domain allows access from all applications, the applications specified by this parameter value cannot access the domain.'."\n" .'* If you set effect to deny, which indicates that the domain denies access from all applications, the applications specified by this parameter value can access the domain.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the application.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '8ovxCTRUDdbpVWBP', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The ID of the application.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '8ovxCTRUDdbpVWBP', 'extendType' => 'true'], ], ], 'parseType' => 'struct', ], - 'BenefitPkgDeliveryInfo' => [ + 'BaseUserResponse' => [ 'title' => 'A short description of struct', - 'description' => 'Benefit package delivery information.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'amount' => [ - 'title' => '', - 'description' => 'Number of benefit packages delivered.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'is_permanent' => [ - 'title' => '', - 'description' => 'Whether it is permanently valid.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'expire_time' => [ - 'title' => '', - 'description' => 'The expiration time of the benefit package delivery.'."\n" - ."\n" - .'If is_permit is set to false, a valid value is returned.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', + 'domain_id' => ['title' => 'Domain ID', 'description' => 'The unique ID of the domain to which the user belongs.', 'type' => 'string', 'example' => 'hz999'], + 'user_id' => ['title' => '用户 ID', 'description' => 'The user\'s unique ID.', 'type' => 'string', 'example' => 'ccpuserid'], + 'avatar' => ['title' => '头像', 'description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'http://a.b.c/ccp.jpg'], + 'created_at' => ['title' => '用户创建时间', 'description' => 'The time the user account was created, formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1567407718386'], + 'updated_at' => ['title' => '用户修改时间', 'description' => 'The time the user account was last updated, formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1567407718386'], + 'email' => ['title' => '邮箱', 'description' => 'The user\'s primary email address.', 'type' => 'string', 'example' => '123@ccp.com'], + 'nick_name' => ['title' => '昵称', 'description' => 'The user\'s display name or nickname.', 'type' => 'string', 'example' => 'abc'], + 'phone' => ['title' => '电话', 'description' => 'The user\'s mobile phone number.', 'type' => 'string', 'example' => '13700000000'], + 'phone_region' => ['title' => '国家编码', 'description' => 'The country calling code for the user\'s mobile phone number. For example, `86` for China.', 'type' => 'string', 'example' => ''], + 'role' => ['title' => '角色', 'description' => 'The user\'s role. For example, `user` or `admin`.', 'type' => 'string', 'example' => 'user'], + 'status' => ['title' => '用户状态', 'description' => 'The status of the user account. Valid values: `enabled` and `disabled`.', 'type' => 'string', 'example' => 'enabled'], + 'user_name' => ['title' => '用户名称', 'description' => 'The user\'s name.', 'type' => 'string', 'example' => 'name'], + 'description' => ['title' => '用户备注信息', 'description' => 'The user\'s custom description.', 'type' => 'string', 'example' => 'ccp team user'], + 'default_drive_id' => ['title' => '默认 Drive ID', 'description' => 'The ID of the user\'s default drive.', 'type' => 'string', 'example' => '123'], + 'deny_change_password_by_self' => ['title' => '禁止用户自行修改密码', 'description' => 'Specifies if the user is prohibited from changing their own password. If `true`, the user cannot change their password.', 'type' => 'boolean', 'example' => ''], + 'need_change_password_next_login' => ['title' => '下次登录强制修改密码', 'description' => 'Specifies if the user must change their password at the next login. If `true`, a password change is required.', 'type' => 'boolean', 'example' => ''], + 'creator' => ['title' => 'creator', 'description' => 'The entity that created the user account. For example, `system`.', 'type' => 'string', 'example' => 'system'], + 'expired_at' => ['title' => '用户过期时间', 'description' => 'The time when the user account expires, specified as a UNIX timestamp in milliseconds. A value of `0` indicates the account never expires.', 'type' => 'integer', 'example' => '0', 'format' => 'int64'], + 'is_sync' => ['title' => 'is_sync', 'description' => 'Specifies if the user account is synchronized from an external source, such as Active Directory.', 'type' => 'boolean', 'example' => ''], + 'default_location' => ['title' => 'default_location', 'description' => 'The default storage location for the user\'s data.', 'type' => 'string', 'example' => ''], + 'last_login_time' => ['title' => 'last_login_time', 'description' => 'The time the user last logged in, specified as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'path_status' => ['title' => 'path 开启状态', 'description' => 'The status of the user\'s home directory. For example, `available`.', 'type' => 'string', 'example' => ''], + 'last_refresh_token_time' => ['description' => 'The time when the user\'s refresh token was last used, specified as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Custom data for the user, specified as a key-value pair.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'A map of custom key-value pairs for storing additional user data.', + 'example' => '', ], - 'created_at' => [ - 'title' => '', - 'description' => 'The creation time of the benefit package delivery.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IDPermission'], + 'description' => 'An array of permission strings for the corresponding key.', + 'example' => '', ], ], + 'description' => 'Contains details for a user.', + 'example' => '', + ], + 'BenefitPkgDeliveryInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'Benefit package delivery information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'amount' => ['title' => '权益包下发的数量', 'description' => 'Number of benefit packages delivered.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'is_permanent' => ['title' => '是否永久有效', 'description' => 'Whether it is permanently valid.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], + 'expire_time' => ['title' => '权益包下发的超期时间', 'description' => 'The expiration time of the benefit package delivery.'."\n" + ."\n" + .'If is_permit is set to false, a valid value is returned.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'created_at' => ['title' => '权益包下发的创建时间', 'description' => 'The creation time of the benefit package delivery.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + ], ], 'Domain' => [ 'title' => '', - 'description' => 'The information about the domain.'."\n", - 'visibility' => 'public', + 'description' => 'Basic domain information.', 'type' => 'object', 'properties' => [ - 'parent_domain_id' => [ - 'title' => '', - 'description' => 'The ID of the parent domain. If the parent domain exists, the current domain is a child domain. Otherwise, the current domain is a common domain.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'domain_id' => [ - 'title' => 'domain id', - 'description' => 'domain ID'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj2', - ], - 'domain_name' => [ - 'title' => '', - 'description' => 'The name of the domain.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'pdsdomain', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the domain.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'my domain', - ], - 'init_drive_enable' => [ - 'title' => '', - 'description' => 'Specifies whether to enable the default drive feature. Valid values: true and false. A value of true specifies that all users are assigned a drive by default on the first logon. Default value: false.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'init_drive_size' => [ - 'title' => '', - 'description' => 'The size of the default drive. Unit: bytes. This parameter is required if you set init_drive_enable to true. Default value: 0. A value of 0 indicates that the size of the default drive is 0 byte and you cannot upload files to the drive. To initialize the default drive, set init_drive_size to a positive number or -1. A value of -1 indicates that the size is unlimited.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the domain was last modified. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the domain was created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'size_quota' => [ - 'title' => '', - 'description' => 'The total storage quota for all drives in the domain. A value of 0 indicates that the quota is unlimited.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1099511627776', - ], - 'size_quota_used' => [ - 'title' => '', - 'description' => 'The used storage quota of all drives in the domain.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1099511627776', - ], - 'user_count_quota' => [ - 'title' => '', - 'description' => 'The maximum allowed number of users.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the domain. 1: The domain runs normally. 2: The domain is being created. 6: The domain has expired.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'used_size' => [ - 'title' => '', - 'description' => 'The usage of the logic space. Unit: bytes.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1099511627776', - ], - 'published_app_access_strategy' => [ - 'title' => '', - 'description' => 'The access policy of the application.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/AppAccessStrategy', - ], - 'watermark_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/WatermarkConfig', - ], - 'auth_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/AuthConfig', - ], - 'sharable' => [ - 'title' => '', - 'description' => 'Specifies whether to enable sharing.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - ], - 'ali_owner_id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'archive_files_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'required' => false, - '$ref' => '#/components/schemas/ArchiveFilesConfigResponse', - ], - 'uncompress_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/UncompressConfigResponse', - ], - 'multi_revision_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/ExternalMultiFileRevisionConfig', - ], - 'app_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/DomainAppConfig', - ], - 'recycle_bin_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/RecycleBinConfig', - ], - 'office_preview_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/OfficePreviewConfig', - ], - 'office_edit_config' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/OfficeEditConfig', - ], - 'share_link_detail' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/ShareLinkDetail', - ], - 'endpoints' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/DomainEndpoints', - ], - 'data_hash_name' => [ - 'title' => 'domain hash type', - 'description' => 'The method used to calculate the hash value of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sha1', - ], - ], + 'parent_domain_id' => ['title' => '', 'description' => 'The ID of the parent domain. If specified, the domain is a child domain. Otherwise, it is a standard domain.', 'type' => 'string', 'example' => 'bj1'], + 'domain_id' => ['title' => '', 'description' => 'The ID of the domain.', 'type' => 'string', 'example' => 'bj2'], + 'domain_name' => ['title' => '', 'description' => 'The name of the domain.', 'type' => 'string', 'example' => 'pdsdomain'], + 'description' => ['title' => '', 'description' => 'The description of the domain.', 'type' => 'string', 'example' => 'my domain'], + 'init_drive_enable' => ['title' => '', 'description' => 'Specifies whether to automatically create a default drive for each user when they first log on. The default value is false.', 'type' => 'boolean', 'example' => 'true'], + 'init_drive_size' => ['title' => '', 'description' => 'The size of the default drive in bytes. This parameter is required if `init_drive_enable` is set to `true`. The default value is `0`, which specifies that the drive is 0 bytes in size and files cannot be uploaded. To initialize the drive, set this parameter to a non-zero value. A value of -1 indicates an unlimited size.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'], + 'updated_at' => ['title' => '', 'description' => 'The time when the domain was last modified. The time is in the ISO 8601 format. Example: 2019-04-08T07:05:18.825Z.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'created_at' => ['title' => '', 'description' => 'The time when the domain was created. The time is in the ISO 8601 format. Example: 2019-03-28T13:03:29.298Z.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'size_quota' => ['title' => '', 'description' => 'The total quota of all drives in the domain. A value of 0 indicates that the quota is unlimited.', 'type' => 'integer', 'format' => 'int64', 'example' => '1099511627776'], + 'size_quota_used' => ['title' => '', 'description' => 'The used quota of all drives.', 'type' => 'integer', 'format' => 'int64', 'example' => '1099511627776'], + 'user_count_quota' => ['title' => '', 'description' => 'The quota of users.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'status' => ['title' => '', 'description' => 'The status of the domain. Valid values: 1: enabled. 2: being created. 6: expired.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'used_size' => ['title' => '', 'description' => 'The used logical space in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1099511627776'], + 'published_app_access_strategy' => ['title' => '', 'description' => 'The access policy of applications.', '$ref' => '#/components/schemas/AppAccessStrategy', 'example' => ''], + 'sharable' => ['title' => '', 'description' => 'Indicates whether sharing is enabled.', 'type' => 'boolean', 'example' => ''], + 'data_hash_name' => ['title' => '', 'description' => 'The name of the algorithm that is used to calculate the data hash value.', 'type' => 'string', 'example' => 'sha1'], + 'store_redundancy_type' => ['title' => '', 'description' => 'The storage redundancy type.', 'type' => 'string', 'example' => 'LRS'], + ], + 'example' => '', ], 'Drive' => [ 'title' => 'A short description of struct', 'description' => 'The information about the drive.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'title' => '', - 'description' => 'The drive ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', - ], - 'drive_name' => [ - 'title' => '', - 'description' => 'The drive name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'drv1', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vipdrive', - ], - 'owner' => [ - 'title' => '', - 'description' => 'The owner of the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'owner_type' => [ - 'title' => '', - 'description' => 'The type of the owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user', - ], - 'drive_type' => [ - 'title' => '', - 'description' => 'The type of the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'normal', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the driver.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'enabled', - ], - 'used_size' => [ - 'title' => '', - 'description' => 'The occupied storage space of the drive.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20480', - ], - 'total_size' => [ - 'title' => '', - 'description' => 'The total storage space of the drive.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204800', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the drive was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'creator' => [ - 'title' => '', - 'description' => 'The user who created the drive.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - ], + 'domain_id' => ['title' => '域id', 'description' => 'The domain ID.'."\n", 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['title' => '空间id', 'description' => 'The drive ID.'."\n", 'type' => 'string', 'example' => '1'], + 'drive_name' => ['title' => '空间名称', 'description' => 'The drive name.'."\n", 'type' => 'string', 'example' => 'drv1'], + 'description' => ['title' => '描述', 'description' => 'The description of the drive.'."\n", 'type' => 'string', 'example' => 'vipdrive'], + 'owner' => ['title' => '归属者', 'description' => 'The owner of the drive.'."\n", 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4'], + 'owner_type' => ['title' => '归属者类型', 'description' => 'The type of the owner.'."\n", 'type' => 'string', 'example' => 'user'], + 'drive_type' => ['title' => '空间类型', 'description' => 'The type of the drive.'."\n", 'type' => 'string', 'example' => 'normal'], + 'status' => ['title' => '状态', 'description' => 'The status of the driver.'."\n", 'type' => 'string', 'example' => 'enabled'], + 'used_size' => ['title' => '使用空间大小', 'description' => 'The occupied storage space of the drive.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20480'], + 'total_size' => ['title' => '总空间大小', 'description' => 'The total storage space of the drive.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '204800'], + 'created_at' => ['title' => '创建时间', 'description' => 'The time when the drive was created.'."\n", 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'creator' => ['title' => '创建者', 'description' => 'The user who created the drive.'."\n", 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4'], + ], + 'example' => '', ], 'FaceGroup' => [ - 'title' => '', - 'description' => 'The information about the face-based group.'."\n", - 'visibility' => 'public', + 'title' => '人脸分组', + 'description' => 'Face group', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'title' => '', - 'description' => 'The ID of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', - ], - 'group_name' => [ - 'title' => '', - 'description' => 'The name of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'name', - ], - 'image_count' => [ - 'title' => '', - 'description' => 'The number of photos in the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the face-based group was generated.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-01-14T10:10:52.83948013+08:00', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the face-based group was modified.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-01-14T10:10:52.83948013+08:00', - ], - 'group_cover_url' => [ - 'title' => '', - 'description' => 'The URL of the image used as the cover of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://xxx', - ], - 'group_cover_file_id' => [ - 'title' => '', - 'description' => 'The ID of the file used as the cover of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '6549c959640fbd517c9b4d93b3b36aecc45xxxxx', - ], - 'group_cover_width' => [ - 'title' => '', - 'description' => 'The width of the image used as the cover of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1920', - ], - 'group_cover_height' => [ - 'title' => '', - 'description' => 'The height of the image used as the cover of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1080', - ], + 'group_id' => ['title' => '人脸分组ID', 'description' => 'Face group ID', 'type' => 'string', 'example' => 'Cluster-ae6e3472-999e-410b-b54e-cd5dba****', 'visibility' => 'Public'], + 'group_name' => ['title' => '人脸分组名称', 'description' => 'Face group name', 'type' => 'string', 'example' => 'name', 'visibility' => 'Public'], + 'image_count' => ['title' => '照片数量', 'description' => 'Number of images in the face group', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public'], + 'created_at' => ['title' => '人脸分组生成时间。格式 RFC3339', 'description' => 'Time when the face group was created', 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00', 'visibility' => 'Public'], + 'updated_at' => ['title' => '人脸分组修改时间。格式 RFC3339', 'description' => 'Time when the face group was last updated', 'type' => 'string', 'example' => '2022-01-14T10:10:52.83948013+08:00', 'visibility' => 'Public'], + 'group_cover_url' => ['title' => '人脸分组封面头像地址', 'description' => 'URL of the face group thumbnail', 'type' => 'string', 'example' => 'https://xxx', 'visibility' => 'Public'], + 'group_cover_file_id' => ['title' => '人脸分组封面文件ID', 'description' => 'File ID of the face group thumbnail', 'type' => 'string', 'example' => '6549c959640fbd517c9b4d93b3b36aecc45xxxxx', 'visibility' => 'Public'], + 'group_cover_width' => ['title' => '人脸分组封面图片宽', 'description' => 'Width of the face group thumbnail, in pixels', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', 'visibility' => 'Public'], + 'group_cover_height' => ['title' => '人脸分组封面图片高', 'description' => 'Height of the face group thumbnail, in pixels', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'visibility' => 'Public'], 'group_cover_face_boundary' => [ - 'title' => '', - 'description' => 'The border of the image used as the cover the face-based group.'."\n", - 'visibility' => 'public', + 'title' => '人脸分组封面图片边框', + 'description' => 'Face boundary of the face group thumbnail', 'type' => 'object', 'properties' => [ - 'Width' => [ - 'title' => '', - 'description' => 'The width of the border. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Height' => [ - 'title' => '', - 'description' => 'The height of the border. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'Top' => [ - 'title' => '', - 'description' => 'The distance from the top of the photo to the border. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Left' => [ - 'title' => '', - 'description' => 'The distance from the left side of the photo to the border. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'remarks' => [ - 'title' => '', - 'description' => 'The remarks.'."\n", - 'visibility' => 'public', - 'type' => 'string', - ], - 'remarks_array' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'type' => 'string', - 'extendType' => 'true', + 'Width' => ['title' => '宽，单位像素', 'description' => 'Width, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'visibility' => 'Public'], + 'Height' => ['title' => '高， 单位像素', 'description' => 'Height, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'visibility' => 'Public'], + 'Top' => ['title' => '距离照片顶部的距离，单位像素', 'description' => 'Distance from the top edge of the image, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'visibility' => 'Public'], + 'Left' => ['title' => '距离照片左边框的距离，单位像素', 'description' => 'Distance from the left edge of the image, in pixels', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], + 'remarks' => ['title' => '备注', 'description' => 'Remarks', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'FaceThumbnail' => [ - 'title' => '', + 'title' => '人脸缩略图信息。仅开启增值服务图片处理功能有效。', 'description' => 'The information about the thumbnail of the face. This parameter is valid only if the value-added image processing feature is enabled.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'face_id' => [ - 'title' => '', - 'description' => 'The face ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'a9a66a86-73dd-4c95-8b79-1d8a49db5226', - ], - 'face_group_id' => [ - 'title' => '', - 'description' => 'The ID of the group to which the face belongs.'."\n" - ."\n" - .'The following specific IDs are included:'."\n" - ."\n" - .'* figure-cluster-id-independent: The face does not belong to a group. When you perform face clustering after an image is added to the dataset, this face may be grouped.'."\n" - .'* figure-cluster-id-unavailable: No clustering has been performed on this face. In other words, no face clustering is performed after an image is added to the dataset.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0', - ], - 'face_thumbnail' => [ - 'title' => '', - 'description' => 'The thumbnail of the face.'."\n", - 'visibility' => 'public', - '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', - 'sensitive' => true, - ], + 'face_id' => ['title' => '人脸 id。', 'description' => 'The face ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a9a66a86-73dd-4c95-8b79-1d8a49db5226'], + 'face_group_id' => ['title' => '人脸所属分组 id。', 'description' => 'The ID of the group to which the face belongs.'."\n" + ."\n" + .'The following specific IDs are included:'."\n" + ."\n" + .'* figure-cluster-id-independent: The face does not belong to a group. When you perform face clustering after an image is added to the dataset, this face may be grouped.'."\n" + .'* figure-cluster-id-unavailable: No clustering has been performed on this face. In other words, no face clustering is performed after an image is added to the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0'], + 'face_thumbnail' => ['title' => '人脸缩略图。', 'description' => 'The thumbnail of the face.'."\n", 'visibility' => 'Public', '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', 'sensitive' => true], ], ], 'File' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about the file.'."\n", - 'visibility' => 'public', + 'title' => 'file 详情', + 'description' => 'File', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'title' => '', - 'description' => 'The drive ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'title' => '', - 'description' => 'The file ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '5d79206586bb5dd69fb34c349282718146c55da7', - ], - 'name' => [ - 'title' => '', - 'description' => 'The file name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1.mov', - ], + 'domain_id' => ['title' => '域id', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['title' => '空间id', 'description' => 'The drive ID.', 'type' => 'string', 'example' => '1'], + 'file_id' => ['title' => '文件id', 'description' => 'The file ID.', 'type' => 'string', 'example' => '5d79206586bb5dd69fb34c349282718146c55da7'], + 'name' => ['title' => '名称', 'description' => 'The name.', 'type' => 'string', 'example' => '1.mov'], 'type' => [ - 'title' => '', - 'description' => 'The file type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* file'."\n" - .'* folder'."\n", - 'visibility' => 'public', + 'title' => '类型', + 'description' => 'The type.', + 'enumValueTitles' => ['file' => '文件', 'folder' => '文件夹'], 'type' => 'string', - 'enumValueTitles' => [ - 'file' => 'file', - 'folder' => 'folder', - ], 'example' => 'file', ], - 'content_type' => [ - 'title' => '', - 'description' => 'The type of the content.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'application/json', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the file was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the file was modified.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the file.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'image file', - ], - 'trashed_at' => [ - 'title' => '', - 'description' => 'The time when the file was put into the recycle bin.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'file_extension' => [ - 'title' => '', - 'description' => 'The file name extension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'txt', - ], - 'mime_type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'video/quicktime', - ], - 'mime_extension' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'mov', - ], - 'hidden' => [ - 'title' => '', - 'description' => 'Specifies whether to hide the file.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'size' => [ - 'title' => '', - 'description' => 'The file size'."\n" - ."\n" - .'or folder size. The folder size is calculated based on all descendant files and folders in the folder. Note: The folder size can be returned only when you call the ListFile or GetFile operation and include the dir_size field in the fields parameter.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'starred' => [ - 'title' => '', - 'description' => 'Specifies whether to add the file to favorites.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'content_type' => ['title' => '内容类型', 'description' => 'The content type.', 'type' => 'string', 'example' => 'application/json'], + 'created_at' => ['title' => '创建时间', 'description' => 'The time when the file was created.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'updated_at' => ['title' => '修改时间', 'description' => 'The time when the file was last modified.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'description' => ['title' => '描述', 'description' => 'The description.', 'type' => 'string', 'example' => 'image file'], + 'trashed_at' => ['title' => '放入回收站时间', 'description' => 'The time when the file was moved to the recycle bin.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'file_extension' => ['title' => '文件扩展', 'description' => 'The file name extension.', 'type' => 'string', 'example' => 'txt'], + 'hidden' => ['title' => '是否隐藏', 'description' => 'Indicates whether the file is hidden.', 'type' => 'boolean', 'example' => 'false'], + 'size' => ['title' => '大小', 'description' => 'If the object is a file, this parameter indicates the file size.'."\n" + ."\n" + .'If the object is a folder, this parameter indicates the total size of all files within it. The size is calculated recursively. Note: The folder size is returned only when you include dir\\_size in the fields parameter of a list file or get file request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'starred' => ['title' => '是否收藏', 'description' => 'Indicates whether the file is starred.', 'type' => 'boolean', 'example' => 'false'], 'status' => [ - 'title' => '', - 'description' => 'The status of the file. Only files and directories in the available state can be accessed. If you call the GetFile operation to obtain a file that is in the uploading state, a response indicating that the file does not exist is returned. If you call the ListFile operation to query files, files in the uploading state are not returned.'."\n", - 'visibility' => 'public', + 'title' => '状态', + 'description' => 'The status. Only files and folders in the available state can be accessed. If a file is in the uploading state, the GetFile operation returns a "file not found" error, and the ListFile operation does not return the file.', + 'enumValueTitles' => ['available' => 'available', 'uploading' => 'uploading'], 'type' => 'string', - 'enumValueTitles' => [ - 'available' => 'available', - 'uploading' => 'uploading', - ], 'example' => 'available', ], - 'user_meta' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'k1=v1,k2=v2', - ], 'labels' => [ - 'title' => '', - 'description' => 'The labels of the file.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'items' => [ - 'description' => 'The label.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["label1:1", "label2:2"]', - 'extendType' => 'true', - ], + 'title' => '标签', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'The label.'."\n", 'type' => 'string', 'example' => '["label1:1", "label2:2"]', 'title' => ''], 'example' => '["label1:1", "label2:2"]', ], - 'upload_id' => [ - 'title' => '', - 'description' => 'The upload ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6', - ], - 'parent_file_id' => [ - 'title' => '', - 'description' => 'The parent folder ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '3d5b846942cf94fa72324c8a4bda34e81da635a', - ], - 'crc64_hash' => [ - 'title' => 'crc64', - 'description' => 'crc64'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '3574582125365864471', - ], - 'content_hash' => [ - 'title' => '', - 'description' => 'The hash value of the content.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3', - ], + 'upload_id' => ['title' => '上传id', 'description' => 'The upload ID.', 'type' => 'string', 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6'], + 'parent_file_id' => ['title' => '父文件夹id', 'description' => 'The ID of the parent folder.', 'type' => 'string', 'example' => '3d5b846942cf94fa72324c8a4bda34e81da635a'], + 'crc64_hash' => ['title' => 'crc64', 'description' => 'The CRC-64 hash.', 'type' => 'string', 'example' => '3574582125365864471'], + 'content_hash' => ['title' => '内容hash', 'description' => 'The content hash.', 'type' => 'string', 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3'], 'content_hash_name' => [ - 'title' => '', - 'description' => 'The name of the hash algorithm. Set the value to sha1.'."\n", - 'visibility' => 'public', + 'title' => '内容hash算法名', + 'description' => 'The name of the content hash algorithm. Currently, only sha1 is supported.', + 'enumValueTitles' => ['sha1' => 'sha1'], 'type' => 'string', - 'enumValueTitles' => [ - 'sha1' => 'sha1', - ], 'example' => 'sha1', ], - 'download_url' => [ - 'title' => '', - 'description' => 'The download URL. The default validity period of the download URL is 15 minutes. If the URL expires, you can obtain the URL by calling the GetFile operation.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], - 'thumbnail' => [ - 'title' => '', - 'description' => 'The URL of the thumbnail. This parameter is deprecated and we recommend that you use thumbnail_urls.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], + 'download_url' => ['title' => '下载链接', 'description' => 'The download URL. The URL is valid for 15 minutes by default. If the URL expires, call the GetFile operation to obtain a new one.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'], + 'thumbnail' => ['title' => '缩略图地址', 'description' => 'The thumbnail URL. This parameter is deprecated. Use thumbnail\\_urls instead.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'], 'category' => [ - 'title' => '', - 'description' => 'The category. Drive and Photo Service (PDS) classifies files based on their extensions and mime-type. The supported categories include doc, image, audio, and video.'."\n", - 'visibility' => 'public', + 'title' => '分类', + 'description' => 'The category. The service categorizes files based on their file name extensions and MIME types. The main categories are doc, image, audio, and video.', + 'enumValueTitles' => ['image' => 'image', 'doc' => 'doc', 'audio' => 'audio', 'video' => 'video'], 'type' => 'string', - 'enumValueTitles' => [ - 'image' => 'image', - 'doc' => 'doc', - 'audio' => 'audio', - 'video' => 'video', - ], 'example' => 'image', ], - 'local_created_at' => [ - 'title' => '', - 'description' => 'The time when the local file was created. The time refers to the local time when the file was uploaded. This parameter helps identify the local upload time.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'local_modified_at' => [ - 'title' => '', - 'description' => 'The time when the local file was modified. The time refers to the local time when the modified file was uploaded. This parameter helps identify the local update time.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'revision_id' => [ - 'title' => '', - 'description' => 'The version ID. If a file that has the same file ID with an existing one is uploaded, a new version ID is generated for the file.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', - ], - 'investigation_info' => [ - 'title' => '', - 'description' => 'The review information.'."\n", - 'visibility' => 'public', - 'type' => 'object', - 'properties' => [ - 'status' => [ - 'title' => '', - 'description' => 'The status of the review.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is not performed'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 1'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is not supported'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 2'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review fails'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 3'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is in progress'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 4'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is complete'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* 5'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' Penalty methods are applied'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - '', - '', - '', - '', - ], - 'example' => '4', - ], - 'suggestion' => [ - 'title' => '', - 'description' => 'The recommended operation provided by the review.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* pass'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is passed.'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* block'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' The review is not passed. It is recommended to limit the use of the image'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'enumValueTitles' => [ - 'pass' => '', - 'block' => '', - ], - 'example' => 'pass', - ], - ], - ], + 'local_created_at' => ['title' => '文件本地创建时间', 'description' => 'The local creation time of the file. This is the local time on the client at the moment of upload, which helps the client identify the local upload time.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'local_modified_at' => ['title' => '文件本地修改时间', 'description' => 'The local modification time of the file. This is the local time on the client at the moment of upload, which helps the client identify the local update time.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z'], + 'revision_id' => ['title' => '版本id', 'description' => 'The revision ID. A new revision ID is generated when a file with the same file ID is overwritten.', 'type' => 'string', 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d'], 'thumbnail_urls' => [ - 'title' => '', - 'description' => 'The information about the returned thumbnail. The value corresponds to the key that is specified by thumbnail_processes.'."\n", - 'visibility' => 'public', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The information about the returned thumbnail. The value corresponds to the key that is specified by thumbnail_processes.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => '"128X128": "https://url1", "800X800": "url2"', - ], - ], - 'image_media_metadata' => [ - 'title' => '', - 'description' => 'The image metadata. This parameter takes effect only if the value-added image processing feature is enabled.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ImageMediaMetadata', - ], - 'ex_fields_info' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'any', - ], - ], - 'content_uri' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'streams_info' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', + 'title' => '返回的缩略图信息', + 'description' => 'The returned thumbnail information. The keys in this object correspond to the keys passed in the thumbnail\\_processes request parameter.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'public', - '$ref' => '#/components/schemas/SimpleStreamInfo', - ], + 'additionalProperties' => ['description' => 'The returned thumbnail information. The keys in this object correspond to the keys passed in the thumbnail\\_processes request parameter.', 'type' => 'string', 'required' => false, 'example' => '"128X128": "https://url1", "800X800": "url2"', 'title' => ''], + 'example' => '', ], + 'image_media_metadata' => ['title' => '图片信息。仅开启增值服务图片处理功能有效。', 'description' => 'The image information. This parameter is returned only if the image processing value-added service is enabled.', '$ref' => '#/components/schemas/ImageMediaMetadata', 'example' => ''], 'user_tags' => [ - 'title' => '', - 'description' => 'The custom tags.'."\n", - 'visibility' => 'public', + 'title' => '用户自定义标签', + 'description' => 'The custom tags.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The custom tag.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '"k1":"v1", "k2","v2"', - ], - ], - 'revision_version' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'video_media_metadata' => [ - 'title' => '', - 'description' => 'The audio and video information.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/VideoMediaMetadata', - ], - 'punish_flag' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'id_path' => [ - 'title' => '', - 'description' => 'The file ID path.'."\n", - 'visibility' => 'Private', - 'type' => 'string', - 'required' => false, - 'example' => 'id1/id2', - ], - 'name_path' => [ - 'title' => '', - 'description' => 'The file path.'."\n", - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'root/f1/f2', - ], - 'creator_type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'creator_id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'creator_name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'AB***CD', - ], - 'last_modifier_type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'last_modifier_id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'last_modifier_name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'AB***CD', + 'additionalProperties' => ['description' => 'The custom tag.', 'type' => 'string', 'example' => '"k1":"v1", "k2","v2"', 'title' => ''], + 'example' => '', ], + 'video_media_metadata' => ['title' => '音视频信息', 'description' => 'The audio and video information.', '$ref' => '#/components/schemas/VideoMediaMetadata', 'example' => ''], + 'id_path' => ['title' => '文件id路径', 'description' => 'The path of file IDs.', 'type' => 'string', 'required' => false, 'example' => 'id1/id2'], + 'name_path' => ['title' => '文件路径', 'description' => 'The file path.', 'type' => 'string', 'example' => 'root/f1/f2'], 'dir_size_info' => [ - 'title' => '', - 'description' => 'The information about the folder structure. This parameter is returned only if you include the dir_size field in the fields parameter by calling the ListFile or GetFile operation.'."\n", - 'visibility' => 'Private', + 'title' => '目录计量信息', + 'description' => 'The statistics information of the folder. This parameter is returned when you call the list file or get file operation and include dir\\_size in the fields parameter.', 'type' => 'object', 'properties' => [ - 'dir_count' => [ - 'title' => '', - 'description' => 'The number of all descendant folders in the folder, which is calculated recursively.'."\n", - 'visibility' => 'Private', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'file_count' => [ - 'title' => '', - 'description' => 'The number of all descendant files in the folder, which is calculated recursively.'."\n", - 'visibility' => 'Private', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'dir_count' => ['title' => '文件夹数量', 'description' => 'The total number of subfolders in the folder, calculated recursively.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'file_count' => ['title' => '文件数量', 'description' => 'The total number of files in the folder, calculated recursively.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], - ], - 'trashed' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', + 'example' => '', ], 'action_list' => [ - 'title' => '', - 'description' => 'The permissions.'."\n", - 'visibility' => 'Public', + 'title' => '权限列表', + 'description' => 'The list of permissions.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - 'description' => '', - ], - ], - 'location' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'semantic_result' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/SemanticResult', - ], - 'sync_flag' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - ], - 'sync_device_flag' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - ], - 'origin_parent_file_id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'url' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'custom_field_1' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'custom_field_2' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'auto_delete_left_sec' => [ - 'title' => '', - 'description' => 'The remaining time until the file is automatically deleted from the recycle bin (if in it).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], + 'auto_delete_left_sec' => ['title' => '回收站文件自动删除剩余时间', 'description' => 'The remaining time in seconds before the file is automatically deleted from the recycle bin.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], + 'example' => '', ], 'FilePermissionMember' => [ 'title' => 'A short description of struct', 'description' => 'The permission information.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'identity' => [ - 'title' => '', - 'description' => 'The identity to which the permissions are granted, which is a user or a group.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/Identity', - ], - 'role_id' => [ - 'title' => '', - 'description' => 'The role ID. You can grant permissions by assigning roles to identities, or you can customize the permissions. To grant permissions by assigning roles to identities, specify role_id. role_id and action_list are mutually exclusive. If both parameters are specified, the value of role_id prevails.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'SystemFileOwner: collaborator'."\n" - ."\n" - .'SystemFileDownloader: downloader'."\n" - ."\n" - .'SystemFileEditor: editor'."\n" - ."\n" - .'SystemFileEditorWithoutDelete: editor without permissions to delete the file'."\n" - ."\n" - .'SystemFileEditorWithoutShareLink: editor without permissions to share the file'."\n" - ."\n" - .'SystemFileMetaViewer: viewer of lists'."\n" - ."\n" - .'SystemFileUploader: uploader. SystemFileUploaderAndDownloader: uploader and downloader'."\n" - ."\n" - .'SystemFileDownloaderWithShareLink: downloader and sharer'."\n" - ."\n" - .'SystemFileUploaderAndDownloaderWithShareLink: uploader, downloader, and sharer'."\n" - ."\n" - .'SystemFileUploaderAndViewer: viewer and uploader'."\n" - ."\n" - .'SystemFileUploaderWithShareLink: uploader and sharer'."\n" - ."\n" - .'SystemFileViewer: viewer'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'SystemFileDownloader', - ], - 'expire_time' => [ - 'title' => '', - 'description' => 'The time when the permissions expire. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 4775500800000 indicates that the permissions never expire.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1633598085642', - ], - 'disinherit_sub_group' => [ - 'title' => '', - 'description' => 'Specifies whether the users of subgroups can inherit the permissions. For example, a user named user1 belongs to the group1 group, and a user named user2 belongs to the group2 group. group2 is the subgroup of group1. If you set disinherit_sub_group to true, only user1 is granted the permissions. user2 is not granted the permissions.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'identity' => ['title' => '授权对象', 'description' => 'The identity to which the permissions are granted, which is a user or a group.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/Identity'], + 'role_id' => ['title' => '授予的角色ID', 'description' => 'The role ID. You can grant permissions by assigning roles to identities, or you can customize the permissions. To grant permissions by assigning roles to identities, specify role_id. role_id and action_list are mutually exclusive. If both parameters are specified, the value of role_id prevails.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'SystemFileOwner: collaborator'."\n" + ."\n" + .'SystemFileDownloader: downloader'."\n" + ."\n" + .'SystemFileEditor: editor'."\n" + ."\n" + .'SystemFileEditorWithoutDelete: editor without permissions to delete the file'."\n" + ."\n" + .'SystemFileEditorWithoutShareLink: editor without permissions to share the file'."\n" + ."\n" + .'SystemFileMetaViewer: viewer of lists'."\n" + ."\n" + .'SystemFileUploader: uploader. SystemFileUploaderAndDownloader: uploader and downloader'."\n" + ."\n" + .'SystemFileDownloaderWithShareLink: downloader and sharer'."\n" + ."\n" + .'SystemFileUploaderAndDownloaderWithShareLink: uploader, downloader, and sharer'."\n" + ."\n" + .'SystemFileUploaderAndViewer: viewer and uploader'."\n" + ."\n" + .'SystemFileUploaderWithShareLink: uploader and sharer'."\n" + ."\n" + .'SystemFileViewer: viewer'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SystemFileDownloader'], + 'expire_time' => ['title' => '过期时间', 'description' => 'The time when the permissions expire. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 4775500800000 indicates that the permissions never expire.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1633598085642'], + 'disinherit_sub_group' => ['title' => '是否禁用子用户组继承此权限', 'description' => 'Specifies whether the users of subgroups can inherit the permissions. For example, a user named user1 belongs to the group1 group, and a user named user2 belongs to the group2 group. group2 is the subgroup of group1. If you set disinherit_sub_group to true, only user1 is granted the permissions. user2 is not granted the permissions.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], 'action_list' => [ - 'title' => '', + 'title' => '授予的操作权限列表', 'description' => 'The list of permissions to grant. You can grant permissions by assigning roles to identities, or you can customize the permissions. To grant permissions by assigning roles to identities, specify role_id. role_id and action_list are mutually exclusive. If both parameters are specified, the value of role_id prevails. When you specify action_list, the system automatically generates a temporary role_id. You can use this role_id to revoke the permissions.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The permission. Valid values:'."\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'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'FILE.CREATE', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The permission. Valid values:'."\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'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'FILE.CREATE', 'extendType' => 'true'], 'required' => false, ], ], @@ -1715,443 +507,166 @@ 'Group' => [ 'title' => 'A short description of struct', 'description' => 'The information about the group.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The ID of the domain.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'group_id' => [ - 'title' => '', - 'description' => 'The ID of the group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'b45c0c0c373c41ec9ebb5c85a025a08f', - ], - 'group_name' => [ - 'title' => '', - 'description' => 'The name of the group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test group', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'created by system', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the group was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'creator' => [ - 'title' => '', - 'description' => 'The ID of the user who created the group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'is_sync' => [ - 'title' => '是否为同步团队', - 'description' => '是否为同步团队', - 'visibility' => 'Private', - 'type' => 'boolean', - ], + 'domain_id' => ['title' => '域ID', 'description' => 'The ID of the domain.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'bj1'], + 'group_id' => ['title' => '用户组ID', 'description' => 'The ID of the group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'b45c0c0c373c41ec9ebb5c85a025a08f'], + 'group_name' => ['title' => '用户组名', 'description' => 'The name of the group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test group'], + 'description' => ['title' => '描述', 'description' => 'The description of the group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'created by system'], + 'created_at' => ['title' => '创建时间', 'description' => 'The time when the group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2019-08-20T06:51:27.292Z'], + 'updated_at' => ['title' => '更新时间', 'description' => 'The time when the group was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2019-08-20T06:51:27.292Z'], + 'creator' => ['title' => '创建者', 'description' => 'The ID of the user who created the group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4'], + 'is_sync' => ['title' => '是否为同步团队', 'description' => '是否为同步团队', 'visibility' => 'Private', 'type' => 'boolean'], ], ], 'Identity' => [ 'title' => 'A short description of struct', 'description' => 'The identity to which the permissions are granted, which is a user or a group.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'title' => '', - 'description' => 'The type of the identity. Valid values:'."\n" - ."\n" - .'* IT_User'."\n" - .'* IT_Group'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'IT_User', - ], - 'identity_id' => [ - 'title' => 'ID', - 'description' => 'The ID of the user or the group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '16435bdf934248b788b7b3771ee9a3dw', - ], + 'identity_type' => ['title' => '类型', 'description' => 'The type of the identity. Valid values:'."\n" + ."\n" + .'* IT_User'."\n" + .'* IT_Group'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'IT_User'], + 'identity_id' => ['title' => 'ID', 'description' => 'The ID of the user or the group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '16435bdf934248b788b7b3771ee9a3dw'], ], ], 'IdentityToBenefitPkgMapping' => [ 'title' => 'A short description of struct', - 'description' => 'The information about the benefit package that is associated with the entity.'."\n", - 'visibility' => 'public', + 'description' => 'The association between an entity and a benefit package.', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'title' => '', - 'description' => 'The type of the entity.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user', - ], - 'identity_id' => [ - 'title' => '', - 'description' => 'The ID of the entity.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user123', - ], - 'benefit_pkg_owner_id' => [ - 'title' => '', - 'description' => 'The ID of the owner of the benefit package.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'benefit_pkg_id' => [ - 'title' => '', - 'description' => 'The ID of the benefit package.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '40cb7794c9294', - ], - 'benefit_pkg_type' => [ - 'title' => '', - 'description' => 'The type of benefit package.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'user_identity : user identity benefit package'."\n" - ."\n" - .'user_resource: user resource benefit package'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user_identity', - ], - 'benefit_pkg_name' => [ - 'title' => '', - 'description' => 'The name of the benefit package.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - ], - 'benefit_pkg_priority' => [ - 'title' => '', - 'description' => 'Priority of the benefit package.'."\n" - ."\n" - .'The priority returned for the user identity benefit package. A smaller number indicates a higher priority.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'benefit_pkg_computation_rule' => [ - 'title' => '', - 'description' => 'Calculation rules of equity in the benefit package.'."\n" - ."\n" - .'The user identity benefit package. The return value is empty. Only the quota of the effective equity is calculated based on the priority.'."\n" - ."\n" - .'The user resource benefit package, which can return null or non-null values. If the return value is not empty, this benefit package is used to append the quota of existing benefits in other benefit packages, which is limited to quota-type benefits. For example, if a user identity benefit package already contains 10 GB of user storage capacity, you can define one or more user resource benefit packages to add additional storage capacity for some users.'."\n" - ."\n" - .'The following append calculation rules are supported:'."\n" - ."\n" - .'sum: Multiple benefit packages have the same equity and are accumulated.'."\n" - ."\n" - .'max: If multiple benefit packages have the same equity, the max value is used.'."\n" - ."\n" - .'min: If multiple benefit packages have the same equity, the value of min is used.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'sum', - ], + 'identity_type' => ['title' => '实体的类型', 'description' => 'The type of the entity.', 'type' => 'string', 'example' => 'user', 'visibility' => 'Public'], + 'identity_id' => ['title' => '实体的唯一标识', 'description' => 'The ID of the entity.', 'type' => 'string', 'example' => 'user123', 'visibility' => 'Public'], + 'benefit_pkg_owner_id' => ['title' => '权益包的所有者ID', 'description' => 'The ID of the benefit package owner.', 'type' => 'string', 'example' => 'bj1', 'visibility' => 'Public'], + 'benefit_pkg_id' => ['title' => '权益包的唯一标识', 'description' => 'The ID of the benefit package.', 'type' => 'string', 'example' => '40cb7794c9294', 'visibility' => 'Public'], + 'benefit_pkg_type' => ['title' => '权益包的类型', 'description' => 'The type of the benefit package.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'user\\_identity: A benefit package for user levels.'."\n" + ."\n" + .'user\\_resource: A benefit package for user resources.', 'type' => 'string', 'example' => 'user_identity', 'visibility' => 'Public'], + 'benefit_pkg_name' => ['title' => '权益包的名称', 'description' => 'The name of the benefit package.', 'type' => 'string', 'example' => '高级会员', 'visibility' => 'Public'], + 'benefit_pkg_priority' => ['title' => '权益包的优先级', 'description' => 'The priority of the benefit package.'."\n" + ."\n" + .'For a user-level benefit package, a smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public'], + 'benefit_pkg_computation_rule' => ['title' => '权益包内权益的计算规则', 'description' => 'The rule for calculating the benefits within the package.'."\n" + ."\n" + .'For a user-level benefit package, this parameter is empty. The effective benefit quota is calculated based only on the priority.'."\n" + ."\n" + .'For a user-resource benefit package, this parameter can be empty or have a value. If a value is returned, the package is used to append the quota of existing benefits in other packages. This applies only to quota-based benefits. For example, if a user-level benefit package includes 10 GB of user storage capacity, you can define one or more user-resource benefit packages to increase the storage capacity for specific users.'."\n" + ."\n" + .'Supported append rules include the following:'."\n" + ."\n" + .'sum: If multiple packages have the same benefit, their values are added together.'."\n" + ."\n" + .'max: If multiple packages have the same benefit, the maximum value is used.'."\n" + ."\n" + .'min: If multiple packages have the same benefit, the minimum value is used.', 'type' => 'string', 'example' => 'sum', 'visibility' => 'Public'], 'delivery_info_list' => [ - 'title' => '', - 'description' => 'The information about the benefit packages that are associated with an entity.'."\n", - 'visibility' => 'public', + 'title' => '权益包的下发信息', + 'description' => 'A list of delivery information for the benefit package.', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/BenefitPkgDeliveryInfo', - 'description' => '', - ], - ], - 'created_at' => [ - 'title' => '', - 'description' => 'Creation time of the entity and benefit package association.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'Update time associated with the entity and benefit package.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', + 'items' => ['$ref' => '#/components/schemas/BenefitPkgDeliveryInfo', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], + 'created_at' => ['title' => '实体权益包关联的创建时间', 'description' => 'The time when the entity was associated with the benefit package.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], + 'updated_at' => ['title' => '实体权益包关联的更新时间', 'description' => 'The time when the association between the entity and the benefit package was last updated.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'ImageMediaMetadata' => [ - 'title' => 'A short description of struct', + 'title' => '图片信息。仅开启增值服务图片处理功能有效。', 'description' => 'The image metadata. This parameter is valid only if the value-added image processing feature is enabled.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'time' => [ - 'title' => '', - 'description' => 'The time when the image was taken. The time follows the RFC3339 standard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2006-01-02T15:04:05.000Z07:00', - ], - 'width' => [ - 'title' => '', - 'description' => 'The width of the image. Unit: pixel.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'height' => [ - 'title' => '', - 'description' => 'The height of the image. Unit: pixel.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'location' => [ - 'title' => '', - 'description' => 'The location of the image.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '30.185453,120.218522', - ], + 'time' => ['title' => '拍摄时间，RFC3339 格式。', 'description' => 'The time when the image was taken. The time follows the RFC3339 standard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2006-01-02T15:04:05.000Z07:00'], + 'width' => ['title' => '图片宽度，单位为像素（px）。', 'description' => 'The width of the image. Unit: pixel.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'height' => ['title' => '图片高度，单位为像素（px）。', 'description' => 'The height of the image. Unit: pixel.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'location' => ['title' => 'GPS 经纬度信息。', 'description' => 'The location of the image.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '30.185453,120.218522'], 'country' => [ - 'title' => '', + 'title' => '国家或地区。', 'description' => 'The country or region in which the image was taken.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'China'."\n", ], - 'province' => [ - 'title' => '', - 'description' => 'The province in which the image was taken.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Zhejiang'."\n", - ], - 'city' => [ - 'title' => '', - 'description' => 'The city in which the image was taken.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Hangzhou'."\n", - ], - 'district' => [ - 'title' => '', - 'description' => 'The district in which the image was taken.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Binjiang District'."\n", - ], - 'township' => [ - 'title' => '', - 'description' => 'The street in which the image was taken.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Xixing Street'."\n", - ], - 'address_line' => [ - 'title' => '', - 'description' => 'The full address.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang'."\n", - ], + 'province' => ['title' => '省。', 'description' => 'The province in which the image was taken.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Zhejiang'."\n"], + 'city' => ['title' => '城市。', 'description' => 'The city in which the image was taken.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Hangzhou'."\n"], + 'district' => ['title' => '区。', 'description' => 'The district in which the image was taken.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Binjiang District'."\n"], + 'township' => ['title' => '街道。', 'description' => 'The street in which the image was taken.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Xixing Street'."\n"], + 'address_line' => ['title' => '完整地址。', 'description' => 'The full address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang'."\n"], 'image_tags' => [ - 'title' => '', + 'title' => '图片标签详情列表', 'description' => 'The details of the image tags.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The system tag.(this data structure will be closed in Feb. 20,2025)', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/SystemTag', - ], - ], - 'faces' => [ - 'title' => '', - 'description' => 'The human faces that are contained in the image.'."\n", - 'visibility' => 'private', - 'type' => 'string', - 'deprecated' => true, - 'example' => '[{"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}}}]', + 'items' => ['description' => 'The system tag.(this data structure will be closed in Feb. 20,2025)', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/SystemTag'], ], + 'faces' => ['title' => '图片中包含的人脸列表。', 'description' => 'The human faces that are contained in the image.'."\n", 'visibility' => 'Private', 'type' => 'string', 'deprecated' => true, 'example' => '[{"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}}}]'], 'faces_thumbnail' => [ - 'title' => '', + 'title' => '人脸缩略图列表。', 'description' => 'The thumbnails of the faces.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The thumbnail of the face.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FaceThumbnail', - ], - ], - 'exif' => [ - 'title' => '', - 'description' => 'The EXIF information about the image.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}', - ], - 'image_quality' => [ - 'title' => '', - 'description' => 'The rating of the image.'."\n", - 'visibility' => 'public', - '$ref' => '#/components/schemas/ImageQuality', + 'items' => ['description' => 'The thumbnail of the face.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/FaceThumbnail'], ], + 'exif' => ['title' => '图片EXIF信息。', 'description' => 'The EXIF information about the image.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"Compression":{"value":"6"},"DateTime":{"value":"2020:08:19 17:11:11"}}'], + 'image_quality' => ['title' => '图片评分信息。', 'description' => 'The rating of the image.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/ImageQuality'], ], ], 'ImageProcess' => [ 'title' => 'A short description of struct', 'description' => 'The image processing rule.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'image_thumbnail_process' => [ - 'title' => '', - 'description' => 'The thumbnail processing rules for images. For more information, see the "IMG implementation modes" topic of Object Storage Service (OSS). Default value: image/resize,m_fill,h\\_128,w\\_128,limit\\_0.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', - ], - 'video_thumbnail_process' => [ - 'title' => '', - 'description' => 'The thumbnail processing rules for videos. For more information, see the "Video snapshots" topic of OSS. Default value: video/snapshot,t\\_1000,f_jpg,w\\_0,h\\_0,m_fast,ar_auto.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', - ], - 'office_thumbnail_process' => [ - 'title' => '', - 'description' => 'The thumbnail processing rules for documents. For a document, the snapshot of one of the pages in the document is used as the thumbnail. This parameter takes effect on this snapshot. Default value: image/resize,m_fill,h\\_128,w\\_128,limit\\_0.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', - ], + 'image_thumbnail_process' => ['title' => '图片类型文件的缩略图规则', 'description' => 'The thumbnail processing rules for images. For more information, see the "IMG implementation modes" topic of Object Storage Service (OSS). Default value: image/resize,m_fill,h\\_128,w\\_128,limit\\_0.'."\n", 'type' => 'string', 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', 'visibility' => 'Public'], + 'video_thumbnail_process' => ['title' => '视频类型文件的缩略图规则', 'description' => 'The thumbnail processing rules for videos. For more information, see the "Video snapshots" topic of OSS. Default value: video/snapshot,t\\_1000,f_jpg,w\\_0,h\\_0,m_fast,ar_auto.'."\n", 'type' => 'string', 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', 'visibility' => 'Public'], + 'office_thumbnail_process' => ['title' => '文档类型文件的缩略图规则', 'description' => 'The thumbnail processing rules for documents. For a document, the snapshot of one of the pages in the document is used as the thumbnail. This parameter takes effect on this snapshot. Default value: image/resize,m_fill,h\\_128,w\\_128,limit\\_0.'."\n", 'type' => 'string', 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ImageQuality' => [ 'title' => '', 'description' => 'The details of the image quality. This parameter takes effect only if the value-added image processing feature is enabled.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'overall_score' => [ - 'title' => '', - 'description' => 'The overall quality score of the image. The image is automatically evaluated by AI. The evaluation is mainly based on subjective aesthetics and is affected by various factors, such as composition, brightness, contrast, color, and definition. Valid values: 0 to 1. The higher the score, the better the quality.'."\n", - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.736', - ], + 'overall_score' => ['title' => '', 'description' => 'The overall quality score of the image. The image is automatically evaluated by AI. The evaluation is mainly based on subjective aesthetics and is affected by various factors, such as composition, brightness, contrast, color, and definition. Valid values: 0 to 1. The higher the score, the better the quality.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.736', 'visibility' => 'Public'], ], + 'visibility' => 'Public', + 'example' => '', ], 'ImageTag' => [ - 'title' => '', + 'title' => '标签信息', 'description' => 'The information about the image tag.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The name of the tag.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - ], - 'count' => [ - 'title' => '', - 'description' => 'The number of files in the group.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'cover_url' => [ - 'title' => '', - 'description' => 'The URL of the cover image.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], - 'cover_file_id' => [ - 'title' => '', - 'description' => 'The ID of the cover file.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '5d79206586bb5dd69fb34c349282718146c55da7', - ], - 'cover_file_category' => [ - 'title' => '', - 'description' => 'The category of the cover image.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'image', - ], - 'cover_tag_confidence' => [ - 'title' => '', - 'description' => 'The confidence level of the cover image tag.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'cover_overall_score' => [ - 'title' => '', - 'description' => 'The score of the cover image.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.736', - ], + 'name' => ['title' => '名称', 'description' => 'The name of the tag.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '动物'], + 'count' => ['title' => '数量', 'description' => 'The number of files in the group.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'cover_url' => ['title' => '标签封面图片地址', 'description' => 'The URL of the cover image.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'], + 'cover_file_id' => ['title' => '封面文件id', 'description' => 'The ID of the cover file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '5d79206586bb5dd69fb34c349282718146c55da7'], + 'cover_file_category' => ['title' => '封面文件分类', 'description' => 'The category of the cover image.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'image'], + 'cover_tag_confidence' => ['title' => '封面标签置信度。取值范围为 0（表示置信度最低）~1（表示置信度最高）。', 'description' => 'The confidence level of the cover image tag.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'cover_overall_score' => ['title' => '封面评分。该评分为 AI 自动评估，主要以主观美学为准，受到构图、亮度、对比度、色彩、清晰度等多方面因素影响。 范围 0-1，越高则质量越好。', 'description' => 'The score of the cover image.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'float', 'example' => '0.736'], ], ], 'InvestigationInfo' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'status' => [ - 'title' => '', + 'title' => '审核状态', 'description' => 'The status of the review.'."\n" ."\n" .'Valid values:'."\n" @@ -2162,81 +677,82 @@ .'* 3: The review is in progress.'."\n" .'* 4: The review is complete.'."\n" .'* 5: Penalty methods are applied.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - '', - '', - '', - '', - ], + 'enumValueTitles' => ['未审核', '不支持审核', '审核失败', '审核中', '审核成功', '被处罚接口调用'], 'example' => '4', ], 'suggestion' => [ - 'title' => '', + 'title' => '审核建议执行的操作', 'description' => 'The recommended operation provided by the review.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* pass: The review is passed..'."\n" .'* block: The review is not passed. It is recommended to limit the use of the image.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'pass' => '', - 'block' => '', - ], + 'enumValueTitles' => ['pass' => '结果正常', 'block' => '结果违规，建议进行限制'], 'example' => 'block', ], 'video_detail' => [ - 'title' => '', + 'title' => '视频审核信息', 'description' => 'Video review information'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'block_frames' => [ - 'title' => '', + 'title' => '违规帧信息', 'description' => 'Violation frame information'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'rate' => [ - 'title' => '', - 'description' => 'The confidence level. Valid values: 0 to 100.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'double', - 'example' => '99.1', - ], - 'offset' => [ - 'title' => '', - 'description' => 'Time (in seconds)'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'label' => [ - 'title' => '', - 'description' => 'Category of review results'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'porn', - ], + 'rate' => ['title' => '置信度', 'description' => 'The confidence level. Valid values: 0 to 100.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '99.1'], + 'offset' => ['title' => '截帧距离片头的时间（秒）', 'description' => 'Time (in seconds)'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'label' => ['title' => '检测结果分类', 'description' => 'Category of review results'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'porn'], ], 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', + ], + 'KnowledgeFile' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'knowledge_base_id' => ['title' => '知识库 ID', 'description' => 'The ID of the knowledge base that contains the file.', 'type' => 'string', 'example' => ''], + 'knowledge_category_id' => ['title' => '知识分类 ID', 'description' => 'The ID of the knowledge base category assigned to the file.', 'type' => 'string', 'example' => ''], + 'drive_id' => ['title' => '云盘 ID', 'description' => 'The ID of the drive where the file is located.', 'type' => 'string', 'example' => ''], + 'file_id' => ['title' => '文件 ID', 'description' => 'The ID of the file.', 'type' => 'string', 'example' => ''], + 'revision_id' => ['title' => '文件版本 ID', 'description' => 'The ID of the file revision.', 'type' => 'string', 'example' => ''], + 'joined_at' => ['title' => '文件加入知识库/知识分类的毫秒级时间戳', 'description' => 'The time the file was added to the knowledge base, represented as a Unix timestamp in seconds.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'creator_id' => ['title' => '文件加入知识库/知识分类的操作者 ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_image_time' => ['title' => '图片文件的拍摄时间', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'file_created_at' => ['title' => '文件的毫秒级创建时间戳', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'file_updated_at' => ['title' => '文件的毫秒级更新时间戳', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'file_creator_id' => ['title' => '文件的创建者 ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_size' => ['title' => '文件大小', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'file_category' => ['title' => '文件类别', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_name' => ['title' => '文件名', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_name_path' => ['title' => '文件名路径', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_last_modifier_id' => ['title' => '文件最后的修改者 ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'file_last_modifier_type' => ['title' => '文件最后的修改者类型', 'type' => 'string', 'description' => '', 'example' => ''], + 'drive_name' => ['title' => '云盘名称', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => 'Contains information about a file in a knowledge base.', + 'example' => '', ], 'Permission' => [ 'title' => 'A short description of struct', @@ -2244,43 +760,13 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'collection' => [ - 'title' => '', - 'description' => 'The permission set. Set this parameter to global for global permissions. In other scenarios, this parameter is empty by default.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'global', - ], - 'resource_type' => [ - 'title' => '', - 'description' => 'The type of the resource. The file type resource is RT_File.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RT_File', - ], - 'resource' => [ - 'title' => '', - 'description' => 'The ID of the resource.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'fa212***', - ], - 'identity_type' => [ - 'title' => '', - 'description' => 'Identity type. Valid values: IT_User, IT_Group, IT_Role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'IT_User', - ], - 'identity_id' => [ - 'title' => '', - 'description' => 'Identity ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'af22***', - ], + 'collection' => ['title' => '权限集', 'description' => 'The permission set. Set this parameter to global for global permissions. In other scenarios, this parameter is empty by default.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'global'], + 'resource_type' => ['title' => '资源类型', 'description' => 'The type of the resource. The file type resource is RT_File.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RT_File'], + 'resource' => ['title' => '资源', 'description' => 'The ID of the resource.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'fa212***'], + 'identity_type' => ['title' => '授予对象类型', 'description' => 'Identity type. Valid values: IT_User, IT_Group, IT_Role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'IT_User'], + 'identity_id' => ['title' => '授予对象ID', 'description' => 'Identity ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'af22***'], 'action_list' => [ - 'title' => '', + 'title' => '操作列表', 'description' => 'Action list.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -2288,933 +774,323 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'action' => [ - 'title' => '', - 'description' => 'Specific action, such as FILE.ALL'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'FILE.ALL', - ], + 'action' => ['title' => '操作', 'description' => 'Specific action, such as FILE.ALL'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'FILE.ALL'], ], 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'effect' => [ - 'title' => '', - 'description' => 'Effect. Valid values: allow, deny.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deny', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The creation time in the millisecond timestamp format.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1703648502811', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the modification was made. The value is a millisecond timestamp.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1703648502811', - ], - 'condition' => [ - 'title' => '', - 'description' => 'Condition'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/PermissionCondition', - ], + 'effect' => ['title' => '作用', 'description' => 'Effect. Valid values: allow, deny.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'deny'], + 'created_at' => ['title' => '创建时间', 'description' => 'The creation time in the millisecond timestamp format.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1703648502811'], + 'updated_at' => ['title' => '修改时间', 'description' => 'The time when the modification was made. The value is a millisecond timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1703648502811'], + 'condition' => ['title' => '条件', 'description' => 'Condition'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/PermissionCondition', 'example' => ''], 'user_tags' => [ - 'title' => '', + 'title' => '自定义标签', 'description' => 'Custom tag.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Custom tag string.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Custom tag string.'."\n", 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'example' => 'user1', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], 'PermissionCondition' => [ 'title' => 'permission condition', 'description' => 'Condition'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'ip_equals' => [ - 'title' => '', + 'title' => 'ip在里面', 'description' => 'The IP address condition, which is true when the IP address is equal to one of the following lists.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'client_ip' => [ 'title' => 'ip', 'description' => 'The IP address of the client.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Specific IP address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '192.168.1.1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Specific IP address.'."\n", 'type' => 'string', 'example' => '192.168.1.1', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'ip_not_equals' => [ - 'title' => '', + 'title' => 'ip不在里面', 'description' => 'The IP address condition. This condition is true when the IP address is not equal to any of the following list.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'client_ip' => [ 'title' => 'ip', 'description' => 'The IP address of the client.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Specific IP address.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '192.168.1.1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Specific IP address.'."\n", 'type' => 'string', 'example' => '192.168.1.1', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'string_like' => [ - 'title' => '', + 'title' => 'vpc_id在里面', 'description' => 'The string match condition, which is true when the string is equal to one of the following lists.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'vpc_id' => [ 'title' => 'vpc_id', 'description' => 'The vpcID of the client as a string match condition.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Specific VpcID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-xxx', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Specific VpcID.'."\n", 'type' => 'string', 'example' => 'vpc-xxx', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'string_not_like' => [ - 'title' => '', + 'title' => 'vpc_id不在里面', 'description' => 'The string match condition. This condition is true when the input string is not equal to any one of the following lists.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'vpc_id' => [ 'title' => 'vpi_id', 'description' => 'The vpcID of the client as a string match condition.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Specific VpcID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-xxx', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Specific VpcID.'."\n", 'type' => 'string', 'example' => 'vpc-xxx', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'Revision' => [ 'title' => 'A short description of struct', - 'description' => 'The information about the version.'."\n", - 'visibility' => 'public', + 'description' => 'Revision', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'title' => '', - 'description' => 'The drive ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'title' => '', - 'description' => 'The file ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '9520943DC264', - ], - 'revision_id' => [ - 'title' => '', - 'description' => 'The version ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '40CB7794C929', - ], - 'revision_name' => [ - 'title' => '', - 'description' => 'The version name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1.mov', - ], - 'revision_version' => [ - 'title' => '', - 'description' => 'The version number.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'size' => [ - 'title' => '', - 'description' => 'The version size.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'file_extension' => [ - 'title' => '', - 'description' => 'The file extension.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'mov', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the version was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the version was modified.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'keep_forever' => [ - 'title' => '', - 'description' => 'Indicates whether the version is permanently retained.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'revision_description' => [ - 'title' => '', - 'description' => 'The description of the version.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'aaa', - ], - 'is_latest_version' => [ - 'title' => '', - 'description' => 'Indicates whether it is the latest version.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'crc64_hash' => [ - 'title' => 'crc64', - 'description' => 'The CRC64 value of the version.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '3574582125365864471', - ], - 'content_hash' => [ - 'title' => '', - 'description' => 'The hash value of the content.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3', - ], - 'content_hash_name' => [ - 'title' => '', - 'description' => 'The name of the hash algorithm.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'sha1', - ], - 'thumbnail' => [ - 'title' => '', - 'description' => 'The URL of the thumbnail.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", - ], - 'url' => [ - 'title' => '', - 'description' => 'The preview URL.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", - ], - 'download_url' => [ - 'title' => '', - 'description' => 'The download URL. The ListRevision operation does not return this value. The GetRevision, UpdateRevision, and RestoreRevision operations return this value.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", - ], - 'creator_type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - 'creator_id' => [ - 'title' => '', - 'description' => 'The ID of the user who created the version.'."\n", - 'visibility' => 'cn', - 'type' => 'string', - ], - 'creator_name' => [ - 'title' => '', - 'description' => 'The name of the user who created the version.'."\n", - 'visibility' => 'cn', - 'type' => 'string', - ], - ], + 'domain_id' => ['title' => '域id', 'description' => 'Domain ID', 'type' => 'string', 'example' => 'bj1', 'visibility' => 'Public'], + 'drive_id' => ['title' => '空间id', 'description' => 'Drive ID', 'type' => 'string', 'example' => '1', 'visibility' => 'Public'], + 'file_id' => ['title' => '文件id', 'description' => 'File ID', 'type' => 'string', 'example' => '9520943DC264', 'visibility' => 'Public'], + 'revision_id' => ['title' => '版本id', 'description' => 'Revision ID', 'type' => 'string', 'example' => '40CB7794C929', 'visibility' => 'Public'], + 'revision_name' => ['title' => '版本名', 'description' => 'Revision name', 'type' => 'string', 'example' => '1.mov', 'visibility' => 'Public'], + 'revision_version' => ['title' => '版本号', 'description' => 'Version number', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public'], + 'size' => ['title' => '版本大小', 'description' => 'Revision size', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'visibility' => 'Public'], + 'file_extension' => ['title' => '扩展名', 'description' => 'File extension', 'type' => 'string', 'example' => 'mov', 'visibility' => 'Public'], + 'created_at' => ['title' => '创建时间', 'description' => 'Creation time', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], + 'updated_at' => ['title' => '修改时间', 'description' => 'Modification time', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], + 'keep_forever' => ['title' => '是否永久保留', 'description' => 'Whether to retain permanently', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'revision_description' => ['title' => '版本描述', 'description' => 'Revision description', 'type' => 'string', 'example' => 'aaa', 'visibility' => 'Public'], + 'is_latest_version' => ['title' => '是否为最新版本', 'description' => 'Whether this is the latest version', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'visibility' => 'Public'], + 'crc64_hash' => ['title' => 'crc64', 'description' => 'CRC64', 'type' => 'string', 'example' => '3574582125365864471', 'visibility' => 'Public'], + 'content_hash' => ['title' => '内容hash', 'description' => 'Content hash', 'type' => 'string', 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA3', 'visibility' => 'Public'], + 'content_hash_name' => ['title' => '内容hash算法名', 'description' => 'Content hash algorithm name', 'type' => 'string', 'example' => 'sha1', 'visibility' => 'Public'], + 'thumbnail' => ['title' => '缩略图地址', 'description' => 'Thumbnail URL', 'type' => 'string', 'required' => false, 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'visibility' => 'Public'], + 'url' => ['title' => '预览地址', 'description' => 'Preview URL', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'visibility' => 'Public'], + 'download_url' => ['title' => '下载地址', 'description' => 'Download URL. This field is not returned by ListRevision, but is returned by GetRevision, UpdateRevision, and RestoreRevision.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'."\n", 'visibility' => 'Public'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'Role' => [ - 'title' => '', + 'title' => '角色', 'description' => 'The role.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'role_id' => [ - 'title' => '', - 'description' => 'The ID of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'f2a***', - ], - 'name' => [ - 'title' => '', - 'description' => 'The name of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - ], - 'manage_resource_type' => [ - 'title' => '', - 'description' => 'The type of the resource on which the role has permissions. Valid value: RT_File.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RT_File', - ], - 'creator' => [ - 'title' => '', - 'description' => 'The ID of the user who created the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a23***', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the role was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1703648502811', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the role was modified. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1703648502811', - ], + 'role_id' => ['title' => '角色ID', 'description' => 'The ID of the role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'f2a***'], + 'name' => ['title' => '角色名', 'description' => 'The name of the role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '文件预览者'], + 'description' => ['title' => '角色描述', 'description' => 'The description of the role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '拥有预览文件权限'], + 'manage_resource_type' => ['title' => '管理的资源类型', 'description' => 'The type of the resource on which the role has permissions. Valid value: RT_File.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RT_File'], + 'creator' => ['title' => '创建者', 'description' => 'The ID of the user who created the role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a23***'], + 'created_at' => ['title' => '创建时间', 'description' => 'The time when the role was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1703648502811'], + 'updated_at' => ['title' => '上次更新时间', 'description' => 'The time when the role was modified. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1703648502811'], 'permissions' => [ - 'title' => '', + 'title' => '权限列表', 'description' => 'The permissions.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The permission.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Permission', - ], - ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'enabled', + 'items' => ['description' => 'The permission.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Permission'], ], + 'status' => ['title' => '状态', 'description' => 'The status of the role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'enabled'], ], 'parseType' => 'struct', ], 'ShareLink' => [ - 'title' => '', - 'description' => 'The information about a share.'."\n", - 'visibility' => 'public', + 'title' => '分享', + 'description' => 'Share', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'title' => '', - 'description' => 'The share ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '7JQX1FswpQ8', - ], - 'share_pwd' => [ - 'title' => '', - 'description' => 'The access code. An access code can be up to 64 characters in length. If you do not specify a value, files can be accessed without an access code.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'abcF123x', - ], - 'drive_id' => [ - 'title' => '', - 'description' => 'The drive ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', - ], + 'share_id' => ['title' => '分享id', 'description' => 'Share ID', 'type' => 'string', 'example' => '7JQX1FswpQ8', 'visibility' => 'Public'], + 'share_pwd' => ['title' => '分享密码', 'description' => 'Fetch code, 0–64 characters. A length of 0 means no fetch code.', 'type' => 'string', 'example' => 'abcF123x', 'visibility' => 'Public'], + 'drive_id' => ['title' => '空间id', 'description' => 'Drive ID', 'type' => 'string', 'example' => '1', 'visibility' => 'Public'], 'file_id_list' => [ - 'title' => '', - 'description' => 'The IDs of the files to share in the parent path.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'items' => [ - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["xx"]', - 'extendType' => 'true', - 'description' => '', - ], + 'title' => '分享父路径文件id列表', + 'description' => 'List of file IDs for the shared parent path', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => '["xx"]', 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', + 'visibility' => 'Public', ], - 'expiration' => [ - 'title' => '', - 'description' => 'The time when the share URL expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If you set the value to "", the share URL never expires.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2020-06-28T11:33:00.000+08:00', - ], - 'expired' => [ - 'title' => '', - 'description' => 'Specifies whether the share is expired.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the share was created.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the share was last modified.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the share.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'videos', - ], - 'share_name' => [ - 'title' => '', - 'description' => 'The name of the share. By default, the file name that corresponds to the first ID in the file ID list is used.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'video-1.MP4', - ], - 'creator' => [ - 'title' => '', - 'description' => 'The user who created the share.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], + 'expiration' => ['title' => '到期时间', 'description' => 'Expiration time point.RFC3339 format, such as: "2020-06-28T11:33:00.000+08:00".Permanent validity: ""', 'type' => 'string', 'example' => '2020-06-28T11:33:00.000+08:00', 'visibility' => 'Public'], + 'expired' => ['title' => '是否过期', 'description' => 'Is expired', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'created_at' => ['title' => '创建时间', 'description' => 'Creation time', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], + 'updated_at' => ['title' => '修改时间', 'description' => 'Modification time', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'visibility' => 'Public'], + 'description' => ['title' => '描述', 'description' => 'Description', 'type' => 'string', 'example' => 'videos', 'visibility' => 'Public'], + 'share_name' => ['title' => '分享名称', 'description' => 'Share name. Defaults to the first file name.', 'type' => 'string', 'example' => 'video-1.MP4', 'visibility' => 'Public'], + 'creator' => ['title' => '创建者', 'description' => 'Creator', 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'visibility' => 'Public'], 'status' => [ - 'title' => '', - 'description' => 'The status of the share. Valid values:'."\n" + 'title' => '状态', + 'description' => 'Status.Enumeration values:'."\n" + ."\n" + .'- disabled (canceled)'."\n" ."\n" - .'* disabled: The share is canceled.'."\n" - .'* enabled: The share is effective.'."\n", - 'visibility' => 'public', + .'- enabled (active)', + 'enumValueTitles' => ['disabled' => '已取消', 'enabled' => '有效'], 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], 'example' => 'enabled', + 'visibility' => 'Public', ], - 'preview_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared files are previewed.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'save_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared files are saved.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'download_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared files are downloaded.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'report_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared files are reported.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'video_preview_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared audio and video files are played.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'access_count' => [ - 'title' => '', - 'description' => 'The number of times that the shared files are visited.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'disable_preview' => [ - 'title' => '', - 'description' => 'Specifies whether to disable the preview feature.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'disable_save' => [ - 'title' => '', - 'description' => 'Specifies whether to disable the save feature.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'disable_download' => [ - 'title' => '', - 'description' => 'Specifies whether to disable the download feature.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'preview_limit' => [ - 'title' => '', - 'description' => 'The limit on the number of times that the shared files can be previewed.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'save_limit' => [ - 'title' => '', - 'description' => 'The limit on the number of times that the shared files can be saved.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'download_limit' => [ - 'title' => '', - 'description' => 'The limit on the number of times that the shared files can be downloaded.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'require_login' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - 'example' => 'false', - ], - 'share_all_files' => [ - 'title' => '', - 'description' => 'Specifies whether to share all files in the drive.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'share_msg' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - ], - ], + 'preview_count' => ['title' => '预览次数', 'description' => 'Preview count', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public'], + 'save_count' => ['title' => '转存次数', 'description' => 'Save count', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'visibility' => 'Public'], + 'download_count' => ['title' => '下载次数', 'description' => 'Download count', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'visibility' => 'Public'], + 'report_count' => ['title' => '被举报次数', 'description' => 'Report count', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public'], + 'video_preview_count' => ['title' => '音视频播放次数', 'description' => 'Audio and video playback count', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public'], + 'access_count' => ['title' => '访问次数', 'description' => 'Access count', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public'], + 'disable_preview' => ['title' => '禁止预览分享中的文件', 'description' => 'Disable preview of files in the share', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'disable_save' => ['title' => '禁止转存分享中的文件', 'description' => 'Disable saving files from the share', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'disable_download' => ['title' => '禁止下载分享中的文件', 'description' => 'Disable downloading files from the share', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'preview_limit' => ['title' => '分享预览次数限制', 'description' => 'Preview count limit for the share', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public'], + 'save_limit' => ['title' => '分享转存次数限制', 'description' => 'Save count limit for the share', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public'], + 'download_limit' => ['title' => '分享下载次数限制', 'description' => 'Download count limit for the share', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public'], + 'share_all_files' => ['title' => '是否分享整个drive中的文件', 'description' => 'Share all files in the drive', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], + 'save_download_limit' => ['title' => '分享转存和下载次数总和限制', 'description' => 'Total limit for save and download counts combined', 'type' => 'integer', 'example' => '100', 'format' => 'int64', 'visibility' => 'Public'], + 'office_editable' => ['title' => '是否允许在线编辑分享的文档', 'description' => 'Allow online editing of shared documents', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], + ], + 'example' => '', + 'visibility' => 'Public', ], 'Story' => [ 'title' => 'A short description of struct', 'description' => 'The information about the story.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'story_id' => [ - 'title' => '', - 'description' => 'The story ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'story_type' => [ - 'title' => '', - 'description' => 'The type of the story. It is specified when the story is created.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PeopleMemory', - ], - 'story_sub_type' => [ - 'title' => '', - 'description' => 'The subtype of the story. It is specified when the story is created.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Solo', - ], - 'story_name' => [ - 'title' => '', - 'description' => 'The name of the story.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_name', - ], - 'story_start_time' => [ - 'title' => '', - 'description' => 'The time when the story starts. The time follows the RFC3339 standard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2021-01-14T10:17:18.102700407+08:00', - ], - 'story_end_time' => [ - 'title' => '', - 'description' => 'The time when the story ends. The time follows the RFC3339 standard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-01-14T10:17:18.102700407+08:00', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the story was created. The time follows the RFC3339 standard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-01-14T10:17:18.102700407+08:00', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the story was updated. The time follows the RFC3339 standard.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2022-01-14T10:17:18.102700407+08:00', - ], + 'story_id' => ['title' => '故事 id', 'description' => 'The story ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003'], + 'story_type' => ['title' => '故事类型', 'description' => 'The type of the story. It is specified when the story is created.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'PeopleMemory'], + 'story_sub_type' => ['title' => '故事子类型', 'description' => 'The subtype of the story. It is specified when the story is created.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Solo'], + 'story_name' => ['title' => '故事名称', 'description' => 'The name of the story.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_name'], + 'story_start_time' => ['title' => '故事开始时间', 'description' => 'The time when the story starts. The time follows the RFC3339 standard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-01-14T10:17:18.102700407+08:00'], + 'story_end_time' => ['title' => '故事结束时间', 'description' => 'The time when the story ends. The time follows the RFC3339 standard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'created_at' => ['title' => '故事创建时间', 'description' => 'The time when the story was created. The time follows the RFC3339 standard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], + 'updated_at' => ['title' => '故事更新时间', 'description' => 'The time when the story was updated. The time follows the RFC3339 standard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-01-14T10:17:18.102700407+08:00'], 'face_group_ids' => [ - 'title' => '', + 'title' => '人脸分组列表', 'description' => 'The information about face-based groups. This parameter is valid only if story_type is set to PeopleMemory. This parameter is invalid for stories of other types or custom stories.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the face-based group.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', - 'extendType' => 'true', - ], - ], - 'cover_file_id' => [ - 'title' => '', - 'description' => 'The ID of the story cover file.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'cover_file_thumbnail_url' => [ - 'title' => '', - 'description' => 'The URL of thumbnail of the story cover file.'."\n", - 'visibility' => 'public', - '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', + 'items' => ['description' => 'The ID of the face-based group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', 'extendType' => 'true'], ], + 'cover_file_id' => ['title' => '故事封面文件 id', 'description' => 'The ID of the story cover file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf'], + 'cover_file_thumbnail_url' => ['title' => '故事封面文件缩略图', 'description' => 'The URL of thumbnail of the story cover file.'."\n", 'visibility' => 'Public', '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' => '', + 'title' => '故事文件列表', 'description' => 'The story files.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the file.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/File', - ], - ], - 'custom_id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'test', + 'items' => ['description' => 'The information about the file.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/File'], ], + 'custom_id' => ['title' => '自定义 id', 'description' => '自定义 id。'."\n" + .'由用户根据自身业务标识。', 'visibility' => 'Private', 'type' => 'string', 'example' => 'test'], 'custom_labels' => [ - 'title' => '', + 'title' => '自定义标签', 'description' => 'The custom tags. You can specify key-value pairs based on your business requirements to search for stories by calling the FindStories operation.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The custom tag.'."\n", - 'visibility' => 'public', - 'type' => 'any', - 'example' => '{'."\n" - .' "key": "value"'."\n" - .'}', - ], + 'additionalProperties' => ['description' => 'The custom tag.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '{'."\n" + .' "key": "value"'."\n" + .'}'], ], ], ], 'SystemTag' => [ - 'title' => '', + 'title' => '标签详细信息。仅开启增值服务图片处理功能有效。', 'description' => 'The system AI processing tag. This parameter is valid only if the value-added image processing feature is enabled.(this data structure will be closed in Feb. 20,2025)', - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'confidence' => [ - 'title' => '', - 'description' => 'The confidence level of the tag. Valid values: 0 to 1. A value of 0 specifies the lowest confidence level. A value of 1 specifies the highest confidence level.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.98', - ], - 'parent_name' => [ - 'title' => '', - 'description' => 'The name of the parent tag of the tag.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'sport', - ], - 'name' => [ - 'title' => '', - 'description' => 'The name of the tag.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'basketball', - ], - 'tag_level' => [ - 'title' => '', - 'description' => 'The level of the tag. The value must be greater than or equal to 1.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'source' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'play basketball', - ], - 'centric_score' => [ - 'title' => '', - 'description' => 'The center value of the tag, which specifies whether the tag is the subject in the image. Valid values: 0 to 1. A value of 0 specifies the lowest proportion. A value of 1 specifies the highest proportion.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.877', - ], + 'confidence' => ['title' => '标签置信度，取值范围为 0（表示置信度最低）~1（表示置信度最高）。', 'description' => 'The confidence level of the tag. Valid values: 0 to 1. A value of 0 specifies the lowest confidence level. A value of 1 specifies the highest confidence level.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'float', 'example' => '0.98'], + 'parent_name' => ['title' => '标签父标签。', 'description' => 'The name of the parent tag of the tag.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sport'], + 'name' => ['title' => '标签名。', 'description' => 'The name of the tag.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'basketball'], + 'tag_level' => ['title' => '标签层级，取之范围大于等于 1。', 'description' => 'The level of the tag. The value must be greater than or equal to 1.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'source' => ['title' => '解析出标签的来源关键词', 'description' => '解析出标签的来源关键词。', 'visibility' => 'Private', 'type' => 'string', 'example' => 'play basketball'], + 'centric_score' => ['title' => '标签的中心值分数，指该标签在图片中是否为主体，取值范围为 0~1。', 'description' => 'The center value of the tag, which specifies whether the tag is the subject in the image. Valid values: 0 to 1. A value of 0 specifies the lowest proportion. A value of 1 specifies the highest proportion.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'float', 'example' => '0.877'], ], ], 'Token' => [ 'title' => 'A short description of struct', - 'description' => 'The object that is returned after the authentication is complete, including the access token, refresh token, and basic information about the user.'."\n", - 'visibility' => 'public', + 'description' => 'The object returned after successful authentication, which includes access\\_token, refresh\\_token, and basic user information.', 'type' => 'object', 'properties' => [ - 'access_token' => [ - 'title' => '', - 'description' => 'The access token.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs', - 'backendName' => 'access_token', - ], - 'refresh_token' => [ - 'title' => '', - 'description' => 'The refresh token.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '060e78d36afb4879b51e4264e9541c16', - 'backendName' => 'refresh_token', - ], - 'expires_in' => [ - 'title' => '', - 'description' => 'The validity period of the token.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - 'backendName' => 'expires_in', - ], + 'access_token' => ['title' => '访问凭证', 'description' => 'Access credential', 'type' => 'string', 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs', 'visibility' => 'Public', 'backendName' => 'access_token'], + 'refresh_token' => ['title' => '刷新凭证', 'description' => 'Refresh token', 'type' => 'string', 'example' => '060e78d36afb4879b51e4264e9541c16', 'visibility' => 'Public', 'backendName' => 'refresh_token'], + 'expires_in' => ['title' => '凭证有效期', 'description' => 'Credential validity period', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'visibility' => 'Public', 'backendName' => 'expires_in'], 'token_type' => [ - 'title' => '', - 'description' => 'The type of the token.'."\n" - ."\n" - .'* Only Bearer is supported.'."\n", - 'visibility' => 'public', + 'title' => '凭证类型', + 'description' => 'Credential type', + 'enumValueTitles' => ['Bearer' => 'Bearer'], 'type' => 'string', - 'enumValueTitles' => [ - 'Bearer' => 'Bearer', - ], 'example' => 'Bearer', + 'visibility' => 'Public', 'backendName' => 'token_type', ], - 'user_id' => [ - 'title' => '', - 'description' => 'The user ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'DING-xxxxx', - 'backendName' => 'user_id', - ], - 'user_name' => [ - 'title' => '', - 'description' => 'The name of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'pdsuser', - 'backendName' => 'user_name', - ], - 'avatar' => [ - 'title' => '', - 'description' => 'The profile picture of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'aliyunpds.com/a.jpg', - 'backendName' => 'avatar', - ], - 'nick_name' => [ - 'title' => '', - 'description' => 'The nickname of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'pdsuser', - 'backendName' => 'nick_name', - ], - 'default_drive_id' => [ - 'title' => '', - 'description' => 'The ID of the default space of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'default_drive_id', - ], - 'role' => [ - 'title' => '', - 'description' => 'The role of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'admin', - 'backendName' => 'role', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'enabled', - 'backendName' => 'status', - ], - 'expire_time' => [ - 'title' => '', - 'description' => 'The time when the credential expires.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2019-09-01T06:57:48.813Z', - 'backendName' => 'expireTime', - ], - 'is_first_login' => [ - 'title' => '', - 'description' => 'Indicates whether this is the first logon of the user.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'isFirstLogin', - ], - 'device_id' => [ - 'title' => '', - 'description' => 'The ID of the device that is bound to OAuth 2.0 Device Authorization Grant.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '8574ecc3d4904dc095cc49202e74db94', - 'backendName' => 'deviceId', - ], - 'device_name' => [ - 'title' => '', - 'description' => 'The name of the device that is bound to OAuth 2.0 Device Authorization Grant.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '4683C25F', - 'backendName' => 'deviceName', + 'user_id' => ['title' => '用户ID', 'description' => 'User ID', 'type' => 'string', 'example' => 'DING-xxxxx', 'visibility' => 'Public', 'backendName' => 'user_id'], + 'user_name' => ['title' => '用户名', 'description' => 'Username', 'type' => 'string', 'example' => 'pdsuser', 'visibility' => 'Public', 'backendName' => 'user_name'], + 'avatar' => ['title' => '用户头像', 'description' => 'Profile picture', 'type' => 'string', 'example' => 'aliyunpds.com/a.jpg', 'visibility' => 'Public', 'backendName' => 'avatar'], + 'nick_name' => ['title' => '用户昵称', 'description' => 'Nickname', 'type' => 'string', 'example' => 'pdsuser', 'visibility' => 'Public', 'backendName' => 'nick_name'], + 'default_drive_id' => ['title' => '用户默认空间ID', 'description' => 'User default drive ID', 'type' => 'string', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'default_drive_id'], + 'role' => ['title' => '用户角色', 'description' => 'Role', 'type' => 'string', 'example' => 'admin', 'visibility' => 'Public', 'backendName' => 'role'], + 'status' => ['title' => '用户状态', 'description' => 'User status', 'type' => 'string', 'example' => 'enabled', 'visibility' => 'Public', 'backendName' => 'status'], + 'expire_time' => ['title' => '凭证过期时间', 'description' => 'Credential expiration time', 'type' => 'string', 'example' => '2019-09-01T06:57:48.813Z', 'visibility' => 'Public', 'backendName' => 'expireTime'], + 'is_first_login' => ['title' => '是否首次登录', 'description' => 'Indicates whether it is the first logon.', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'isFirstLogin'], + 'device_id' => ['title' => '登录设备ID', 'description' => 'Device ID bound through OAuth device flow.', 'type' => 'string', 'example' => '8574ecc3d4904dc095cc49202e74db94', 'visibility' => 'Public', 'backendName' => 'deviceId'], + 'device_name' => ['title' => '登录设备名称', 'description' => 'Device name bound through OAuth device flow.', 'type' => 'string', 'example' => '4683C25F', 'visibility' => 'Public', 'backendName' => 'deviceName'], + 'domain_id' => ['title' => '域ID', 'description' => 'Domain ID', 'type' => 'string', 'example' => 'bj1', 'visibility' => 'Public', 'backendName' => 'domain_id'], + 'default_sbox_drive_id' => ['title' => '用户默认保险箱ID', 'description' => 'User default safe box ID', 'type' => 'string', 'example' => '1', 'visibility' => 'Public'], + 'user_data' => [ + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', + 'description' => 'User-defined data', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public'], + 'example' => '', + 'visibility' => 'Public', ], - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - 'backendName' => 'domain_id', + 'pin_setup' => ['title' => '用户是否设置过保险箱密码', 'description' => 'Indicates whether the user has set a safe box password.', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'need_rp_verify' => ['title' => '用户是否需要进行实人认证', 'description' => 'Indicates whether the user needs ID Verification.', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], + 'state' => ['title' => '临时权限，用于登录成功后设置密码', 'description' => 'Temporary permission, used to set a password after successful logon.', 'type' => 'string', 'example' => 'klafhjas-asdasd-asd-as-d-asd-asd-asdasd', 'visibility' => 'Public'], + 'exist_link' => [ + 'title' => '当前用户已存在的登录方式', + 'description' => 'Existing logon methods for the current user.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/LinkInfo', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], + 'need_link' => ['title' => '是否需要绑定账号', 'description' => 'Indicates whether account binding is required.', 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'UncompressedFileInfo' => [ 'title' => 'A short description of struct', @@ -3222,22 +1098,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => '', - 'description' => 'The drive ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '5060', - ], - 'file_id' => [ - 'title' => '', - 'description' => 'The file ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '66972349b2b12fa309a143fb9db29647b2ddabfd', - ], + 'drive_id' => ['title' => '网盘id', 'description' => 'The drive ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '5060'], + 'file_id' => ['title' => '文件id', 'description' => 'The file ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '66972349b2b12fa309a143fb9db29647b2ddabfd'], 'is_folder' => [ - 'title' => '', + 'title' => '是否为文件夹', 'description' => 'Whether it is a folder.'."\n" ."\n" .'Valid values:'."\n" @@ -3246,912 +1110,458 @@ .'* false'."\n", 'visibility' => 'Public', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], - 'name' => [ - 'title' => '', - 'description' => 'The name of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1.mov', - ], - 'size' => [ - 'title' => '', - 'description' => 'The size of the file.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '218052', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'Update time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1721368014000', - ], + 'name' => ['title' => '文件名', 'description' => 'The name of the file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1.mov'], + 'size' => ['title' => '文件大小', 'description' => 'The size of the file.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '218052'], + 'updated_at' => ['title' => '更新时间', 'description' => 'Update time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1721368014000'], 'items' => [ - 'title' => '', + 'title' => '子文件', 'description' => 'Subfiles'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The extracted file.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/UncompressedFileInfo', - ], + 'items' => ['description' => 'The extracted file.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/UncompressedFileInfo', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], - 'UploadPartInfo' => [ - 'title' => '', - 'description' => 'The information about the file part.'."\n", - 'visibility' => 'public', + 'UploadFormInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The required information for a form upload.', 'type' => 'object', 'properties' => [ - 'part_number' => [ - 'title' => '', - 'description' => 'The serial number of the file part.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'part_size' => [ - 'title' => '', - 'description' => 'This parameter is discontinued.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'upload_url' => [ - 'title' => '', - 'description' => 'The upload URL. By default, the validity period of the URL is 15 minutes. If the URL expires, you must call the GetUploadUrl operation to obtain another URL. If the intelligent domain name feature is enabled, the internal_upload_url value is returned within the parameter based on the request.'."\n", - 'visibility' => 'public', - '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' => 'The internal upload URL that is used for internal access over a virtual private cloud (VPC). If the intelligent domain name feature is enabled, this parameter is not required. This parameter is returned in the upload_url parameter based on the request. If you want to use this parameter, contact Photo and Drive Service (PDS) technical support.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661', - ], - 'etag' => [ - 'title' => 'etag', - 'description' => 'This parameter is discontinued.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '"0CC175B9C0F1B6A831C399E269772661"', + 'endpoint' => ['title' => '数据存储地址', 'description' => 'The request endpoint for the upload.', 'type' => 'string', 'example' => ''], + 'form_data' => [ + 'title' => '表单上传信息', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The key-value pairs for the form fields. The value for each key must be a string.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'The form fields for the upload.', + 'example' => '', ], + ], + 'example' => '', + ], + 'UploadPartInfo' => [ + 'title' => '分段信息', + 'description' => 'Part information.', + 'type' => 'object', + 'properties' => [ + 'part_number' => ['title' => '段编号', 'description' => 'The part number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'part_size' => ['title' => '分段大小', 'description' => 'This field is deprecated. Do not use it.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], + 'upload_url' => ['title' => '上传地址', 'description' => 'The upload URL. The URL is valid for 15 minutes by default. If the URL expires, you must call the GetUploadUrl operation again to obtain a new one. If you enable the intelligent data domain feature, the value of internal\\_upload\\_url is adaptively returned in this field based on the request.', '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' => 'The internal upload URL, which is used for access from within a VPC network. After you enable the intelligent data domain feature, this field is no longer used. The value of this parameter is adaptively returned in the upload\\_url field based on the request. If you need to use this field, contact PDS technical support.', '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' => 'This field is deprecated. Do not use it.', 'type' => 'string', 'example' => '"0CC175B9C0F1B6A831C399E269772661"'], 'parallel_sha1_ctx' => [ - 'title' => '', - 'description' => 'The Secure Hash Algorithm 1 (SHA-1) context of the previous part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'visibility' => 'public', + 'title' => '上一个分段的sha1上下文', + 'description' => 'The SHA-1 context of the previous part. This field is valid only for parallel upload of multiple parts.', 'type' => 'object', 'properties' => [ 'h' => [ - 'title' => '', - 'description' => 'The first to fifth 32-bit variables in the SHA-1 context of the previous part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'visibility' => 'public', + 'title' => '上一个数据块SHA1的第1-5个32位变量', + 'description' => 'The first five 32-bit variables of the SHA-1 hash of the previous data block. This field is valid only for parallel upload of multiple parts.', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'extendType' => 'true', - 'description' => '', - ], - ], - 'part_offset' => [ - 'title' => '', - 'description' => 'The total size of all the previous parts. Unit: bytes. The value must be a multiple of 64. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10240', - ], - ], - ], - 'upload_form_info' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/UploadFormInfo', - ], - 'internal_upload_form_info' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - '$ref' => '#/components/schemas/UploadFormInfo', - ], - 'signature_info' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'object', - 'properties' => [ - 'auth_type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - ], - 'signature' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - ], - 'sts_token' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], + 'part_offset' => ['title' => '到上一个数据块为止的总长度，字节，需要为64的倍数', 'description' => 'The total length of data up to the previous data block, in bytes. The value must be a multiple of 64. This field is valid only for parallel upload of multiple parts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10240'], ], + 'example' => '', ], + 'upload_form_info' => ['title' => '表单上传信息', 'description' => 'The form upload information.', '$ref' => '#/components/schemas/UploadFormInfo', 'example' => ''], 'parallel_sha256_ctx' => [ - 'title' => '', - 'description' => 'The SHA-256 context of the previous part.'."\n", - 'visibility' => 'public', + 'title' => '上一个分段的sha256上下文', + 'description' => 'The SHA-256 context of the previous part.', 'type' => 'object', 'properties' => [ 'h' => [ - 'title' => '', - 'description' => 'The first to eighth 32-bit variables in the SHA-256 context of the previous part.'."\n", - 'visibility' => 'public', + 'title' => '上一个数据块SHA256的第1-8个32位变量', + 'description' => 'The first eight 32-bit variables of the SHA-256 hash of the previous data block.', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'extendType' => 'true', - 'description' => '', - ], - ], - 'part_offset' => [ - 'title' => '', - 'description' => 'The total size of all the previous parts. Unit: bytes. The value must be a multiple of 64.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], + 'part_offset' => ['title' => '到上一个数据块为止的总长度，字节，需要为64的倍数', 'description' => 'The total length of data up to the previous data block, in bytes. The value must be a multiple of 64.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], ], + 'example' => '', ], ], + 'example' => '', ], 'User' => [ - 'title' => '', - 'description' => 'The information about the user.'."\n", - 'visibility' => 'public', + 'title' => '用户', + 'description' => 'Details of the user.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => '', - 'description' => 'The domain ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'bj1', - ], - 'user_id' => [ - 'title' => '', - 'description' => 'The user ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'avatar' => [ - 'title' => '', - 'description' => 'The profile picture.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'http://aa.com/1.jpg', - ], - 'created_at' => [ - 'title' => '', - 'description' => 'The time when the user was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639762579768', - ], - 'updated_at' => [ - 'title' => '', - 'description' => 'The time when the user was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639762579768', - ], - 'email' => [ - 'title' => '', - 'description' => 'The email address of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'a@aliyunpds.com', - ], - 'nick_name' => [ - 'title' => '', - 'description' => 'The nickname of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '001', - ], - 'phone' => [ - 'title' => '', - 'description' => 'The mobile number of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '13900001111', - ], + 'domain_id' => ['title' => '域id', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'user_id' => ['title' => '用户id', 'description' => 'The user ID.', 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4'], + 'avatar' => ['title' => '头像', 'description' => 'The user\'s avatar URL.', 'type' => 'string', 'example' => 'http://aa.com/1.jpg'], + 'created_at' => ['title' => '创建时间', 'description' => 'The creation time, expressed in milliseconds since the Unix epoch (00:00:00 UTC on January 1, 1970).', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579768'], + 'updated_at' => ['title' => '修改时间', 'description' => 'The update time, expressed in milliseconds since the Unix epoch (00:00:00 UTC on January 1, 1970).', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579768'], + 'email' => ['title' => '邮箱', 'description' => 'The user\'s email address.', 'type' => 'string', 'example' => 'a@aliyunpds.com'], + 'nick_name' => ['title' => '昵称', 'description' => 'The user\'s nickname.', 'type' => 'string', 'example' => '001'], + 'phone' => ['title' => '手机号', 'description' => 'The user\'s phone number.', 'type' => 'string', 'example' => '13900001111'], 'role' => [ - 'title' => '', - 'description' => 'The role of the user. Valid values:'."\n" + 'title' => '角色', + 'description' => 'The user\'s role. Valid values:'."\n" + ."\n" + .'- `superadmin`: A super administrator.'."\n" ."\n" - .'* superadmin'."\n" - .'* admin'."\n" - .'* user'."\n", - 'visibility' => 'public', + .'- `admin`: An administrator.'."\n" + ."\n" + .'- `user`: A standard user.', + 'enumValueTitles' => ['superadmin' => '超级管理员', 'admin' => '管理员', 'user' => '普通用户'], 'type' => 'string', - 'enumValueTitles' => [ - 'superadmin' => '', - 'admin' => '', - 'user' => '', - ], 'example' => 'user', ], 'status' => [ - 'title' => '', - 'description' => 'The status of the user. Valid values:'."\n" + 'title' => '状态', + 'description' => 'The user\'s status. Valid values:'."\n" + ."\n" + .'- `disabled`: The user is disabled.'."\n" ."\n" - .'* disabled: The user is prohibited from logon.'."\n" - .'* enabled: The user is in a normal state.'."\n", - 'visibility' => 'public', + .'- `enabled`: The user is enabled.', + 'enumValueTitles' => ['disabled' => '禁止', 'enabled' => '使能'], 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], 'example' => 'enabled', ], - 'user_name' => [ - 'title' => '', - 'description' => 'The name of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'pds', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vipuser', - ], - 'default_drive_id' => [ - 'title' => '', - 'description' => 'The default drive ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1', + 'user_name' => ['title' => '用户名', 'description' => 'The user\'s username.', 'type' => 'string', 'example' => 'pds'], + 'description' => ['title' => '描述', 'description' => 'A description of the user.', 'type' => 'string', 'example' => 'vipuser'], + 'default_drive_id' => ['title' => '缺省空间id', 'description' => 'The ID of the user\'s default drive.', 'type' => 'string', 'example' => '1'], + 'creator' => ['title' => '创建者', 'description' => 'The creator of the user.', 'type' => 'string', 'example' => 'user1'], + 'last_login_time' => ['description' => 'The user\'s last login time, expressed in milliseconds since the Unix epoch (00:00:00 UTC on January 1, 1970).', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'last_refresh_token_time' => ['description' => 'The time the refresh token was last used, expressed in milliseconds since the Unix epoch (00:00:00 UTC on January 1, 1970).', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], + 'user_data' => [ + 'title' => '用户自定义数据', + 'description' => 'Custom user data, stored as a collection of key-value pairs.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the key.', 'type' => 'string', 'title' => '', 'example' => ''], + 'example' => '', ], + ], + 'example' => '', + ], + 'UserExtraItem' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['title' => 'Domain ID', 'description' => 'The ID of the domain.', 'type' => 'string', 'example' => 'hz999'], + 'user_id' => ['title' => '用户 ID', 'description' => 'The ID of the user.', 'type' => 'string', 'example' => 'ccpuserid'], + 'avatar' => ['title' => '头像', 'description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'http://a.b.c/ccp.jpg'], + 'created_at' => ['title' => '用户创建时间', 'description' => 'The time the user was created, formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1567407718386'], + 'updated_at' => ['title' => '用户修改时间', 'description' => 'The time the user was last updated, formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1567407718386'], + 'email' => ['title' => '邮箱', 'description' => 'The email address of the user.', 'type' => 'string', 'example' => '123@ccp.com'], + 'nick_name' => ['title' => '昵称', 'description' => 'The nickname of the user.', 'type' => 'string', 'example' => 'abc'], + 'phone' => ['title' => '电话', 'description' => 'The phone number of the user.', 'type' => 'string', 'example' => '13700000000'], + 'phone_region' => ['title' => '国家编码', 'description' => 'The country or region code for the user\'s phone number. For example, `86` for the Chinese mainland.', 'type' => 'string', 'example' => ''], + 'role' => ['title' => '角色', 'description' => 'The role of the user. For example, `user` or `admin`.', 'type' => 'string', 'example' => 'user'], + 'status' => ['title' => '用户状态', 'description' => 'The status of the user account. Valid values are `enabled` and `disabled`.', 'type' => 'string', 'example' => 'enabled'], + 'user_name' => ['title' => '用户名称', 'description' => 'The name of the user.', 'type' => 'string', 'example' => 'name'], + 'description' => ['description' => '', 'title' => '用户备注信息', 'example' => 'ccp team user', 'type' => 'string'], + 'default_drive_id' => ['title' => '默认 Drive ID', 'description' => 'The ID of the user\'s default drive.', 'type' => 'string', 'example' => '123'], + 'deny_change_password_by_self' => ['title' => '禁止用户自行修改密码', 'description' => 'Whether the user is prevented from changing their own password. If `true`, the user cannot change their password.', 'type' => 'boolean', 'example' => ''], + 'need_change_password_next_login' => ['title' => '下次登录强制修改密码', 'description' => 'Whether the user must change their password at the next login. If `true`, a password change is required.', 'type' => 'boolean', 'example' => ''], + 'creator' => ['title' => 'creator', 'description' => 'The creator of the user account. For example, `system`.', 'type' => 'string', 'example' => 'system'], + 'expired_at' => ['title' => '用户过期时间', 'description' => 'The time the user account expires, formatted as a UNIX timestamp in milliseconds. A value of `0` means the account never expires.', 'type' => 'integer', 'example' => '0', 'format' => 'int64'], + 'is_sync' => ['title' => 'is_sync', 'description' => 'Whether the user is synchronized from an external source.', 'type' => 'boolean', 'example' => ''], + 'default_location' => ['title' => 'default_location', 'description' => 'The default storage location for the user\'s data.', 'type' => 'string', 'example' => ''], + 'last_login_time' => ['title' => 'last_login_time', 'description' => 'The time of the user\'s last login, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'path_status' => ['title' => 'path 开启状态', 'description' => 'The status of the user\'s path in the group hierarchy.', 'type' => 'string', 'example' => ''], + 'default_drive' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/BaseDriveResponse'], + 'last_refresh_token_time' => ['description' => 'The time the user\'s refresh token was last used, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int64'], 'user_data' => [ - 'title' => '', - 'description' => 'The custom data of the user.'."\n", - 'visibility' => 'public', + 'title' => '用户自定义数据，格式为json，可用于配置项、少量临时数据等存储，不超过1K', 'type' => 'object', - 'additionalProperties' => [ - 'visibility' => 'public', - 'type' => 'string', - 'description' => '', - ], + 'additionalProperties' => ['description' => 'Custom key-value data.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'A key-value map that stores custom data about the user.', + 'example' => '', ], - 'creator' => [ - 'title' => '', - 'description' => 'The user who created the user.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user1', + 'permission' => [ + 'title' => 'permission', + 'type' => 'object', + 'additionalProperties' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IDPermission'], + 'description' => 'The permission details.', + 'example' => '', ], - 'punishments' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', + 'parent_group' => [ + 'title' => 'parent_group', 'type' => 'array', - 'items' => [ - 'visibility' => 'public', - 'type' => 'object', - 'properties' => [ - 'punish_flag' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - ], - 'starts_at' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - ], - 'ends_at' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - ], - 'impermanent' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - ], - ], - 'extendType' => 'true', - ], + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/BaseDriveResponse'], + 'description' => 'Details of a parent group.', + 'example' => '', ], - 'is_sync' => [ - 'title' => '是否为同步账号', - 'description' => '是否为同步账号', - 'visibility' => 'Private', - 'type' => 'boolean', + 'account' => [ + 'title' => 'account', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/AccountLinkInfo'], + 'description' => 'Details of a linked account.', + 'example' => '', ], ], + 'description' => 'Contains detailed information about a user.', + 'example' => '', ], 'UserTag' => [ 'title' => 'A short description of struct', - 'description' => 'The information about the user tag.'."\n", - 'visibility' => 'public', + 'description' => 'User tag', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => 'key', - 'description' => 'The tag key. This parameter must be specified and the tag key cannot contain number signs (#). The tag key and tag value cannot exceed 2,000 bytes in length in total.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'required' => true, - 'example' => 'k1', - ], - 'Value' => [ - 'title' => 'value', - 'description' => 'The tag value. The tag value cannot contain number signs (#). The tag key and tag value cannot exceed 2,000 bytes in length in total.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'key' => ['title' => 'key', 'description' => 'Key. Required. Must not contain the # character. The combined length of key and value in a single tag must not exceed 2000 bytes.', 'type' => 'string', 'required' => true, 'example' => 'topic', 'visibility' => 'Public'], + 'value' => ['title' => 'value', 'description' => 'Value', 'type' => 'string', 'example' => '', 'required' => true, 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'VideoMediaAudioStream' => [ - 'title' => '', + 'title' => '音频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', 'description' => 'The information about audio streams. This parameter is valid only if the value-added image processing or video transcoding feature is enabled.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'The duration of the audio stream. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '7704.573000', - ], - 'bit_rate' => [ - 'title' => '', - 'description' => 'The bitrate of the audio stream. Unit: bit/s.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '129280', - ], - 'code_name' => [ - 'title' => '', - 'description' => 'The audio encoding mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'aac', - ], + 'duration' => ['title' => '音频时长，单位为秒（s）。', 'description' => 'The duration of the audio stream. Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '7704.573000'], + 'bit_rate' => ['title' => '音频比特率，单位为比特每秒（bps）。', 'description' => 'The bitrate of the audio stream. Unit: bit/s.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '129280'], + 'code_name' => ['title' => '音频编码模式。', 'description' => 'The audio encoding mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'aac'], ], ], 'VideoMediaMetadata' => [ - 'title' => 'A short description of struct', - 'description' => 'The video metadata.'."\n", - 'visibility' => 'public', + 'title' => '音视频信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'description' => 'Video metadata', 'type' => 'object', 'properties' => [ - 'time' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '2006-01-02T15:04:05.000Z07:00', - ], - 'width' => [ - 'title' => '', - 'description' => 'The width of the video image. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1920', - ], - 'height' => [ - 'title' => '', - 'description' => 'The height of the video image. Unit: pixel.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1080', - ], - 'location' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '30.185453,120.218522', - ], - 'country' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'China', - ], - 'province' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Zhejiang', - ], - 'city' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Hangzhou', - ], - 'district' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Xihu', - ], - 'township' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Xihu', - ], - 'address_line' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'Zhejiang hangzhou xihu', - ], + 'width' => ['title' => '视频画面宽度，单位为像素（px）。', 'description' => 'Video frame width in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', 'visibility' => 'Public'], + 'height' => ['title' => '视频画面高度，单位为像素（px）。', 'description' => 'Video frame height in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'visibility' => 'Public'], 'video_media_video_stream' => [ - 'title' => '', - 'description' => 'The information about the video stream.'."\n", - 'visibility' => 'Public', + 'title' => '视频流源信息。', + 'description' => 'Video stream source information.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoMediaVideoStream', - 'description' => '', - ], + 'items' => ['$ref' => '#/components/schemas/VideoMediaVideoStream', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], 'video_media_audio_stream' => [ - 'title' => '', - 'description' => 'The information about the audio stream.'."\n", - 'visibility' => 'Public', + 'title' => '音频流源信息。', + 'description' => 'Audio stream source information.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoMediaAudioStream', - 'description' => '', - ], + 'items' => ['$ref' => '#/components/schemas/VideoMediaAudioStream', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'VideoMediaVideoStream' => [ - 'title' => '', - 'description' => 'The information about the video streams. This parameter is valid only if the value-added image processing or video transcoding feature is enabled.'."\n", + 'title' => '视频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', + 'description' => '视频流信息。仅开启增值服务图片处理功能或视频转码功能有效。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'The duration of the video stream. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '22.88', - ], - 'bitrate' => [ - 'title' => '', - 'description' => 'The bitrate of the video stream. Unit: bit/s.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '108420', - ], - 'code_name' => [ - 'title' => '', - 'description' => 'The video encoding mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'h264', - ], - 'frame_count' => [ - 'title' => '', - 'description' => 'The number of video frames.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '90', - ], + 'duration' => ['title' => '视频流持续时长，单位为秒（s）。', 'description' => '视频流持续时长，单位为秒（s）。', 'visibility' => 'Public', 'type' => 'string', 'example' => '22.88'], + 'bitrate' => ['title' => '视频流比特率，单位为比特率每秒（bps）。', 'description' => '视频流比特率，单位为比特率每秒（bps）。', 'visibility' => 'Public', 'type' => 'string', 'example' => '108420'], + 'code_name' => ['title' => '视频编码模式。', 'description' => '视频编码模式。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'h264'], + 'frame_count' => ['title' => '视频帧数。', 'description' => '视频帧数。', 'visibility' => 'Public', 'type' => 'string', 'example' => '90'], ], ], 'VideoPreviewPlayInfo' => [ - 'title' => '', - 'description' => 'The information about video playback.'."\n", - 'visibility' => 'public', + 'title' => '播放信息', + 'description' => 'Playback information', 'type' => 'object', 'properties' => [ - 'category' => [ - 'title' => '', - 'description' => 'Category'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'live_transcoding', - ], + 'category' => ['title' => '所属分类', 'description' => 'Category', 'type' => 'string', 'example' => 'quick_video', 'visibility' => 'Public'], 'meta' => [ - 'title' => '', - 'description' => 'Video meta information.'."\n", - 'visibility' => 'public', + 'title' => '视频元信息', + 'description' => 'Video metadata', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Video length.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'double', - 'example' => '4.2898', - ], - 'width' => [ - 'title' => '', - 'description' => 'Width of the video.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1920', - ], - 'height' => [ - 'title' => '', - 'description' => 'Height of the video'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1080', - ], + 'duration' => ['title' => '视频长度', 'description' => 'Video duration, in seconds', 'type' => 'number', 'format' => 'double', 'example' => '4.2898', 'visibility' => 'Public'], + 'width' => ['title' => '视频宽度', 'description' => 'Video width, in pixels', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', 'visibility' => 'Public'], + 'height' => ['title' => '视频高度', 'description' => 'Video height, in pixels', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'live_transcoding_task_list' => [ - 'title' => '', - 'description' => 'The information about video playback.'."\n", - 'visibility' => 'public', + 'title' => '播放信息', + 'description' => 'The playback information.', 'type' => 'array', 'items' => [ - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'Template ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '264_480p', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status. Valid values:'."\n" - ."\n" - .'* finished: The index is complete, and the url can be obtained.'."\n" - .'* running: Indexing in progress. Wait a moment and try again.'."\n" - .'* failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'finished', - ], - 'url' => [ - 'title' => '', - 'description' => 'Playback URL.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/lt/xxx/media.m3u8', - ], + 'template_id' => ['title' => '模板id', 'description' => 'Template ID', 'type' => 'string', 'example' => '264_480p', 'visibility' => 'Public'], + 'status' => ['title' => '状态', 'description' => 'Status. Valid values:'."\n" + ."\n" + .'- finished: Indexing is complete. You can retrieve the URL.'."\n" + ."\n" + .'- running: Indexing is in progress. Wait a moment and retry.'."\n" + ."\n" + .'- failed: Transcoding failed. Verify that the file is a valid media file. Contact Alibaba Cloud support if you need help.', 'type' => 'string', 'example' => 'finished', 'visibility' => 'Public'], + 'url' => ['title' => '播放地址', 'description' => 'Playback URL', 'type' => 'string', 'example' => 'https://example.data.aliyunpds.com/lt/xxx/media.m3u8', 'visibility' => 'Public'], 'keep_original_resolution' => [ - 'title' => '', - 'description' => 'Whether the original resolution is maintained.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'visibility' => 'public', + 'title' => '是否保持原分辨率', + 'description' => 'Keep the original video resolution', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', - ], - 'preview_url' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/lt/xxx/ref_task.m3u8', + 'visibility' => 'Public', ], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', ], 'quick_video_list' => [ - 'title' => '', - 'description' => 'The information about video playback.'."\n", - 'visibility' => 'Public', + 'title' => '播放信息', + 'description' => 'Playback information.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'Template ID'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '264_480p', - ], - 'status' => [ - 'title' => '', - 'description' => 'Valid values:'."\n" - ."\n" - .'* finished: The index is complete, and the url can be obtained.'."\n" - .'* running: Indexing in progress. Wait a moment and try again.'."\n" - .'* failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'finished', - ], - 'url' => [ - 'title' => '', - 'description' => 'Playback URL.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/qv/xxx/media.m3u8', - ], - 'preview_url' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/qv/xxx/ref_task.m3u8', - ], + 'template_id' => ['title' => '模板id', 'description' => 'Template ID', 'type' => 'string', 'example' => '264_480p', 'visibility' => 'Public'], + 'status' => ['title' => '状态', 'description' => 'Status. Valid values:'."\n" + ."\n" + .'- finished: Indexing is complete. You can retrieve the URL.'."\n" + ."\n" + .'- running: Indexing is in progress. Wait a moment and retry.'."\n" + ."\n" + .'- failed: Transcoding failed. Verify that the file is a valid media file. Contact Alibaba Cloud support if you need help.', 'type' => 'string', 'example' => 'finished', 'visibility' => 'Public'], + 'url' => ['title' => '播放地址', 'description' => 'Playback URL', 'type' => 'string', 'example' => 'https://example.data.aliyunpds.com/qv/xxx/media.m3u8', 'visibility' => 'Public'], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', ], 'offline_video_transcoding_list' => [ - 'title' => '', - 'description' => 'Offline transcoding playback information.'."\n", - 'visibility' => 'Public', + 'title' => '离线转码播放信息', + 'description' => 'A list of playback information for offline transcoding.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'The ID of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '264_1080p', - ], - 'status' => [ - 'title' => '', - 'description' => 'The task status.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'finished', - ], + 'template_id' => ['title' => '模板 ID', 'description' => 'Template ID', 'type' => 'string', 'example' => '264_1080p', 'visibility' => 'Public'], + 'status' => ['title' => '任务状态', 'description' => 'Task status', 'type' => 'string', 'example' => 'finished', 'visibility' => 'Public'], 'keep_original_resolution' => [ - 'title' => '', - 'description' => 'Whether the transcoded video has the same resolution as the source video.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'visibility' => 'Public', + 'title' => '转码视频是否和源视频同分辨率', + 'description' => 'Keep the same resolution as the source video', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', - ], - 'url' => [ - 'title' => '', - 'description' => 'Playback URL.'."\n", 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/xxx/master.mp4'."\n", ], + 'url' => ['title' => '播放地址', 'description' => 'Playback URL', 'type' => 'string', 'example' => 'https://example.data.aliyunpds.com/xxx/master.mp4'."\n", 'visibility' => 'Public'], ], - 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', + 'visibility' => 'Public', + 'extendType' => 'true', ], + 'example' => '', + 'visibility' => 'Public', ], 'live_transcoding_subtitle_task_list' => [ - 'title' => '', - 'description' => 'Live transcoding subtitle information.'."\n", - 'visibility' => 'Public', + 'title' => '边转边播字幕信息', + 'description' => 'Live transcoding subtitle information', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', - 'description' => '', - ], + 'items' => ['$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], 'quick_video_subtitle_list' => [ - 'title' => '', - 'description' => 'Quick transcoding subtitle information.'."\n", - 'visibility' => 'Public', + 'title' => '快速转码字幕信息', + 'description' => 'Quick transcoding subtitle information', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', - 'description' => '', - ], + 'items' => ['$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', ], 'offline_video_transcoding_subtitle_list' => [ - 'title' => '', - 'description' => 'Offline transcoding subtitle information.'."\n", - 'visibility' => 'Public', + 'title' => '离线转码字幕信息', + 'description' => 'Offline transcoding subtitle information', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', - 'description' => '', - ], - ], - 'master_url' => [ - 'title' => '', - 'description' => 'Playback URL of master m3u8.'."\n", + 'items' => ['$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8', ], + 'master_url' => ['title' => 'master m3u8 的播放链接', 'description' => 'Master M3U8 playback URL', 'type' => 'string', 'example' => 'https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'VideoPreviewPlayMeta' => [ - 'title' => '', + 'title' => '播放元信息', 'description' => 'The preview metadata of the video.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'meta' => [ - 'title' => '', + 'title' => '视频元信息', 'description' => 'Video meta information.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => 'Length of the video.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'width' => [ - 'title' => '', - 'description' => 'Width of the video.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1280', - ], - 'height' => [ - 'title' => '', - 'description' => 'Height of the video.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '720', - ], + 'duration' => ['title' => '视频长度', 'description' => 'Length of the video.'."\n", 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'width' => ['title' => '视频宽度', 'description' => 'Width of the video.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1280'], + 'height' => ['title' => '视频高度', 'description' => 'Height of the video.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '720'], ], + 'example' => '', ], 'live_transcoding_task_list' => [ - 'title' => '', + 'title' => '边转边播任务状态', 'description' => 'Status of the live transcoding job.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'array', 'items' => [ - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'Template ID'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '264_720p', - ], + 'template_id' => ['title' => '模板id', 'description' => 'Template ID'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '264_720p'], 'status' => [ - 'title' => '', + 'title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', 'description' => 'The status. Valid values:'."\n" ."\n" .'* finished: The index is complete, and the url can be obtained.'."\n" .'* running: Indexing in progress. Wait a moment and try again.'."\n" .'* failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'running' => 'running', - 'finished' => 'finished', - 'failed' => 'failed', - ], + 'enumValueTitles' => ['running' => 'running', 'finished' => 'finished', 'failed' => 'failed'], 'example' => 'finished', ], 'keep_original_resolution' => [ - 'title' => '', + 'title' => '是否保持原分辨率', 'description' => 'Whether the original resolution is maintained.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], ], 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'category' => [ - 'title' => '', - 'description' => 'Category'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'live_transcoding', - ], + 'category' => ['title' => '所属分类', 'description' => 'Category'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'live_transcoding'], 'quick_video_list' => [ - 'title' => '', + 'title' => '快速转码任务状态', 'description' => 'The state of the transcoding job.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -4159,27 +1569,18 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'Template ID'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '264_720p', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status. finished: The index is completed, and the url can be obtained. running: Indexing in progress. Wait a moment and try again. failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'finished', - ], + 'template_id' => ['title' => '模板id', 'description' => 'Template ID'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '264_720p'], + 'status' => ['title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', 'description' => 'The status. finished: The index is completed, and the url can be obtained. running: Indexing in progress. Wait a moment and try again. failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'finished'], ], 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'offline_video_transcoding_list' => [ - 'title' => '', + 'title' => '离线转码任务状态', 'description' => 'The status of the offline transcoding job.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -4187,49 +1588,29 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'template_id' => [ - 'title' => '', - 'description' => 'Template ID'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '264_720p', - ], - 'status' => [ - 'title' => '', - 'description' => 'The status. finished: The index is completed, and the url can be obtained. running: Indexing in progress. Wait a moment and try again. failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'finished', - ], - 'keep_original_resolution' => [ - 'title' => '', - 'description' => 'Whether the original resolution is maintained.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'true', - ], + 'template_id' => ['title' => '模板id', 'description' => 'Template ID'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '264_720p'], + 'status' => ['title' => '状态。 枚举值如下： finished, 索引完成，可以获取到url running, 正在索引，请稍等片刻重试 failed, 转码失败，请检查是否媒体文件，如果有疑问请联系客服', 'description' => 'The status. finished: The index is completed, and the url can be obtained. running: Indexing in progress. Wait a moment and try again. failed: Transcoding failed. Check the media file. If you have any questions, contact customer service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'finished'], + 'keep_original_resolution' => ['title' => '是否保持原分辨率', 'description' => 'Whether the original resolution is maintained.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true'], ], 'extendType' => 'true', 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], 'VideoPreviewSubtitleInfo' => [ - 'title' => '', + 'title' => '字幕任务信息', 'description' => 'The information about the subtitle task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'language' => [ - 'title' => '', - 'description' => 'The subtitle language.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'en', - ], + 'language' => ['title' => '字幕语言', 'description' => 'The subtitle language.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'en'], 'status' => [ - 'title' => '', + 'title' => '字幕任务状态', 'description' => 'The status of the subtitle task.'."\n" ."\n" .'Valid values:'."\n" @@ -4238,390 +1619,224 @@ .'* failed'."\n", 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'finished' => 'finished', - 'failed' => 'failed', - ], + 'enumValueTitles' => ['finished' => 'finished', 'failed' => 'failed'], 'example' => 'finished', ], - 'url' => [ - 'title' => '', - 'description' => 'The subtitle URL.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt', - ], + 'url' => ['title' => '字幕 URL', 'description' => 'The subtitle URL.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt'], ], ], ], ], 'apis' => [ - 'CreateDomain' => [ - 'summary' => 'Creates a domain.', - 'path' => '/v2/domain/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'admin', - ], + 'AddGroupMember' => [ + 'summary' => 'Adds a member to a group.', + 'path' => '/v2/group/add_member', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'parent_domain_id' => [ - 'description' => 'The ID of the parent domain. If you want to create a child domain, specify parent_domain_id. In most cases, you do not need to create a child domain. If you want to perform secondary operations based on Drive and Photo Service, contact the customer service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bj1', - ], - 'domain_name' => [ - 'description' => 'The name of the domain.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cloud drive'."\n", - ], - 'description' => [ - 'description' => 'The description of the domain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cloud drive dev'."\n", - ], - 'init_drive_enable' => [ - 'description' => 'Specifies whether to enable the default drive feature. A value of true specifies that all users are assigned a drive by default on the first logon. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'init_drive_size' => [ - 'description' => 'This parameter is required when the init_drive_enable is set to true. The size of the default drive. Unit: bytes. The default is 0, meaning the created drive size is 0, and files cannot be uploaded. If you need to initialize the drive, set this value. A value of -1 indicates that the size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1073741824', - ], - 'user_count_quota' => [ - 'description' => 'The largest number of users that can be created in the domain. A value of 0 specifies that the number is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], - 'size_quota' => [ - 'description' => 'The total storage quota for all drives in the domain. A value of 0 indicates that the quota is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1099511627776', - ], - 'store_redundancy_type' => [ - 'description' => 'Specifies the storage redundancy type. Valid values:'."\n" - ."\n" - .'* LRS: locally redundant storage'."\n" - .'* ZRS: zone-redundant storage'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LRS', - 'enum' => [], - ], + 'group_id' => ['description' => 'The ID of the group to add a member to.', 'type' => 'string', 'required' => true, 'example' => '3e5***2c2', 'title' => ''], + 'member_type' => ['description' => 'The type of member to add. For this operation, the only valid value is `user`. To add a group as a member of another group, you must specify the parent group when creating that group.'."\n" + ."\n" + .'- user'."\n" + ."\n" + .'Note: A group can belong to only one parent group, but a user can belong to multiple groups.', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''], + 'member_id' => ['description' => 'The user ID of the member to add.', 'type' => 'string', 'required' => true, 'example' => '2e4***1b1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The name of the domain.'."\n", - '$ref' => '#/components/schemas/Domain', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'AddGroupMember', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'CreateDomain', - 'description' => 'The description of the domain.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'GetDomain' => [ - 'summary' => 'Get domain information.', - 'path' => '/v2/domain/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'admin', - ], + 'AddStoryFiles' => [ + 'summary' => 'Adds files to a specified story.', + 'path' => '/v2/image/add_story_files', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'description' => 'The ID of the domain.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'bj1', - ], - 'get_quota_used' => [ - 'description' => 'Specifies whether to return the used quota of the domain. Default value: false. If the quota of the domain is greater than 0 and you set this parameter to true, the used quota of the domain is returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'fields' => [ - 'type' => 'string', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'required' => true, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'files' => [ + 'description' => 'The files to add to the story.', + 'type' => 'array', + 'items' => [ + 'description' => 'A file to add.', + 'type' => 'object', + 'properties' => [ + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'revision_id' => ['description' => 'The revision ID.', 'type' => 'string', 'required' => false, 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the domain.'."\n", - '$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' => 'GetDomain', - ], - 'UpdateDomain' => [ - 'summary' => 'Update domain information.', - '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' => 'The request parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'bj1', - ], - 'domain_name' => [ - 'description' => 'The name of the domain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'description' => [ - 'description' => 'The description of the domain.'."\n", - 'type' => 'string', - 'required' => false, + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'files' => [ + 'description' => 'The results for the processed files.', + 'type' => 'array', + 'items' => ['description' => 'The result for a processed file.', '$ref' => '#/components/schemas/AddStoryFile', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', ], - 'init_drive_enable' => [ - 'description' => 'Specifies whether to enable the default drive feature. A value of true specifies that all users are assigned a drive by default on the first logon. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'init_drive_size' => [ - 'description' => 'The size of the default drive. Unit: bytes. You must specify init_drive_size if you set init_drive_enable to true. Default value: 0. A value of 0 specifies that the size of the default drive is 0 bytes and you cannot upload files to the drive. To initialize the default drive, set init_drive_size to 0. A value of -1 specifies that the size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1073741824', - ], - 'user_count_quota' => [ - 'description' => 'The maximum number of users that can be created in the domain.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], - 'size_quota' => [ - 'description' => 'The total storage quota for all drives in the domain. A value of 0 specifies that the quota is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1099511627776', - ], - 'published_app_access_strategy' => [ - 'description' => 'The access policy of the application.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/AppAccessStrategy', - ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information about the updated domain.'."\n", - '$ref' => '#/components/schemas/Domain', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Add a file to a story', + 'description' => '**Before you call this API, make sure that you understand the billing methods and [pricing](~~425220~~) of PDS**.'."\n" + ."\n" + .'To use this feature, you must enable the image processing feature.'."\n" + ."\n" + .'After you create a story, you can manually add files to it.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'UpdateDomain', + '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"}]', ], - 'ListDomains' => [ - 'summary' => '列举 domain', - 'path' => '/v2/domain/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'admin', - ], + 'ArchiveFiles' => [ + 'summary' => 'Archives files and folders into a package for download.', + 'path' => '/v2/file/archive_files', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => 'bj1', 'title' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'parent_domain_id' => [ - 'description' => 'The ID of the parent domain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bj1', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - 'service_code' => [ - 'type' => 'string', + 'share_id' => ['description' => 'The share ID. This parameter is required when archiving files from a share.', 'type' => 'string', 'example' => '7JQX1FswpQ8', 'title' => '', 'required' => false], + 'drive_id' => ['description' => 'The ID of the drive that contains the files. You must specify either this parameter or `share_id`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_ids' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the file or folder to archive.', 'type' => 'string', 'required' => true, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'required' => true, + 'description' => 'The list of files to be archived.', + 'title' => '', + 'example' => '', ], + 'name' => ['description' => 'The name of the generated archive file. The name must be UTF-8 encoded.', 'type' => 'string', 'required' => true, 'example' => 'test_archive_files.zip', 'title' => ''], ], + 'description' => 'The parameters in the request body.', + 'title' => '', + 'example' => '', 'required' => false, ], ], @@ -4629,465 +1844,553 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned domains.'."\n", + 'title' => '', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The information about the domains.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a domain.', - '$ref' => '#/components/schemas/Domain', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], + 'async_task_id' => ['description' => 'The asynchronous task ID.', 'type' => 'string', 'required' => true, 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', 'title' => ''], ], + 'description' => 'The request was successful and the asynchronous task was created.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ArchiveFiles', + 'description' => 'This asynchronous operation archives files and folders into a single package and returns an asynchronous task ID. To check the status of the task, call `GetAsyncTask`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'ListDomains', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"async_task_id\\": \\"000e89fb-cf8f-11e9-8ab4-b6e980803a3b\\"\\n}","type":"json"}]', ], - 'SearchDomains' => [ - 'summary' => 'Searches for domains', - 'path' => '/v2/domain/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'admin', - ], + 'AssignRole' => [ + 'summary' => 'This operation assigns the team administrator role to a user.', + 'path' => '/v2/role/assign', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'required' => false, 'example' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the domain. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], - 'order_by' => [ - 'description' => 'The sorting rule. Set the value to created_at, which specifies that the results are sorted based on the time when the domain was created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'created_at', - ], + 'identity' => ['description' => 'The unique identifier of the user.', 'required' => true, '$ref' => '#/components/schemas/Identity', 'title' => '', 'example' => ''], + 'role_id' => ['description' => 'The role ID to assign to the user. Currently, only `SystemGroupAdmin` (team administrator) is supported.', 'type' => 'string', 'required' => true, 'example' => 'SystemGroupAdmin', 'title' => ''], + 'manage_resource_type' => ['description' => 'The resource type to manage. Currently, only `RT_Group` (group) is supported.', 'type' => 'string', 'required' => true, 'example' => 'RT_Group', 'title' => ''], + 'manage_resource_id' => ['description' => 'The resource ID to manage. Currently, only a group ID is supported.', 'type' => 'string', 'required' => true, 'example' => '105***b82', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The queried domains.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried domain.'."\n", - '$ref' => '#/components/schemas/Domain', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - ], + 'properties' => [], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AssignRole', + 'description' => 'This operation assigns the team administrator role to a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'SearchDomains', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'DeleteDomain' => [ - 'summary' => 'Delete the domain', - 'path' => '/v2/domain/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'admin', - ], + 'AuditLogExport' => [ + 'summary' => 'Exports audit logs.', + 'path' => '/v2/audit_log/export', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bj1', - ], + 'query' => ['description' => 'Query audit logs by using a combination of the following fields:'."\n" + ."\n" + .'- `drive_id` (string): The drive ID.'."\n" + ."\n" + .'- `actor_id` (string): The actor ID.'."\n" + ."\n" + .'- `acted_at` (date): The operation time. The time must be in UTC and specified in the `YYYY-MM-DDTHH:mm:ss` format.'."\n" + ."\n" + .'- `action_type` (string): The operation type.', 'type' => 'string', 'required' => false, 'example' => 'acted_at > \'2025-03-10T16:00:00\' and acted_at < \'2025-03-17T15:59:59\'', 'title' => ''], + 'order_by' => ['description' => 'The sort field. You can sort by the operation time (`acted_at`). If this parameter is not specified, the results are sorted by operation time in descending order. Valid values:'."\n" + ."\n" + .'- `acted_at DESC`: Sorts by operation time in descending order.'."\n" + ."\n" + .'- `acted_at ASC`: Sorts by operation time in ascending order.', 'type' => 'string', 'required' => false, 'example' => 'acted_at DESC', 'title' => ''], + 'file_name' => ['description' => 'The name of the exported file. The name can be up to 1,024 characters in length. The default value is `log.csv`.', 'type' => 'string', 'required' => false, 'example' => '2024-01-log.csv', 'title' => ''], + 'language' => ['description' => 'The language of the exported file. Default: zh\\_CN (Chinese). Valid values:'."\n" + ."\n" + .'- `zh_CN`: Chinese'."\n" + ."\n" + .'- `en_US`: English', 'type' => 'string', 'required' => false, 'example' => 'zh_CN', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [], + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'async_task_id' => ['title' => 'Id of the request', 'description' => 'The ID of the asynchronous export task.', 'type' => 'string', 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d31****'], + ], + 'example' => '', + ], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AuditLogExport', + 'description' => 'In Drive and Photo Service for Developer, audit logging is a value-added feature. Before using this operation, review the <props="china">[billable items for value-added features](https://help.aliyun.com/zh/pds/drive-and-photo-service-dev/product-overview/billable-items-for-value-added-features)</props><props="intl">[billable items for value-added features](https://www.alibabacloud.com/help/document_detail/425220.html)</props>.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteDomain', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"async_task_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d31****\\"\\n}","type":"json"}]', ], 'Authorize' => [ - 'summary' => 'Requests permissions by using OAuth 2.0.', + 'summary' => 'Requests OAuth 2.0 authorization.', 'path' => '/v2/oauth/authorize', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'methods' => ['get'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/octet-stream', - ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/octet-stream'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'client_id', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID returned when the application was created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '47eUHhrzgWBvlLWj', - ], + 'schema' => ['description' => 'The client ID assigned when you create an app.', 'type' => 'string', 'required' => true, 'example' => '47eUHhrzgWBvlLWj', 'title' => ''], ], [ 'name' => 'redirect_uri', 'in' => 'query', - 'schema' => [ - 'description' => 'The callback URL specified when the application was created.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://www.aliyunpds.com/sign/callback', - ], + 'schema' => ['description' => 'The redirect URI specified when you created the app. This URI must be URL-encoded.', 'type' => 'string', 'required' => true, 'example' => 'https%3A%2F%2Fwww.aliyunpds.com%2Fsign%2Fcallback', 'title' => ''], ], [ 'name' => 'scope', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => 'The requested permissions. By default, all permissions are requested.'."\n", + 'description' => 'The requested permissions. If omitted, the request defaults to all permissions.', 'type' => 'array', - 'items' => [ - 'description' => 'The requested permissions. You can request only all permissions on the application. Set the value to all or leave the parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'items' => ['description' => 'Currently, you can only request all permissions for the app. Set this parameter to all or omit it.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'response_type', 'in' => 'query', - 'schema' => [ - 'description' => 'The format in which to return the response. Set the value to code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'code', - ], + 'schema' => ['description' => 'The response type. This parameter must be set to code.', 'type' => 'string', 'required' => true, 'example' => 'code', 'title' => ''], ], [ 'name' => 'state', 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined parameter to return in the callback URL after the requested permissions are granted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'customdata', - ], + 'schema' => ['description' => 'A value to maintain state between the request and callback. This value is returned to your redirect URI. We recommend using this parameter to prevent cross-site request forgery (CSRF) attacks.', 'type' => 'string', 'required' => false, 'example' => 'customdata', 'title' => ''], ], [ 'name' => 'login_type', 'in' => 'query', - 'schema' => [ - 'description' => 'The authentication method. Valid values:'."\n" - ."\n" - .'* default: all logon methods that are integrated on the default logon page provided by Drive and Photo Service.'."\n" - .'* ding: logs on by scanning a DingTalk QR code.'."\n" - .'* ding_sns: logs on by entering a DingTalk account and its password.'."\n" - .'* ram: logs on as an Alibaba Cloud Resource Access Management (RAM) user.'."\n" - .'* wechat: logs on by scanning a WeCom QR code.'."\n" - .'* wechat_app: logs on without authentication in WeCom.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default', - ], + 'schema' => ['description' => 'The authentication method. Valid values:'."\n" + ."\n" + .'- default (The default PDS login page that integrates all authentication methods)'."\n" + ."\n" + .'- ding (Log in on a PC by scanning a QR code with DingTalk)'."\n" + ."\n" + .'- ding\\_sns (Log in on a mobile phone with a DingTalk username and password)'."\n" + ."\n" + .'- ram (Log in with an Alibaba Cloud RAM user)'."\n" + ."\n" + .'- wechat (Log in with WeCom by scanning a QR code)'."\n" + ."\n" + .'- wechat\\_app (Single Sign-On (SSO) within the WeCom app)', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], ], [ 'name' => 'hide_consent', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to hide the consent page.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to hide the consent page. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 302 => [ 'headers' => [ 'location' => [ - 'schema' => [ - 'title' => '重定向的登陆页地址，用户需要在此页面完成认证', - 'type' => 'string', - ], + 'schema' => ['title' => '重定向的登陆页地址，用户需要在此页面完成认证', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'Authorize', - 'description' => 'For more information, see "OAuth 2.0 For Web Server Applications" at [OAuth 2.0 For Web Server Applications](https://www.alibabacloud.com/help/en/pds/drive-and-photo-service-dev/user-guide/oauth-2-0-access-process-for-web-server-applications) in User Guide.', - ], - 'Token' => [ - 'summary' => 'Generates an access token based on Open Authorization (OAuth) 2.0.', - 'path' => '/v2/oauth/token', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'description' => '<props="china">'."\n" + ."\n" + .'For details, see the [user guide](https://help.aliyun.com/document_detail/175894.html).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'For details, see the [user guide](https://www.alibabacloud.com/help/zh/pds/latest/oauth2-for-web-server-app?spm=a2c63.p38356.0.0.4cce4fccEyosuB).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'Batch' => [ + 'summary' => 'Combine multiple API calls into a single request to improve efficiency.', + 'path' => '/v2/batch', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'Anonymous' => [], + 'BearerToken' => [], + ], + [ + 'AK' => [], ], ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'grant_type', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The method that is used to generate an access token. Valid values:'."\n" - ."\n" - .'authorization_code: generates an access token by using the authorization code that is returned after the authorization process is complete.'."\n" - ."\n" - .'refresh_token: generates an access token by using the refresh token that is returned after the authorization process is complete.'."\n" - ."\n" - .'urn:ietf:params:oauth:grant-type:jwt-bearer: generates an access token by using a JWT assertion.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'refresh_token', - ], - ], - [ - 'name' => 'code', - 'in' => 'formData', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The authorization code in the redirect URI that is specified after the authorization process is complete. This parameter is required if grant_type is set to authorization_code.'."\n", - 'type' => 'string', + 'description' => 'Contains the request body parameters.', + 'type' => 'object', + 'properties' => [ + 'resource' => [ + 'description' => 'The resource type of the subrequests. Supported resource types include:'."\n" + ."\n" + .'- `file`: A file.'."\n" + ."\n" + .'- `drive`: A drive.'."\n" + ."\n" + .'- `user`: A user.'."\n" + ."\n" + .'- `group`: A group.'."\n" + ."\n" + .'- `membership`: A group membership.'."\n" + ."\n" + .'- `share_link`: A share link.'."\n" + ."\n" + .'- `async_task`: An asynchronous task.', + 'enumValueTitles' => ['share_link' => 'share link', 'file' => 'file', 'async_task' => 'asynchronous task', 'membership' => 'group membership', 'drive' => 'drive', 'user' => 'user', 'group' => 'group'], + 'type' => 'string', + 'required' => true, + 'example' => 'file', + 'title' => '', + ], + 'requests' => [ + 'description' => 'A collection of subrequests.'."\n" + ."\n" + .'A batch request can contain 1 to 100 subrequests.', + 'type' => 'array', + 'items' => [ + 'description' => 'A subrequest object.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The unique ID of the subrequest. This ID is used to correlate the subrequest with its response. IDs must be unique within a batch request.', 'type' => 'string', 'required' => true, 'example' => '93433894994ad2e1', 'title' => ''], + 'method' => [ + 'description' => 'The HTTP method of the subrequest. Supported methods include:'."\n" + ."\n" + .'- POST'."\n" + ."\n" + .'- GET'."\n" + ."\n" + .'- PUT'."\n" + ."\n" + .'- DELETE'."\n" + ."\n" + .'- HEAD', + 'enumValueTitles' => ['HEAD' => 'HEAD', 'DELETE' => 'DELETE', 'POST' => 'POST', 'GET' => 'GET', 'PUT' => 'PUT'], + 'type' => 'string', + 'required' => true, + 'example' => 'POST', + 'title' => '', + ], + 'url' => [ + 'description' => 'The API path of the subrequest. Supported paths include:'."\n" + ."\n" + .'- `/file/get`: Get file details.'."\n" + ."\n" + .'- `/file/update`: Update file information.'."\n" + ."\n" + .'- `/file/search`: Search for files.'."\n" + ."\n" + .'- `/file/copy`: Copy a file or folder.'."\n" + ."\n" + .'- `/file/move`: Move a file or folder.'."\n" + ."\n" + .'- `/file/delete`: Delete a file or folder.'."\n" + ."\n" + .'- `/file/get_download_url`: Get the download URL for a file.'."\n" + ."\n" + .'- `/file/get_share_link_download_url`: Get the download URL from a share link.'."\n" + ."\n" + .'- `/recyclebin/trash`: Move a file or folder to the recycle bin.'."\n" + ."\n" + .'- `/recyclebin/restore`: Restore a file or folder from the recycle bin.'."\n" + ."\n" + .'- `/file/put_usertags`: Set user tags.'."\n" + ."\n" + .'- `/file/delete_usertags`: Delete user tags.'."\n" + ."\n" + .'- `/drive/get`: Get drive information.'."\n" + ."\n" + .'- `/user/get`: Get user information.'."\n" + ."\n" + .'- `/group/get`: Get group information.'."\n" + ."\n" + .'- `/share_link/create`: Create a share link.'."\n" + ."\n" + .'- `/share_link/update`: Update a share link.'."\n" + ."\n" + .'- `/share_link/cancel`: Cancel a share link.'."\n" + ."\n" + .'- `/share_link/list`: List share links.'."\n" + ."\n" + .'- `/share_link/get`: Get share link information.'."\n" + ."\n" + .'- `/share_link/get_share_token`: Get a share token.'."\n" + ."\n" + .'- `/async_task/get`: Get asynchronous task information.', + 'enumValueTitles' => [ + '/file/copy' => 'Copy file or folder', '/file/get_share_link_download_url' => 'Get share link download URL', '/file/move' => 'Move file or folder', '/share_link/create' => 'Create share link', '/share_link/update' => 'Update share link', '/async_task/get' => 'Get asynchronous task information', '/drive/get' => 'Get drive information', '/group/get' => 'Get group information', '/share_link/list' => 'List share links', '/file/delete' => 'Delete file or folder', + '/share_link/get' => 'Get share link information', '/file/get' => 'Get file details', '/file/get_download_url' => 'Get file download URL', '/recyclebin/restore' => 'Restore file or folder', '/file/update' => 'Update file information', '/recyclebin/trash' => 'Move to recycle bin', '/file/search' => 'Search files', '/user/get' => 'Get user information', '/share_link/get_share_token' => 'Get share token', '/share_link/cancel' => 'Cancel share link', + ], + 'type' => 'string', + 'required' => true, + 'example' => '/file/get', + 'title' => '', + ], + 'body' => [ + 'description' => 'The request body for the subrequest. For details, refer to the documentation for the specific API operation.'."\n" + ."\n" + .'If you specify the `body` parameter, you must also set the `Content-Type` request header to `application/json`.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The request body of the subrequest.', 'type' => 'any', 'example' => '{"domain_id":"1","drive_id":"1"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'headers' => [ + 'description' => 'The request headers for the subrequest.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The request headers of the subrequest.', 'type' => 'string', 'example' => '{"Content-Type":"application/json"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '0045157fa8e24f4f9a0d9e3ff158c1e0', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'redirect_uri', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The redirect URI that is specified when you initiate the authorization request. This parameter is required if grant_type is set to authorization_code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://aliyun.com/pds'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'responses' => [ + 'description' => 'A collection of responses to the subrequests.', + 'type' => 'array', + 'items' => [ + 'description' => 'A response object for a single subrequest.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the subrequest that this response corresponds to.', 'type' => 'string', 'example' => '93433894994ad2e1', 'title' => ''], + 'status' => ['description' => 'The HTTP status code of the subrequest. For details, refer to the documentation for the specific API operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'body' => [ + 'description' => 'The response body of the subrequest. For details, refer to the documentation for the specific API operation.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The response body of the subrequest.', 'type' => 'any', 'example' => '{"domain_id":"1","drive_id":"1","file_id":"9520943DC264"}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'Batch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + '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"}]', + ], + 'CancelAssignRole' => [ + 'summary' => 'Currently, this operation only revokes the team administrator role.', + 'path' => '/v2/role/cancel_assign', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], + 'security' => [ [ - 'name' => 'client_id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The AppId of the application that is created in the Drive and Photo Service console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1Zu***flH', - ], + 'AK' => [], ], [ - 'name' => 'client_secret', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The AppSecret of the application that is created in the Drive and Photo Service console. This parameter is required if the application is of the WebServer type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '80D***3i5'."\n", - ], + 'BearerToken' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'refresh_token', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The refresh token that is used to refresh the access token. This parameter is required if grant_type is set to refresh_token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '399623e13353490391266c7d48a13ed1', - ], + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => ['description' => 'A short description of the struct.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], [ - 'name' => 'assertion', - 'in' => 'formData', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The JWT assertion that is signed by using the JWT private key. The JWT assertion contains the information about the user to be authorized and the authorization parameters. For more information about the structure of the JWT assertion, see JWTPayload. This parameter is required if grant_type is set to urn:ietf:params:oauth:grant-type:jwt-bearer.'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'identity' => ['description' => 'The identity whose role is to be revoked. Currently, this must be a user.', 'required' => true, '$ref' => '#/components/schemas/Identity', 'title' => '', 'example' => ''], + 'role_id' => ['description' => 'The ID of the role to revoke. This must be set to `SystemGroupAdmin` (team administrator).', 'type' => 'string', 'required' => true, 'example' => 'SystemGroupAdmin', 'title' => ''], + 'manage_resource_type' => ['description' => 'The resource type of the managed resource. This must be set to `RT_Group` (team).', 'type' => 'string', 'required' => true, 'example' => 'RT_Group', 'title' => ''], + 'manage_resource_id' => ['description' => 'The ID of the managed resource. This must be a Group ID.', 'type' => 'string', 'required' => true, 'example' => '105***b82', 'title' => ''], + ], 'required' => false, - 'example' => 'ey***asd'."\n", + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'headers' => [], + 204 => [ 'schema' => [ - 'description' => 'The information about the access token.'."\n", - '$ref' => '#/components/schemas/Token', + 'type' => 'object', + 'properties' => [], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'Token', - 'description' => 'For more information about how to access Drive and Photo Service from a web server application by using OAuth 2.0, visit [OAuth 2.0 For Web Server Applications](https://www.alibabacloud.com/help/zh/pds/drive-and-photo-service-dev/user-guide/oauth-2-0-access-process-for-web-server-applications).'."\n" - ."\n" - .'For more information about how to access Drive and Photo Service by using a JSON Web Token (JWT) application, visit [Access process for JWT applications](https://www.alibabacloud.com/help/zh/pds/drive-and-photo-service-dev/user-guide/access-process-for-jwt-applications).', - ], - 'GetLinkInfoByUserId' => [ - 'summary' => 'Queries the information about a user based on the user ID.', - 'path' => '/v2/account/get_link_info_by_user_id', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CancelAssignRole', + 'description' => 'Currently, this operation only revokes the team administrator role.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'CancelShareLink' => [ + 'summary' => 'Cancels a share link.', + 'path' => '/v2/share_link/cancel', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -5096,272 +2399,183 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], + 'share_id' => ['description' => 'The ID of the share link.', 'type' => 'string', 'required' => true, 'example' => '7JQX1FswpQ8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'headers' => [], + 204 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'items' => [ - 'title' => 'items', - 'description' => 'The information about the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user.'."\n", - '$ref' => '#/components/schemas/AccountLinkInfo', - ], - ], + '_' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'CancelShareLink', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'GetLinkInfoByUserId', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'LinkAccount' => [ - 'summary' => 'Associates an account with a user.', - 'path' => '/v2/account/link', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ClearRecyclebin' => [ + 'path' => '/v2/recyclebin/clear', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'The ID of the user with which you want to associate an account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - 'type' => [ - 'description' => 'The account type. Valid values:'."\n" - ."\n" - .'* mobile: a mobile number.'."\n" - .'* email: an email address.'."\n" - .'* ding: a DingTalk account.'."\n" - .'* ram: an Alibaba Cloud Resource Access Management (RAM) user.'."\n" - .'* wechat: a WeCom account.'."\n" - .'* ldap: a Lightweight Directory Access Protocol (LDAP) account.'."\n" - .'* custom: a custom account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ding', - ], - 'identity' => [ - 'description' => 'The unique identifier of the account, such as a mobile number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'eyy***', - ], - 'extra' => [ - 'description' => 'The additional information about the unique identifier of the account. For example, if type is set to mobile, set the value of extra to a country code. For example, a value of 86 specifies a mobile number in the Chinese mainland. If you do not specify this parameter, 86 is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '86', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The information about the access token of the user.'."\n", - '$ref' => '#/components/schemas/Token', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'async_task_id' => ['description' => 'The asynchronous task ID.'."\n" + ."\n" + .'Call the GetAsyncTask operation with this ID to query the task\'s status.', 'type' => 'string', 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', 'title' => ''], + ], + 'example' => '', ], ], ], - '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' => 'LinkAccount', - ], - 'GetLinkInfo' => [ - 'summary' => 'Queries the information about an account.', - 'path' => '/v2/account/get_link_info', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'api', + 'title' => 'ClearRecyclebin', + 'summary' => 'Permanently deletes all files and folders in the recycle bin.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', + ], + 'CompleteFile' => [ + 'summary' => 'Completes a file upload.', + 'path' => '/v2/file/complete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => 'The account type. Valid values:'."\n" - ."\n" - .'* mobile: a mobile number.'."\n" - .'* email: an email address.'."\n" - .'* ding: a DingTalk account.'."\n" - .'* ram: an Alibaba Cloud Resource Access Management (RAM) user.'."\n" - .'* wechat: a WeCom account.'."\n" - .'* ldap: a Lightweight Directory Access Protocol (LDAP) account.'."\n" - .'* custom: a custom account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mobile', - ], - 'identity' => [ - 'description' => 'The unique identifier of the account, such as a mobile number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '130***', - ], - 'extra' => [ - 'description' => 'The additional information about the unique identifier of the account. For example, if type is set to mobile, set the value of extra to a country code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'required' => true, 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'crc64_hash' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], - 'schema' => [ - 'description' => 'The information about the account.'."\n", - '$ref' => '#/components/schemas/AccountLinkInfo', - ], + 'schema' => ['description' => 'The returned file information.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'CompleteFile', + 'description' => 'For usage, see the best practices for [file upload](~~175888~~).'."\n" + ."\n" + .'During a file upload, you incur storage costs for uploaded file parts. These parts are retained until the upload is completed, but for no more than 10 days, after which they expire and are automatically deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'GetLinkInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n}","type":"json"}]', ], - 'UnLinkAccount' => [ - 'summary' => 'Unlink Account Binding', - 'path' => '/v2/account/unlink', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'CopyFile' => [ + 'summary' => 'Copies a file or directory.', + 'path' => '/v2/file/copy', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -5370,263 +2584,246 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of the struct', - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'Request body', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'User identifier', - 'type' => 'string', - 'required' => true, - 'example' => 'uid1', - ], - 'type' => [ - 'description' => 'Account type'."\n" - ."\n" - .'mobile: Phone number'."\n" - ."\n" - .'email: Email address'."\n" - ."\n" - .'ding: DingTalk'."\n" - ."\n" - .'ram: Alibaba Cloud RAM User'."\n" - ."\n" - .'wechat: WeCom'."\n" - ."\n" - .'ldap: LDAP account'."\n" - ."\n" - .'custom: Custom account', - 'type' => 'string', - 'required' => true, - 'example' => 'mobile', - ], - 'identity' => [ - 'description' => 'Unique identifier of the account, such as a phone number', - 'type' => 'string', - 'required' => true, - 'example' => '139****'."\n", - ], - 'extra' => [ - 'description' => 'Additional information for the unique account identifier. For example, when the account is a phone number, this field should be filled with the area code of the phone, such as 86 for Mainland China. If not provided, it defaults to 86.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'share_id' => ['description' => 'The share ID. If you access a file through a share, include the `x-share-token` header for authentication and specify this parameter. In this case, the `drive_id` parameter is ignored. Alternatively, authenticate with an AccessKey pair or an access token and specify the `drive_id` parameter. You must specify either the `share_id` or `drive_id` parameter.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID or folder ID.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], + 'to_drive_id' => ['description' => 'The ID of the destination drive. By default, this parameter is set to the value of `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'to_parent_file_id' => ['description' => 'The ID of the destination parent folder. To copy a file or folder to the root directory, set this parameter to `root`.', 'type' => 'string', 'required' => true, 'example' => '6520943DC261', 'title' => ''], + 'auto_rename' => ['description' => 'Specifies whether to automatically rename the file if a file with the same name already exists in the destination folder. Default: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [], + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the new file or folder.', 'type' => 'string', 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', 'title' => ''], + 'async_task_id' => ['description' => 'The asynchronous task ID.'."\n" + ."\n" + .'This parameter is returned only for folder copy operations. Copying a folder is an asynchronous task. Use this ID with the GetAsyncTask operation to query the task status.', 'type' => 'string', 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'CopyFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'Unlink Account', - 'translator' => 'machine', + '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"}]', ], - 'CreateGroup' => [ - 'summary' => 'Creates a group.', - 'path' => '/v2/group/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'CreateCustomizedStory' => [ + 'summary' => 'Creates a customized story. Unlike a recommended story, you specify the files in a customized story.', + 'path' => '/v2/image/create_customized_story', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_name' => [ - 'description' => 'The name of the group. The name must be 1 to 128 characters in length.'."\n", - 'type' => 'string', + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_type' => ['description' => 'The story type. This value is user-defined.', 'type' => 'string', 'required' => true, 'example' => 'user_created', 'title' => ''], + 'story_sub_type' => ['description' => 'The story subtype. This value is user-defined.', 'type' => 'string', 'required' => true, 'example' => 'user_created', 'title' => ''], + 'story_name' => ['description' => 'The story name. The name must not exceed 1,024 bytes.', 'type' => 'string', 'required' => true, 'example' => 'test_name', 'title' => ''], + 'story_cover' => [ + 'description' => 'The file to use as the story cover. This file must be in the story file list.', + 'type' => 'object', + 'properties' => [ + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'revision_id' => ['description' => 'The ID of the revision.', 'type' => 'string', 'required' => false, 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', 'title' => ''], + ], 'required' => true, - 'example' => 'test group', - ], - 'description' => [ - 'description' => 'The description of the group. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test group description', + 'title' => '', + 'example' => '', ], - 'is_root' => [ - 'description' => 'Specifies whether the group is a root group. A root group cannot be added to any other group. In most cases, a root group is the top-level organization in the organizational structure.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'story_files' => [ + 'description' => 'The list of files to include in the story.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'revision_id' => ['description' => 'The ID of the revision.', 'type' => 'string', 'required' => false, 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], - 'parent_group_id' => [ - 'description' => 'The ID of the parent group to which the group is added. If this parameter is specified, the system automatically adds the group to the specified parent group after the group is created.'."\n", - 'type' => 'string', + 'custom_labels' => [ + 'description' => 'The custom labels. You can specify a maximum of 20 labels.', + 'type' => 'object', + 'deprecated' => true, 'required' => false, - 'example' => '2e43ec8427dd45f19431b7504649a1b3', + 'additionalProperties' => ['description' => 'The value of the custom label.', 'type' => 'string', 'example' => 'label_value', 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the created group.'."\n", - '$ref' => '#/components/schemas/Group', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The ID of the story.', 'type' => 'string', 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + ], + 'example' => '', ], ], ], - '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' => 'CreateGroup', - ], - 'UpdateGroup' => [ - 'summary' => 'Modifies the information about a group.', - 'path' => '/v2/group/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a Custom Story'."\n", + 'description' => '**Before calling this operation, ensure you understand the billing methods and [pricing](~~425220~~) of PDS**.'."\n" + ."\n" + .'To use this feature, you must enable the image processing value-added service. Story-related APIs are free for a limited time.'."\n" + ."\n" + .'You can create a customized story by providing a list of files. You can freely define the story type and story subtype.'."\n" + ."\n" + .'><notice>If you specify a story cover, you must include the cover file in the story file list. Otherwise, an error is returned.></notice>'."\n" + .'><notice>You can include only images in the customized story file list.></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + ], + 'CreateDomain' => [ + 'summary' => 'Creates a domain.', + 'path' => '/v2/domain/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], 'security' => [ [ - 'BearerToken' => [], - ], - [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The ID of the group that you want to modify.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2e43ec8427dd45f19431b7504649a1b4', - ], - 'group_name' => [ - 'description' => 'The name of the group after modification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test group', - ], - 'description' => [ - 'description' => 'The description of the group after modification.'."\n", + 'parent_domain_id' => ['description' => 'The ID of the parent domain. Set this parameter to create a child domain. This parameter is optional. For information about implementing custom operations, contact PDS customer service.', 'type' => 'string', 'required' => false, 'example' => 'bj1', 'title' => ''], + 'domain_name' => ['description' => 'The name of the domain.', 'type' => 'string', 'required' => true, 'example' => 'cloud drive', 'title' => ''], + 'description' => ['description' => 'The description of the domain.', 'type' => 'string', 'required' => false, 'example' => 'cloud drive dev', 'title' => ''], + 'init_drive_enable' => ['description' => 'Specifies whether to enable a default drive for users. If set to `true`, a drive is automatically provisioned for each user upon their first login. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'init_drive_size' => ['description' => 'This parameter is required if `init_drive_enable` is set to `true`. The size of the default drive for new users, in bytes. The default value is `0`, which creates a drive with zero capacity, preventing users from uploading files. To provide initial storage, you must set this parameter. A value of `-1` indicates an unlimited size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1073741824', 'title' => ''], + 'user_count_quota' => ['description' => 'The user count quota for the domain. This specifies the maximum number of users that can be created. A value of `0` indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + 'size_quota' => ['description' => 'The total storage quota for the domain, in bytes. This value represents the combined storage limit for all drives within the domain. A value of `0` indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1099511627776', 'title' => ''], + 'store_redundancy_type' => [ + 'description' => 'The storage redundancy type. Valid values:'."\n" + ."\n" + .'- `LRS`: Locally Redundant Storage'."\n" + ."\n" + .'- `ZRS`: Zone-Redundant Storage', 'type' => 'string', + 'enum' => [], 'required' => false, - 'example' => 'test group description', + 'example' => 'LRS', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The information about the group after modification.'."\n", - '$ref' => '#/components/schemas/Group', - ], + 'schema' => ['description' => 'The details of the created domain.', '$ref' => '#/components/schemas/Domain', 'title' => '', 'example' => ''], ], ], - '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', - ], - 'GetGroup' => [ - 'summary' => 'Queries the information about a group.', - 'path' => '/v2/group/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"bj1\\",\\n \\"domain_id\\": \\"bj2\\",\\n \\"domain_name\\": \\"pdsdomain\\",\\n \\"description\\": \\"my domain\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 1073741824,\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"size_quota\\": 1099511627776,\\n \\"size_quota_used\\": 1099511627776,\\n \\"user_count_quota\\": 50,\\n \\"status\\": 1,\\n \\"used_size\\": 1099511627776,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"deny\\",\\n \\"except_app_id_list\\": [\\n \\"8ovxCTRUDdbpVWBP\\"\\n ]\\n },\\n \\"sharable\\": false,\\n \\"data_hash_name\\": \\"sha1\\",\\n \\"store_redundancy_type\\": \\"LRS\\"\\n}","type":"json"}]', + 'title' => 'CreateDomain', + 'description' => 'Use the parent-child domain feature to implement custom operations on PDS or apply fine-grained controls to tenants. For more information, contact the official DingTalk group: 23146118.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateDrive' => [ + 'summary' => 'Create a drive.', + 'path' => '/v2/drive/create', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -5635,64 +2832,110 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The group ID.'."\n", + 'drive_name' => ['description' => 'The name of the drive. The name can be up to 128 characters long.', 'type' => 'string', 'example' => 'My personal space', 'required' => true, 'maxLength' => 1024, 'minLength' => 1, 'title' => ''], + 'owner' => ['description' => 'The ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '3b3d7245c159488da17d081ad6c64687', 'title' => ''], + 'owner_type' => [ + 'description' => 'The owner type. Valid values:'."\n" + ."\n" + .'user<br>group<br>', + 'enumValueTitles' => ['user' => 'user', 'group' => 'group'], 'type' => 'string', 'required' => true, - 'example' => '2e43ec8427dd45f19431b7504649a1b1', + 'enum' => ['user', 'group'], + 'example' => 'user', + 'title' => '', + ], + 'description' => ['description' => 'The description. The description can be up to 1024 characters long.', 'type' => 'string', 'example' => 'VIP space', 'maxLength' => 1024, 'required' => false, 'title' => ''], + 'drive_type' => [ + 'description' => 'The drive type. Currently, only `normal` is supported.', + 'enumValueTitles' => ['normal' => 'normal'], + 'type' => 'string', + 'default' => 'normal', + 'enum' => [], + 'required' => false, + 'example' => 'normal', + 'title' => '', ], + 'status' => [ + 'description' => 'The status. Valid values:'."\n" + ."\n" + .'enabled: The drive is available.<br>disabled: The drive is unavailable.<br>'."\n" + ."\n" + .'The default value is `enabled`.', + 'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'], + 'type' => 'string', + 'default' => 'enabled', + 'enum' => ['enabled', 'disabled'], + 'required' => false, + 'example' => 'enabled', + 'title' => '', + ], + 'total_size' => ['description' => 'The total size of the drive in bytes. By default, the size is unlimited.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', 'title' => ''], + 'default' => ['description' => 'Specifies whether the drive is the default drive. The default value is `false`.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the group.'."\n", - '$ref' => '#/components/schemas/Group', + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'drive_name' => ['description' => 'The drive name.', 'type' => 'string', 'example' => 'My personal space', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'VIP space', 'title' => ''], + 'owner' => ['description' => 'The owner ID.', 'type' => 'string', 'example' => '3b3d7245c159488da17d081ad6c64687'."\n", 'title' => ''], + 'owner_type' => ['description' => 'The owner type.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'drive_type' => ['description' => 'The drive type.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'used_size' => ['description' => 'The used space in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'total_size' => ['description' => 'The total size of the drive in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'created_at' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-08-14T03:14:28.109Z', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], + ], + 'example' => '', ], ], ], - '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', - ], - 'ListGroup' => [ - 'summary' => 'Queries groups.', - 'path' => '/v2/group/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"My personal space\\",\\n \\"description\\": \\"VIP space\\",\\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' => 'Create Space', + 'description' => 'Before creating a drive, ensure that the specified user or group has not been assigned a drive.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'CreateFile' => [ + 'summary' => 'Create a file or folder.', + 'path' => '/v2/file/create', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -5701,88 +2944,173 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'name' => ['description' => 'The file name. The name must be UTF-8 encoded, up to 1,024 bytes in length, and cannot contain the / character.', 'type' => 'string', 'required' => true, 'example' => 'a.txt', 'maxLength' => 1024, 'minLength' => 1, 'title' => ''], + 'type' => [ + 'description' => 'The file type. Valid values are:'."\n" + ."\n" + .'`file`: A file.<br>`folder`: A folder.<br>', + 'type' => 'string', + 'required' => true, + 'enum' => ['file', 'folder'], + 'title' => '', + 'example' => 'file', + ], + 'parent_file_id' => ['description' => 'The ID of the parent directory. Set this parameter to `root` to upload the file to the root directory.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'fileid1'], + 'drive_id' => ['description' => 'The drive ID. This parameter is required unless you upload the file via a share link.', 'type' => 'string', 'example' => '1', 'pattern' => '^[0-9]*$', 'title' => '', 'required' => false], + 'share_id' => ['description' => 'The share ID. This parameter is required when you upload a file via a share link.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7JQX1FswpQ8'], + 'size' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1024'], + 'content_type' => ['description' => 'The content type of the file. The default value is `application/octet-stream`.<props="china"> For a list of common content types, see the Object Storage Service (OSS) topic [How do I set the Content-Type (MIME) of an object?](https://help.aliyun.com/document_detail/39522.htm?spm=a2c4g.11186623.0.0.5a0b7dbb1TPnWF#concept-5041)</props>', 'type' => 'string', 'example' => 'application/json', 'title' => '', 'required' => false], + 'part_info_list' => [ + 'description' => 'The part list. You can specify a maximum of 10,000 parts. If this parameter is omitted, the file is treated as a single-part upload.', + 'type' => 'array', + 'items' => [ + 'description' => 'A file part.', + 'type' => 'object', + 'properties' => [ + 'part_number' => ['description' => 'The part number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'parallel_sha1_ctx' => [ + 'description' => 'The SHA-1 context of all data preceding this part. This parameter is valid only for parallel uploads.', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'description' => 'The first five 32-bit variables of the SHA-1 context for all data preceding this part. This parameter is valid only for parallel uploads.', + 'type' => 'array', + 'items' => ['description' => 'One of the first five 32-bit variables of the SHA-1 context for all data preceding this part.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'part_offset' => ['description' => 'The total length, in bytes, of all data preceding this part. The value must be a multiple of 64. This parameter is valid only for parallel uploads.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'content_md5' => ['description' => 'The MD5 hash of the part. This parameter is required if you want to verify the integrity of the part during upload.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'ASKJDJSKDJJSJDJS', 'title' => ''], + 'content_type' => ['description' => 'The content type of the part.', 'type' => 'string', 'deprecated' => false, 'example' => 'application/json', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '100', + 'title' => '', + 'example' => '', ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", + 'user_tags' => [ + 'title' => '', + 'description' => 'The user-defined tags. You can specify a maximum of 1,000 tags.', + 'type' => 'array', + 'items' => ['description' => 'A user-defined tag.', '$ref' => '#/components/schemas/UserTag', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', + ], + 'hidden' => ['description' => 'Specifies whether to hide the file or folder. The default value is `false`.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + 'description' => ['description' => 'The file description, with a maximum length of 1,024 characters. By default, this parameter is empty.', 'type' => 'string', 'example' => 'Team file', 'maxLength' => 1024, 'title' => '', 'required' => false], + 'content_hash' => ['description' => 'The hash value of the file content. The value is calculated using the algorithm specified by `content_hash_name`.', 'type' => 'string', 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8941B', 'title' => '', 'required' => false], + 'content_hash_name' => [ + 'description' => 'The name of the hash algorithm used to calculate `content_hash`. Currently, only `sha1` is supported.', 'type' => 'string', + 'example' => 'sha1', + 'enum' => ['sha1'], + 'title' => '', 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', ], + 'pre_hash' => ['description' => 'The SHA-1 hash of the first 1 KB of the file. This parameter enables the rapid upload pre-check feature. This feature allows the client to avoid calculating the full file hash for a rapid upload attempt if the pre-check fails.', 'type' => 'string', 'example' => '7C4A8D09CA3762AF61E59520943DC26494F89411', 'required' => false, 'title' => ''], + 'check_name_mode' => [ + 'description' => 'The policy for handling file name conflicts. Valid values are:'."\n" + ."\n" + .'`ignore`: Allows files with the same name.'."\n" + ."\n" + .'`auto_rename`: Automatically renames the file if a file with the same name already exists. By default, the current timestamp is appended to the file name, for example, `xxx_20060102_150405`.'."\n" + ."\n" + .'`refuse`: Rejects the request if a file with the same name already exists and returns the existing file\'s details.'."\n" + ."\n" + .'The default value is `ignore`.', + 'enumValueTitles' => ['refuse' => 'refuse', 'auto_rename' => 'auto\\_rename', 'ignore' => 'ignore'], + 'type' => 'string', + 'example' => 'ignore', + 'enum' => ['ignore', 'auto_rename', 'refuse'], + 'title' => '', + 'required' => false, + ], + 'file_id' => ['description' => 'The file ID. This parameter is required to overwrite an existing file.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '9520943DC264'], + 'local_created_at' => ['description' => 'The local creation time of the file. The time must be in `yyyy-MM-ddTHH:mm:ssZ` format (UTC). By default, this parameter is empty.', 'type' => 'string', 'example' => '2023-10-04T14:30:00Z', 'title' => '', 'required' => false], + 'local_modified_at' => ['description' => 'The local modification time of the file. The time must be in `yyyy-MM-ddTHH:mm:ssZ` format (UTC). By default, this parameter is empty.', 'type' => 'string', 'example' => '2023-10-04T14:30:00Z', 'title' => '', 'required' => false], + 'parallel_upload' => ['description' => 'Set to `true` to enable the parallel upload of parts.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + 'upload_type' => ['type' => 'string', 'example' => 'multipart', 'default' => 'multipart', 'description' => '', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The information about the groups.'."\n", + 'parent_file_id' => ['description' => 'The ID of the parent directory.', 'type' => 'string', 'title' => '', 'example' => 'fileid5'], + 'part_info_list' => [ + 'title' => '', + 'description' => 'A list of details for each upload part.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a group.'."\n", - '$ref' => '#/components/schemas/Group', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + 'items' => ['description' => 'The details of an upload part.', '$ref' => '#/components/schemas/UploadPartInfo', 'title' => '', 'example' => ''], + 'example' => '', ], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'title' => '', 'example' => 'uploadid1'], + 'rapid_upload' => ['description' => 'Indicates whether rapid upload was used.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'type' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'file', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'title' => '', 'example' => 'fileid1'], + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'title' => '', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'file_name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'a.txt'], + 'status' => ['description' => 'The file status.', 'type' => 'string', 'title' => '', 'example' => 'uploading'], + 'exist' => ['description' => 'Indicates whether the file exists.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], + 'example' => '', ], ], ], - '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' => 'ListGroup', - ], - 'DeleteGroup' => [ - 'summary' => 'Deletes groups. Before you delete a group, make sure that no other groups or users exist in the group. Otherwise, the group fails to be deleted.', - 'path' => '/v2/group/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_file_id\\": \\"fileid5\\",\\n \\"part_info_list\\": [\\n {\\n \\"part_number\\": 1,\\n \\"part_size\\": 1024,\\n \\"upload_url\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\",\\n \\"internal_upload_url\\": \\"https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\\\n\\",\\n \\"etag\\": \\"\\\\\\"0CC175B9C0F1B6A831C399E269772661\\\\\\"\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 10240\\n },\\n \\"upload_form_info\\": {\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\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' => 'CreateFile', + 'description' => 'For best practices on creating files, see [File upload](~~175888~~).'."\n" + ."\n" + .'During a file upload, file chunks incur storage costs. These chunks have a 10-day retention period and are automatically deleted either when the upload is complete or after this period.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'CreateGroup' => [ + 'summary' => 'Creates a group.', + 'path' => '/v2/group/create', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -5791,67 +3119,52 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'g123', - ], + 'group_name' => ['description' => 'The group name. The name must be 1 to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test group', 'title' => ''], + 'description' => ['description' => 'The description of the group. The maximum length is 1,024 characters.', 'type' => 'string', 'required' => false, 'example' => 'test group description', 'title' => ''], + 'is_root' => ['description' => 'Specifies whether to create a root group. A root group cannot be added to any other group and is typically used as the top-level entity in an organizational structure.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'parent_group_id' => ['description' => 'The ID of the parent group. If specified, the new group is added to this parent group on creation.', 'type' => 'string', 'required' => false, 'example' => '2e43ec8427dd45f19431b7504649a1b3', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [], - ], + 200 => [ + 'schema' => ['description' => 'Details of the created group.', '$ref' => '#/components/schemas/Group', 'title' => '', 'example' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteGroup', - ], - 'AddGroupMember' => [ - 'summary' => 'Adds a member to a group.', - 'path' => '/v2/group/add_member', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'CreateGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"group_id\\": \\"b45c0c0c373c41ec9ebb5c85a025a08f\\",\\n \\"group_name\\": \\"test group\\",\\n \\"description\\": \\"created by system\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + ], + 'CreateIdentityToBenefitPkgMapping' => [ + 'summary' => 'Creates a mapping between an entity and a benefit package. This operation lets you assign a benefit package to a user.', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/create', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -5860,87 +3173,152 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], '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, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The ID of the destination group to which the member is added.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3e5***2c2', - ], - 'member_type' => [ - 'description' => 'The type of the member. Set the value to user. When you create a group, you can directly add the group to a parent group.'."\n" - ."\n" - .'* user'."\n" + 'identity_type' => [ + 'description' => 'The type of the entity.'."\n" ."\n" - .'Note: A group can be added to only one group. A user can be added to multiple groups.', + .'To manage benefits for a user, set this parameter to `user`.', 'type' => 'string', 'required' => true, + 'enum' => ['user'], 'example' => 'user', + 'title' => '', ], - 'member_id' => [ - 'description' => 'The member ID. If member_type is set to user, set this parameter to a user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2e4***1b1', - ], + 'identity_id' => ['description' => 'The unique identifier for the entity.'."\n" + ."\n" + .'To manage benefits for a user, provide the user ID.', 'type' => 'string', 'required' => true, 'example' => 'user123', 'title' => ''], + 'benefit_pkg_id' => ['description' => 'The unique identifier for the benefit package.', 'type' => 'string', 'required' => true, 'example' => '40cb7794c9294', 'title' => ''], + 'amount' => ['description' => 'The quantity of the benefit package.'."\n" + ."\n" + .'This parameter applies only to resource-type benefit packages. It is optional and defaults to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'expire_time' => ['description' => 'The expiration time of the benefit package. This is a Unix timestamp representing the number of milliseconds that have elapsed since 00:00:00 on January 1, 1970, UTC.'."\n" + ."\n" + .'If this parameter is not specified, the benefit package never expires.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1633167071000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ - 'headers' => [], + 200 => [], + ], + 'title' => 'CreateIdentityToBenefitPkgMapping', + 'description' => 'If you are building services for many users using PDS, you can use benefit packages to manage user access to features and quotas. For more information, contact our official DingTalk group at 23146118.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'CreateShareLink' => [ + 'summary' => 'Creates a share link.', + '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' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', - 'properties' => [], + 'properties' => [ + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'share_all_files' => ['description' => 'Set to `true` to share all files in the drive.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'file_id_list' => [ + 'description' => 'A list of 1 to 100 file IDs to share. This parameter is required when `share_all_files` is `false` and is ignored when it is `true`.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the file to share.', 'type' => 'string', 'required' => false, 'example' => '9520943DC264', 'title' => ''], + 'required' => false, + 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', + 'title' => '', + ], + 'user_id' => ['description' => 'The user ID. This parameter is required when authenticating the request with an AccessKey (AK).', 'type' => 'string', 'required' => false, 'example' => 'u123', 'title' => ''], + 'share_pwd' => ['description' => 'The password for the share link. It must be between 0 and 64 printable ASCII characters. If this parameter is not set or is an empty string, the share link does not require a password.', 'type' => 'string', 'required' => false, 'example' => 'abcF123x', 'title' => ''], + 'expiration' => ['description' => 'The expiration time for the share link, specified in RFC 3339 format (for example, "2020-06-28T11:33:00.000+08:00"). To create a share link that never expires, set this parameter to an empty string ("").', 'type' => 'string', 'required' => false, 'example' => '2020-06-28T11:33:00.000+08:00', 'title' => ''], + 'description' => ['description' => 'A description for the share link, 0 to 1,024 characters in length.', 'type' => 'string', 'example' => 'Lecture collection', 'required' => false, 'title' => ''], + 'share_name' => ['description' => 'The share name. The length must be between 0 and 128 characters. If not specified, the system uses the name of the file corresponding to the first ID in `file_id_list`.', 'type' => 'string', 'example' => 'LectureRoom-1.MP4', 'required' => false, 'title' => ''], + 'disable_preview' => ['description' => 'Set to `true` to prevent users from previewing the shared files.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'disable_save' => ['description' => 'Set to `true` to prevent users from saving the shared files to their own drive.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'disable_download' => ['description' => 'Set to `true` to prevent users from downloading the shared files.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'preview_limit' => ['description' => 'The maximum number of times users can preview the shared files. The value must be 0 or greater. A value of 0 means there is no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'save_limit' => ['description' => 'The maximum number of times users can save the shared files. The value must be 0 or greater. A value of 0 means there is no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'download_limit' => ['description' => 'The maximum number of times users can download the shared files. The value must be 0 or greater. A value of 0 means there is no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'require_login' => ['description' => 'If `true`, users must log in to access the share link.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'office_editable' => ['description' => 'Set to `true` to allow online editing of the shared documents.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'creatable' => ['description' => 'Set to `true` to allow users to create files in shared folders. Setting this to `true` also requires specifying `creatable_file_id_list`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'creatable_file_id_list' => [ + 'description' => 'A list of folder IDs where users can upload files.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a folder.', 'type' => 'string', 'required' => false, 'example' => '9520943DC264', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'AddGroupMember', - ], - 'RemoveGroupMember' => [ - 'summary' => 'Removes a member from a group.', - 'path' => '/v2/group/remove_member', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The created share link object.', '$ref' => '#/components/schemas/ShareLink', 'title' => '', 'example' => ''], + ], ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"share_pwd\\": \\"abcF123x\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id_list\\": [\\n \\"[\\\\\\"xx\\\\\\"]\\"\\n ],\\n \\"expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"expired\\": false,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"videos\\",\\n \\"share_name\\": \\"video-1.MP4\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"status\\": \\"enabled\\",\\n \\"preview_count\\": 10,\\n \\"save_count\\": 2,\\n \\"download_count\\": 5,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 1,\\n \\"access_count\\": 4,\\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 \\"share_all_files\\": true,\\n \\"save_download_limit\\": 100,\\n \\"office_editable\\": true\\n}","type":"json"}]', + 'title' => 'Create Share ', + 'description' => 'A share link allows anonymous users to access one or more files from a user\'s drive. The permissions for the share link determine the level of access.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'CreateSimilarImageClusterTask' => [ + 'path' => '/v2/image/create_similar_image_cluster_task', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -5949,87 +3327,74 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create', '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' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The ID of the group from which you want to remove a member.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3e5***2c2', - ], - 'member_type' => [ - 'description' => 'The type of the member that you want to remove from the group. Only common users can be removed. If you want to remove all members from a group, you can directly delete the group. Valid value:'."\n" - ."\n" - .'* user'."\n" - ."\n" - .'Note: A group can be a member of only one group. It cannot be a member of multiple groups. A user can be a member of multiple groups.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - ], - 'member_id' => [ - 'description' => 'The ID of the member. If member_type is set to user, set this parameter to the ID of the corresponding user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2e4***1b1', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ - 'headers' => [], + 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', - 'properties' => [], + 'properties' => [ + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'RemoveGroupMember', - ], - 'ListGroupMember' => [ - 'summary' => 'Queries the members of a group.', - 'path' => '/v2/group/list_member', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a similar image clustering job', + 'summary' => 'Creates a task that clusters similar images in a specified drive.', + 'description' => '**Before you use this operation, review the billing methods and [pricing](~~425220~~) for PDS.**'."\n" + ."\n" + .'To use this feature, you must enable the image processing value-added service. This service is currently free for a limited time.'."\n" + ."\n" + .'Procedure'."\n" + ."\n" + .'- Create a similar image clustering task.'."\n" + ."\n" + .'- Use the GetTaskStatus operation to query the status of the similar image clustering task.'."\n" + ."\n" + .'- Use the SearchSimilarImageClusters operation to retrieve the results of the similar image clustering task.'."\n" + ."\n" + .'Only one similar image clustering task can run at a time in a drive. If you start a new task while another is running, the new request fails.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"task_id\\": \\"i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb\\"\\n}","type":"json"}]', + ], + 'CreateStory' => [ + 'summary' => 'Creates a suggested story. PDS filters images and videos in a drive based on the story type and time range in the request. PDS then adds the matching files to the story. If no images or videos match the criteria, an empty story is created.', + 'path' => '/v2/image/create_story', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -6038,123 +3403,133 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create', '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, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The ID of the group of which you want to query members.'."\n", + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'A user-specified ID for the story.', 'type' => 'string', 'required' => false, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'story_type' => [ + 'description' => 'The story type.', + 'enumValueTitles' => ['PeopleMemory' => 'people story', 'TagMemory' => 'tag story', 'TimeMemory' => 'time story', 'TravelMemory' => 'travel story'], 'type' => 'string', 'required' => true, - 'example' => '3e5***2c2', - ], - 'member_type' => [ - 'description' => 'The member type. If you do not specify this parameter, both types of members are returned. Valid values:'."\n" - ."\n" - .'* user'."\n" - .'* group'."\n" - ."\n" - .'Note: A group can be a member of only one group. It cannot be a member of multiple groups. A user can be a member of multiple groups.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'enum' => ['TimeMemory', 'PeopleMemory', 'TagMemory', 'TravelMemory'], + 'example' => 'TagMemory', + 'title' => '', ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', + 'story_sub_type' => ['description' => 'The story subtype, which depends on the story\\_type. For more information, see the list of subtypes below.', 'type' => 'string', 'required' => false, 'example' => 'Food', 'title' => ''], + 'story_name' => ['description' => 'The name for the story, up to 1,024 bytes in length.', 'type' => 'string', 'example' => 'Food', 'required' => false, 'title' => ''], + 'story_start_time' => ['description' => 'The start time for files to be included in the story. The value must be in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2016-12-30T16:00:00Z', 'title' => ''], + 'story_end_time' => ['description' => 'The end time for files to be included in the story. The value must be in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2022-12-30T16:00:00Z', 'title' => ''], + 'min_image_count' => ['description' => 'The minimum number of files to include. Must be > 0 and ≤ max\\_image\\_count. Default: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], + 'max_image_count' => ['description' => 'The maximum number of files to include. Must be ≤ 100 and ≥ min\\_image\\_count. Default: 30.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'example' => '30', 'default' => '30', 'required' => false, 'title' => ''], + 'custom_labels' => [ + 'description' => 'Custom tags for the story. You can specify a maximum of 20.', + 'type' => 'object', + 'deprecated' => true, 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + 'additionalProperties' => ['description' => 'A custom tag.', 'type' => 'string', 'example' => 'label_value', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'address' => ['description' => 'The address information.', '$ref' => '#/components/schemas/Address', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'user_items' => [ - 'description' => 'The information about the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user.'."\n", - '$ref' => '#/components/schemas/User', - ], - ], - 'group_items' => [ - 'description' => 'The information about the groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a group.'."\n", - '$ref' => '#/components/schemas/Group', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create Recommended Story ', + 'description' => '**Before using this API, ensure you understand the billing methods and [pricing](~~425220~~) for PDS.**'."\n" + ."\n" + .'To use this feature, you must enable the Image Processing service. The story-related APIs are free of charge for a limited time.'."\n" + ."\n" + .'You can specify a story ID when creating a story:'."\n" + ."\n" + .'- If you specify a story ID:'."\n" + ."\n" + .' - If the story ID does not exist, a new story is created with the specified ID.'."\n" + ."\n" + .' - If the story ID already exists, PDS regenerates and overwrites the story based on the new request.'."\n" + ."\n" + .'- If you do not specify a story ID, PDS generates one.'."\n" + ."\n" + .'> * This is an asynchronous API. After creating a story, you can call the GetStory or FindStories APIs to check its creation status.', + 'requestParamsDescription' => '### Story types'."\n" + ."\n" + .'- TimeMemory: A time story.'."\n" + ."\n" + .'- PeopleMemory: A people story.'."\n" + ."\n" + .'- TagMemory: A tag story.'."\n" + ."\n" + .'- TravelMemory: A travel story.'."\n" + ."\n" + .'### Story subtypes'."\n" + ."\n" + .'TimeMemory: None.'."\n" + ."\n" + .'PeopleMemory:'."\n" + ."\n" + .'- Solo: Creates a people story for a single person. The system identifies the most frequently appearing person in the dataset based on face clustering results and generates a story. You can use the `story_start_time` and `story_end_time` parameters to specify a time range. In this case, the system selects the person who appears in the most photos within that range. The system generates a new story regardless of whether a story for that person already exists.'."\n" + ."\n" + .'TagMemory:'."\n" + ."\n" + .'- Food: A food tag story.'."\n" + ."\n" + .'- Pet: A pet tag story.'."\n" + ."\n" + .'- PetDog: A pet dog tag story.'."\n" + ."\n" + .'- PetCat: A pet cat tag story.'."\n" + ."\n" + .'- Scenery: A scenery tag story.'."\n" + ."\n" + .'TravelMemory: None.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'ListGroupMember', + 'translator' => 'machine', ], 'CreateUser' => [ - 'summary' => 'Creates a user.', + 'summary' => 'Create a user.', 'path' => '/v2/user/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'api', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -6163,206 +3538,95 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'title' => '用户id', - 'description' => 'The user ID. The ID can be up to 64 characters in length and cannot contain number signs (#).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pdsuserid1', - 'maxLength' => 1024, - 'minLength' => 1, - ], - 'nick_name' => [ - 'title' => '用户昵称', - 'description' => 'The nickname of the user. The nickname can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pdsuer', - 'maxLength' => 128, - 'minLength' => 0, - ], + 'user_id' => ['description' => 'The user ID. The ID can be up to 64 characters long and must not contain the "#" character.', 'type' => 'string', 'required' => true, 'example' => 'pdsuserid1', 'maxLength' => 1024, 'minLength' => 1, 'title' => ''], + 'nick_name' => ['description' => 'The user\'s nickname. The nickname cannot exceed 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'pdsuer', 'maxLength' => 128, 'minLength' => 0, 'title' => ''], 'status' => [ - 'title' => '用户状态', - 'description' => 'The state of the user. Default value: enabled. Valid values:'."\n" + 'description' => 'The user status. The default value is `enabled`.'."\n" ."\n" - .'* enabled: The user is in a normal state.'."\n" - .'* disabled: The user is prohibited from logon.'."\n", + .'- `enabled` (The user is active)'."\n" + ."\n" + .'- `disabled` (The user cannot log in)', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'default' => 'enabled', - 'enum' => [ - 'enabled', - 'disabled', - ], + 'enum' => ['enabled', 'disabled'], + 'title' => '', ], 'role' => [ - 'title' => '角色', - 'description' => 'The role of the user. Default value: user. Valid values:'."\n" - ."\n" - .'* superadmin'."\n" - .'* admin'."\n" - .'* user'."\n" - ."\n" - .'If the domain can be divided into subdomains, the subdomain_super_admin and subdomain_admin roles are also supported.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* subdomain_super_admin'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* subdomain_admin'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* superadmin'."\n" + 'description' => 'The user\'s role. The default value is `user`.'."\n" ."\n" - .' <!-- -->'."\n" + .'- `superadmin`: The super administrator.'."\n" ."\n" - .' <!-- -->'."\n" + .'- `admin`: An administrator.'."\n" ."\n" - .' <!-- -->'."\n" + .'- `user`: A standard user.'."\n" ."\n" - .'* admin'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* user'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + .'If the current domain supports subdomains, the `subdomain_super_admin` and `subdomain_admin` roles are also available.', + 'enumValueTitles' => ['subdomain_super_admin' => '', 'subdomain_admin' => '', 'superadmin' => '', 'admin' => '', 'user' => ''], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'subdomain_super_admin' => '', - 'subdomain_admin' => '', - 'superadmin' => '', - 'admin' => '', - 'user' => '', - ], 'example' => 'user', 'default' => 'user', - 'enum' => [ - 'user', - 'admin', - 'superadmin', - 'subdomain_admin', - 'subdomain_super_admin', - ], - ], - 'avatar' => [ - 'title' => '头像地址', - 'description' => 'The URL of the profile picture.'."\n" - ."\n" - .'If you specify the parameter in the HTTP URL format, the URL must start with http:// or https:// and can be up to 4 KB in size.'."\n" - ."\n" - .'If you specify the parameter in the data URL format, the URL must start with data:// and be encoded in Base64. The URL can be up to 300 KB in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.b.c/pds.jpg', - ], - 'phone' => [ - 'title' => '电话', - 'description' => 'The phone number.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '13900001111', - ], - 'email' => [ - 'title' => '邮箱地址', - 'description' => 'The email address.'."\n", - 'type' => 'string', + 'enum' => ['user', 'admin', 'superadmin', 'subdomain_admin', 'subdomain_super_admin'], + 'title' => '', 'required' => false, - 'example' => '123@pds.com', ], + 'avatar' => ['description' => 'The user\'s avatar.'."\n" + ."\n" + .'HTTP URLs must start with `http://` or `https://` and must not exceed 4 KB.'."\n" + ."\n" + .'Data URIs must start with `data://`, be Base64-encoded, and must not exceed 300 KB.', 'type' => 'string', 'example' => 'http://a.b.c/pds.jpg', 'title' => '', 'required' => false], + 'phone' => ['description' => 'The user\'s phone number.', 'type' => 'string', 'example' => '13900001111', 'title' => '', 'required' => false], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'example' => '123@pds.com', 'title' => '', 'required' => false], 'user_data' => [ - 'description' => 'The custom data. The data can be up to 1,024 characters in length.'."\n", + 'description' => 'User-defined data, which can be up to 1,024 characters long.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - ], + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], 'example' => 'md', 'title' => '', ], 'group_info_list' => [ - 'description' => 'The information about the group.'."\n", + 'description' => 'The group information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'group_id' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'g123', - ], + 'group_id' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'g123', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'user_name' => [ - 'title' => '用户名', - 'description' => 'The username. The username can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pdsusername', - 'maxLength' => 128, - 'minLength' => 0, - ], - 'description' => [ - 'title' => '用户描述', - 'description' => 'The description of the user. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The VIP user', - 'maxLength' => 1024, - 'minLength' => 0, - ], + 'user_name' => ['description' => 'The username. The maximum length is 128 characters.', 'type' => 'string', 'example' => 'pdsusername', 'maxLength' => 128, 'minLength' => 0, 'title' => '', 'required' => false], + 'description' => ['description' => 'The user description. It can be up to 1,024 characters long.', 'type' => 'string', 'example' => 'VIP user', 'maxLength' => 1024, 'minLength' => 0, 'title' => '', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6370,434 +3634,175 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'domain_id' => [ - 'title' => '域id', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'user_id' => [ - 'title' => '用户id', - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => 'dingding_abc001', - ], - 'avatar' => [ - 'title' => '头像地址', - 'description' => 'The URL of the profile picture.'."\n", - 'type' => 'string', - 'example' => 'http://aa.com/1.jpg', - ], - 'created_at' => [ - 'description' => 'The time when the user was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639762579768', - ], - 'updated_at' => [ - 'description' => 'The time when the user was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639762579768', - ], - 'nick_name' => [ - 'title' => '昵称', - 'description' => 'The nickname of the user.'."\n", - 'type' => 'string', - 'example' => '001', - ], - 'user_name' => [ - 'title' => '用户名', - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'pds', - ], - 'phone' => [ - 'title' => '电话', - 'description' => 'The phone number.'."\n", - 'type' => 'string', - 'example' => '13900001111', - ], - 'email' => [ - 'title' => '邮箱地址', - 'description' => 'The email address.'."\n", - 'type' => 'string', - 'example' => 'a@a.com', - ], + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'title' => '', 'example' => 'bj1'], + 'user_id' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => 'dingding_abc001'], + 'avatar' => ['description' => 'The avatar URL.', 'type' => 'string', 'title' => '', 'example' => 'http://aa.com/1.jpg'], + 'created_at' => ['description' => 'The creation time, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579768', 'title' => ''], + 'updated_at' => ['description' => 'The modification time, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639762579768', 'title' => ''], + 'nick_name' => ['description' => 'The nickname.', 'type' => 'string', 'title' => '', 'example' => '001'], + 'user_name' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'example' => 'pds'], + 'phone' => ['description' => 'The phone number.', 'type' => 'string', 'title' => '', 'example' => '13900001111'], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'title' => '', 'example' => 'a@a.com'], 'role' => [ - 'title' => '角色', - 'description' => 'The role of the user. Valid values:'."\n" + 'description' => 'The user role. Valid values:'."\n" + ."\n" + .'- `superadmin`: Super administrator'."\n" ."\n" - .'* superadmin'."\n" - .'* admin'."\n" - .'* user'."\n", + .'- `admin`: Administrator'."\n" + ."\n" + .'- `user`: User', + 'enumValueTitles' => ['superadmin' => 'Super administrator', 'admin' => 'Administrator', 'user' => 'User'], 'type' => 'string', - 'enumValueTitles' => [ - 'superadmin' => '', - 'admin' => '', - 'user' => '', - ], + 'title' => '', 'example' => 'admin', ], 'status' => [ - 'title' => '状态', - 'description' => 'The state of the user. Valid values:'."\n" + 'description' => 'The user status. Valid values:'."\n" + ."\n" + .'- `disabled`: The user is inactive.'."\n" ."\n" - .'* disabled: The user is prohibited from logon.'."\n" - .'* enabled: The user is in a normal state.'."\n", + .'- `enabled`: The user is active.', + 'enumValueTitles' => ['disabled' => 'The user is inactive.', 'enabled' => 'The user is active.'], 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], + 'title' => '', 'example' => 'enabled', ], - 'description' => [ - 'title' => '描述', - 'description' => 'The description of the user.'."\n", - 'type' => 'string', - 'example' => 'vipuser', - ], - 'default_drive_id' => [ - 'title' => '缺省空间id', - 'description' => 'The ID of the default drive.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'description' => ['description' => 'The user description.', 'type' => 'string', 'title' => '', 'example' => 'vipuser'], + 'default_drive_id' => ['description' => 'The ID of the user\'s default drive.', 'type' => 'string', 'title' => '', 'example' => '1'], 'user_data' => [ - 'description' => 'The custom data.'."\n", + 'description' => 'A key-value object for storing custom user data.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'dog', - 'description' => 'The custom item.'."\n", - ], - ], - 'creator' => [ - 'title' => '创建者', - 'description' => 'The user who created the user.'."\n", - 'type' => 'string', - 'example' => 'user1', + 'additionalProperties' => ['description' => 'The value of a custom data field.', 'type' => 'any', 'example' => 'dog', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'title' => '', 'example' => 'user1'], ], + 'example' => '', ], ], ], '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\\": \\"a@a.com\\",\\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' => 'CreateUser', - ], - 'ImportUser' => [ - 'summary' => 'Imports a user.', - 'path' => '/v2/user/import', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'CsiGetFileInfo' => [ + 'path' => '/v2/csi/get_file_info', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'authentication_type' => [ - 'description' => 'The authentication type. Valid values:'."\n" - ."\n" - .'* mobile: mobile number.'."\n" - .'* email: email address.'."\n" - .'* ding: DingTalk account.'."\n" - .'* ram: Alibaba Cloud Resource Access Management (RAM) user.'."\n" - .'* wechat: WeCom account.'."\n" - .'* ldap: Lightweight Directory Access Protocol (LDAP) account.'."\n" - .'* custom: custom account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mobile', - ], - 'identity' => [ - 'description' => 'The unique identifier.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '130****', - ], - 'authentication_display_name' => [ - 'description' => 'The display name of the authentication type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10000', - ], - 'extra' => [ - 'description' => 'The additional information.'."\n" - ."\n" - .'If authentication_type is set to mobile, set this parameter to a country code. If you do not specify this parameter, 86 is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'nick_name' => [ - 'description' => 'The nickname of the user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pdsuer', - ], - 'auto_create_drive' => [ - 'description' => 'Specifies whether to automatically create a drive.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'drive_total_size' => [ - 'description' => 'The size of the drive. The value cannot be smaller than -1. A value of -1 specifies that the size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10240', - ], - 'parent_group_id' => [ - 'description' => 'The ID of the group to which the user is added.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'g12', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'url_expire_sec' => ['description' => 'The validity period of the download URL in seconds, with a valid range of 10 to 14,400. By default, a download URL is not returned. Set this parameter to include one in the response.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '14400', 'minimum' => '10', 'required' => false, 'example' => '100', 'title' => ''], ], 'required' => false, + 'description' => 'The request body parameters.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the user.'."\n", - '$ref' => '#/components/schemas/User', + 'type' => 'object', + 'properties' => [ + 'investigation_info' => ['description' => 'The content security details of the file.', '$ref' => '#/components/schemas/InvestigationInfo', 'title' => '', 'example' => ''], + 'url' => ['description' => 'The download URL for the file.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ImportUser', - ], - 'UpdateUser' => [ - 'summary' => 'Modifies the information about a user.', - 'path' => '/v2/user/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'Obtain File Content Moderation Details ', + 'summary' => 'Retrieves the content security details of a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"investigation_info\\": {\\n \\"status\\": 4,\\n \\"suggestion\\": \\"block\\",\\n \\"video_detail\\": {\\n \\"block_frames\\": [\\n {\\n \\"rate\\": 99.1,\\n \\"offset\\": 3,\\n \\"label\\": \\"porn\\"\\n }\\n ]\\n }\\n },\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\"\\n}","type":"json"}]', + ], + 'DeleteDomain' => [ + 'summary' => 'Deletes a domain.', + 'path' => '/v2/domain/delete', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['admin'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'The user ID. The ID can be up to 64 characters in length and cannot contain a number sign (#).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - 'maxLength' => 1024, - 'minLength' => 1, - ], - 'nick_name' => [ - 'description' => 'The nickname of the user. The nickname can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pdsuer', - 'maxLength' => 128, - 'minLength' => 0, - ], - 'status' => [ - 'description' => 'The state of the user. Valid values:'."\n" - ."\n" - .'* disabled: The user is prohibited from logon.'."\n" - .'* enabled: The user is in a normal state.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - 'enum' => [ - 'enabled', - 'disabled', - ], - ], - 'role' => [ - 'description' => 'The role of the user. Valid values:'."\n" - ."\n" - .'* superadmin'."\n" - .'* admin'."\n" - .'* user'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'superadmin' => '', - 'admin' => '', - 'user' => '', - ], - 'example' => 'user', - 'enum' => [ - 'user', - 'admin', - 'superadmin', - 'subdomain_admin', - 'subdomain_super_admin', - ], - ], - 'avatar' => [ - 'description' => 'The URL of the profile picture.'."\n" - ."\n" - .'If you specify the parameter in the HTTP URL format, the URL must start with http:// or https:// and can be up to 4 KB in size.'."\n" - ."\n" - .'If you specify the parameter in the DATA URL format, the URL must start with data:// and be encoded in Base64. The URL can be up to 300 KB in size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.b.c/pds.jpg', - ], - 'description' => [ - 'description' => 'The description of the user. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 1024, - 'minLength' => 0, - ], - 'phone' => [ - 'description' => 'The mobile number of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '13900001111', - ], - 'email' => [ - 'description' => 'The email address of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a@aliyunpds.com', - ], - 'user_data' => [ - 'description' => 'The custom data. The data can be up to 1,024 characters in length.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'test', - 'description' => 'The custom data.'."\n", - ], - ], - 'group_info_list' => [ - 'description' => 'The information about the group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'group_id' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'g123', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => false, 'example' => 'bj1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information about the user.'."\n", - '$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', - ], - 'GetUser' => [ - 'summary' => 'Queries the information about a user.', - 'path' => '/v2/user/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 204 => [], ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDomain', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeleteDrive' => [ + 'summary' => 'Deletes a drive.', + 'path' => '/v2/drive/delete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -6806,64 +3811,56 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'The user ID. If you use an AccessKey pair to access Drive and Photo Service, you must specify this parameter. If you use an access token to access Drive and Photo Service, you do not need to specify this parameter, and Drive and Photo Service automatically finds the user ID contained in the access token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ 'schema' => [ - 'description' => 'The information about the user.'."\n", - '$ref' => '#/components/schemas/User', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + 'example' => '', ], ], ], - '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', - ], - 'ListUser' => [ - 'summary' => 'Queries users.', - 'path' => '/v2/user/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'DeleteDrive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeleteFile' => [ + 'summary' => 'Deletes a file or folder.', + 'path' => '/v2/file/delete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -6872,88 +3869,63 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'pattern' => '^[0-9]*$', 'title' => ''], + 'file_id' => ['description' => 'The file or folder ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9520943DC264'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'next_marker' => [ - 'title' => 'Id of the request', - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'items' => [ - 'description' => 'The information about the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user.'."\n", - '$ref' => '#/components/schemas/User', - ], - ], + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'example' => '9520943DC264', 'title' => ''], + 'async_task_id' => ['description' => 'The asynchronous task ID. This parameter is returned only for asynchronous operations. Call [GetAsyncTask](~~440456~~) with this ID to query the task status.', 'type' => 'string', 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ListUser', - ], - 'SearchUser' => [ - 'summary' => 'Searches for users.', - 'path' => '/v2/user/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'DeleteFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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"}]', + ], + 'DeleteGroup' => [ + 'summary' => 'Deletes a group. Before deleting a group, ensure it contains no other groups or users. Otherwise, the deletion fails.', + 'path' => '/v2/group/delete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -6962,159 +3934,56 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'nick_name' => [ - 'description' => 'The nickname of the user. The nickname can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pdsuer', - 'maxLength' => 128, - 'minLength' => 0, - ], - 'nick_name_for_fuzzy' => [ - 'description' => 'The nickname used for fuzzy searches. The nickname can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'la', - 'maxLength' => 128, - 'minLength' => 0, - ], - 'user_name' => [ - 'description' => 'The name of the user. The name can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pds', - 'maxLength' => 128, - 'minLength' => 0, - ], - 'phone' => [ - 'description' => 'The mobile number of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '13900001111', - ], - 'email' => [ - 'description' => 'The email address of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123@pds.com', - ], - 'status' => [ - 'description' => 'The state of the user. Valid values:'."\n" - ."\n" - .'* disabled: The user is prohibited from logon.'."\n" - .'* enabled: The user is in a normal state.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - ], - 'role' => [ - 'description' => 'The role of the user. Valid values:'."\n" - ."\n" - .'* superadmin'."\n" - .'* admin'."\n" - .'* user'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'superadmin' => '', - 'admin' => '', - 'user' => '', - ], - 'example' => 'user', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'group_id' => ['description' => 'The ID of the group to delete.', 'type' => 'string', 'required' => true, 'example' => 'g123', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', - 'properties' => [ - 'next_marker' => [ - 'title' => 'Id of the request', - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'items' => [ - 'description' => 'The information about the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a user.'."\n", - '$ref' => '#/components/schemas/User', - ], - ], - ], + 'properties' => [], + 'example' => '', ], ], ], - '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', - ], - 'DeleteUser' => [ - 'summary' => 'Deletes a user.', - 'path' => '/v2/user/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'DeleteGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeleteRevision' => [ + 'summary' => 'Deletes a historical revision. You cannot delete the latest revision.', + 'path' => '/v2/file/revision/delete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -7123,68 +3992,57 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'user_id' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], + 'drive_id' => ['description' => 'Drive ID', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'File ID', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'revision_id' => ['description' => 'Revision ID', 'type' => 'string', 'required' => true, 'example' => '40CB7794C929', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 204 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [], + 'example' => '', ], ], ], + 'title' => 'DeleteRevision', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteUser', ], - 'CreateDrive' => [ - 'summary' => 'Creates a drive.', - 'path' => '/v2/drive/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'api', - ], + 'DeleteStory' => [ + 'summary' => 'Deletes a specified story.', + 'path' => '/v2/image/delete_story', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -7193,116 +4051,31 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_name' => [ - 'description' => 'The name of the drive. The name can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_drive', - 'maxLength' => 1024, - 'minLength' => 1, - ], - 'owner' => [ - 'description' => 'The owner of the drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b3d7245c159488da17d081ad6c64687', - ], - 'owner_type' => [ - 'description' => 'The type of the owner. Valid values:'."\n" - ."\n" - .'user and group.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'user' => 'user', - 'group' => 'group', - ], - 'example' => 'user', - 'enum' => [ - 'user', - 'group', - ], - ], - 'description' => [ - 'description' => 'The description of the drive. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'drive for test', - 'maxLength' => 1024, - ], - 'drive_type' => [ - 'description' => 'The type of the drive. Set the value to normal.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'normal' => 'normal', - ], - 'example' => 'normal', - 'default' => 'normal', - 'enum' => [], - ], - 'status' => [ - 'description' => 'The state of the drive. Valid values:'."\n" - ."\n" - .'enabled and disabled.'."\n" - ."\n" - .'Default value: enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => 'disabled', - 'enabled' => 'enabled', - ], - 'example' => 'enabled', - 'default' => 'enabled', - 'enum' => [ - 'enabled', - 'disabled', - ], - ], - 'total_size' => [ - 'description' => 'The total size of the drive. Unit: bytes. By default, the size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024', - ], - 'default' => [ - 'description' => 'Specifies whether the drive is the default drive. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The ID of the story.', 'type' => 'string', 'required' => true, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -7310,71 +4083,31 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'drive_name' => [ - 'type' => 'string', - ], - 'description' => [ - 'type' => 'string', - ], - 'owner' => [ - 'type' => 'string', - ], - 'owner_type' => [ - 'type' => 'string', - ], - 'drive_type' => [ - 'type' => 'string', - ], - 'used_size' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'total_size' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'creator' => [ - 'type' => 'string', - ], - 'created_at' => [ - 'type' => 'string', - ], - 'status' => [ - 'type' => 'string', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'CreateDrive', - ], - 'UpdateDrive' => [ - 'summary' => 'Modifies a drive.', - 'path' => '/v2/drive/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Story', + 'description' => '**Before calling this operation, understand the billing methods and [pricing](~~425220~~) of PDS.**'."\n" + ."\n" + .'To use this feature, you must enable the image processing feature, which is a value-added service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + ], + 'DeleteUser' => [ + 'path' => '/v2/user/delete', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -7383,174 +4116,113 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The container for request parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'drive_name' => [ - 'description' => 'The name of the drive. The name can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_drive', - 'maxLength' => 128, - ], - 'description' => [ - 'description' => 'The description of the drive. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 1024, - ], - 'status' => [ - 'description' => 'The state of the drive. Valid values:'."\n" - ."\n" - .'enabled and disabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - 'enum' => [ - 'enabled', - 'disabled', - ], - ], - 'total_size' => [ - 'description' => 'The total size of the drive. Unit: bytes. A value of -1 specifies that the size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10240', - ], - 'owner' => [ - 'description' => 'The owner of the drive. Note: You can modify the owner of a personal drive only by using an AccessKey pair.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', - ], + 'user_id' => ['description' => 'The ID of the user to delete.', 'type' => 'string', 'required' => true, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", - '$ref' => '#/components/schemas/Drive', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + 'example' => '', ], ], ], - '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' => 'UpdateDrive', - ], - 'GetDrive' => [ - 'summary' => 'Queries the information about a drive.', - 'path' => '/v2/drive/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'DeleteUser', + 'summary' => 'Deletes a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeltaGetLastCursor' => [ + 'path' => '/v2/file/get_last_cursor', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1'], + 'sync_root_id' => ['description' => 'The ID of the root directory for the sync folder.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '622fb09598ae66777c7040109a16f49381f6abe1'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", - '$ref' => '#/components/schemas/Drive', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'cursor' => ['description' => 'The latest cursor for delta operations in the specified drive or sync folder.', 'type' => 'string', 'title' => '', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'], + ], + 'example' => '', ], ], ], - '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', - ], - 'ListDrive' => [ - 'summary' => 'Queries a list of drives.', - 'path' => '/v2/drive/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'DeltaGetLastCursor', + 'summary' => 'Retrieves the latest cursor for delta operations.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cursor\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'DownloadFile' => [ + 'path' => '/v2/file/download', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -7559,721 +4231,313 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '100', - 'default' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'owner' => [ - 'description' => 'The owner of the drive. If this parameter is not specified, all drives are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'owner_type' => [ - 'description' => 'The type of the owner. Valid values:'."\n" - ."\n" - .'user and group.'."\n" - ."\n" - .'By default, drives of all owner types are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - 'enum' => [ - 'user', - 'group', - ], - ], - ], - 'required' => false, - ], + 'name' => 'share_id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the share. If you access a file by using a share link, you must authenticate with the `x-share-token` header and specify this parameter. In this case, the `drive_id` parameter is not applicable. Otherwise, you must authenticate by using `AK/SK` or an `access_token` and specify the `drive_id` parameter. You must specify either `share_id` or `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The queried drives.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried drive.'."\n", - '$ref' => '#/components/schemas/Drive', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - ], - ], + [ + 'name' => 'drive_id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - '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' => 'ListDrive', - ], - 'GetDefaultDrive' => [ - 'summary' => 'Queries the default drive of a user.', - 'path' => '/v2/drive/get_default_drive', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'file_id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], ], [ - 'BearerToken' => [], + 'name' => 'image_thumbnail_process', + 'in' => 'query', + 'schema' => ['description' => 'The image processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail.', 'type' => 'string', 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', 'title' => ''], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'parameters' => [ [ - 'name' => 'domain_id', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'name' => 'video_thumbnail_process', + 'in' => 'query', + 'schema' => ['description' => 'The video processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail.', 'type' => 'string', 'required' => false, 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'user_id' => [ - 'description' => 'The user ID. If you use an AccessKey pair for authentication, you must specify this parameter. If you use an access token for authentication, this parameter is optional. By default, the user ID associated with the access token is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - ], - 'required' => false, - ], + 'name' => 'office_thumbnail_process', + 'in' => 'query', + 'schema' => ['description' => 'The document processing style. Specifying this parameter redirects the request to the URL of the processed thumbnail.', 'type' => 'string', 'required' => false, 'example' => 'image/resize,m_lfit,w_256,limit_0/format,jpg|image/format,webp', 'title' => ''], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - '$ref' => '#/components/schemas/Drive', + 302 => [ + 'headers' => [ + 'location' => [ + 'schema' => ['title' => '下载地址', 'type' => 'string'], + ], ], ], ], - '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' => 'GetDefaultDrive', - ], - 'ListMyDrives' => [ - 'summary' => 'Queries the drives of the current user.', - 'path' => '/v2/drive/list_my_drives', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'DownloadFile', + 'summary' => 'Downloads a file.', + 'description' => '<props="china">'."\n" + ."\n" + .'For best practices, see [file download](~~175889~~).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'FileAddPermission' => [ + 'summary' => 'Grants folder-level authorization. Each drive supports a maximum of 1000 authorization records. Authorization records that exceed this limit do not take effect.', + 'path' => '/v2/file/add_permission', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Default value: 100. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '100', - 'default' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'."\n", + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the folder. To authorize an entire team drive, set this parameter to root. Setting this parameter to root is not supported for personal drive sharing.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], + 'member_list' => [ + 'description' => 'The list of members to be authorized.', + 'type' => 'array', + 'items' => ['description' => 'The authorization information.', '$ref' => '#/components/schemas/FilePermissionMember', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The queried drives.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried drive.'."\n", - '$ref' => '#/components/schemas/Drive', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - ], - ], + 204 => [ + 'headers' => [], ], ], - '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' => 'ListMyDrives', - ], - 'SearchDrive' => [ - 'summary' => 'Queries drives.', - 'path' => '/v2/drive/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'Grant file sharing authorization to users or groups', + 'description' => 'Each drive supports a maximum of 1000 authorization records. Authorization records that exceed this limit do not take effect.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'FileDeleteUserTags' => [ + 'path' => '/v2/file/delete_usertags', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_name' => [ - 'description' => 'The drive name.'."\n", - 'type' => 'string', - 'required' => false, + 'drive_id' => ['description' => 'Space ID', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'File ID', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'key_list' => [ + 'description' => 'List of tags to delete.'."\n" + .'The array must not be empty and can contain up to 1,000 items.', + 'type' => 'array', + 'items' => ['description' => 'Tag name.'."\n" + .'Must not contain the # character.', 'type' => 'string', 'required' => true, 'pattern' => '^[^#]+$', 'example' => 'tag', 'title' => ''], + 'required' => true, + 'maxItems' => 1000, + 'minItems' => 1, + 'title' => '', 'example' => '', ], - 'limit' => [ - 'description' => 'The maximum number of asynchronous tasks to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '100', - 'default' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'owner' => [ - 'description' => 'The owner of the drive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'owner_type' => [ - 'description' => 'The type of the owner. Valid values:'."\n" - ."\n" - .'user group'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - 'enum' => [ - 'user', - 'group', - ], - ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The information about the drives.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a drive.'."\n", - '$ref' => '#/components/schemas/Drive', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - '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', - ], - 'DeleteDrive' => [ - 'summary' => 'Deletes a drive.', - 'path' => '/v2/drive/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 204 => [], ], - 'tags' => [ - 'api', + 'title' => 'FileDeleteUserTags', + 'summary' => 'Deletes custom tags from a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'FileListPermission' => [ + 'summary' => 'Lists the permission records for a file.', + 'path' => '/v2/file/list_permission', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [], + 'description' => 'A list of file permission records.', + 'type' => 'array', + 'items' => ['description' => 'A file permission record.', '$ref' => '#/components/schemas/FilePermissionMember', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteDrive', - ], - 'CreateFile' => [ - 'summary' => 'Creates a file or folder.', - 'path' => '/v2/file/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'api', + 'title' => 'FileListPermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"identity\\": {\\n \\"identity_type\\": \\"IT_User\\",\\n \\"identity_id\\": \\"16435bdf934248b788b7b3771ee9a3dw\\"\\n },\\n \\"role_id\\": \\"SystemFileDownloader\\",\\n \\"expire_time\\": 1633598085642,\\n \\"disinherit_sub_group\\": false,\\n \\"action_list\\": [\\n \\"FILE.CREATE\\"\\n ]\\n }\\n]","type":"json"}]', + ], + 'FilePutUserTags' => [ + 'path' => '/v2/file/put_usertags', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '文件或文件夹名称', - 'description' => 'The name of the file. The name can be up to 1,024 bytes in length based on the UTF-8 encoding rule and cannot contain forward slash (/).', - 'type' => 'string', - 'required' => true, - 'example' => 'a.txt', - 'maxLength' => 1024, - 'minLength' => 1, - ], - 'type' => [ - 'title' => '类型', - 'description' => 'The type of the file. Valid values:'."\n" - ."\n" - .'file folder'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'file', - 'enum' => [ - 'file', - 'folder', - ], - ], - 'parent_file_id' => [ - 'title' => '父文件夹id', - 'description' => 'The ID of the parent directory. If you want to create a file or folder in the root directory, set this parameter to root.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'fileid1', - ], - 'drive_id' => [ - 'title' => '用户空间id', - 'description' => 'The drive ID. This parameter is required if the file is not uploaded by using the share URL of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'pattern' => '^[0-9]*$', - ], - 'share_id' => [ - 'title' => '共享id', - 'description' => 'The share ID. This parameter is required if the file is uploaded by using the share URL of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'size' => [ - 'title' => '文件大小', - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024', - ], - 'content_type' => [ - 'title' => '文件类型', - 'description' => 'The type of the file content. Default value: application/oct-stream.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'application/json', - ], - 'part_info_list' => [ - 'description' => 'The information about the file parts. You can specify up to 10,000 parts. By default, if you do not specify this parameter, only one part is returned.'."\n", + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'user_tags' => [ + 'description' => 'The array of tags to add. The array must contain 1 to 1,000 tags and must not contain duplicate tag keys.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The combined length of the tag key and tag value cannot exceed 2,000 bytes.', 'type' => 'object', 'properties' => [ - 'part_number' => [ - 'description' => 'The serial number of a file part. The number starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'parallel_sha1_ctx' => [ - 'description' => 'The SHA-1 hash value of the file content before the file part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'type' => 'object', - 'properties' => [ - 'h' => [ - 'description' => 'The first to fifth 32-bit variables of the SHA-1 hash value of the file content before the file part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The first to fifth 32-bit variables of the SHA-1 hash value of the file content before the file part.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'part_offset' => [ - 'description' => 'The size of the file content before the file part. Unit: bytes. The value must be a multiple of 64. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10240', - ], - ], - 'required' => false, - ], - 'content_md5' => [ - 'description' => 'The MD5 hash value of the file part. This parameter is required when the MD5 hash value of the file part needs to be verified during part upload.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'ASKJDJSKDJJSJDJS', - ], + 'key' => ['description' => 'The tag key. Must not be empty or contain the # character.', 'type' => 'string', 'required' => true, 'pattern' => '^[^#]+$', 'example' => 'tag', 'title' => ''], + 'value' => ['description' => 'The tag value. Must not contain the # character.', 'type' => 'string', 'pattern' => '^[^#]+$', 'required' => false, 'example' => 'value', 'title' => ''], ], - 'required' => false, - ], - 'required' => false, - ], - 'user_tags' => [ - 'title' => '用户打标', - 'description' => 'The custom tags. You can specify up to 1,000 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom tag.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UserTag', - ], - 'required' => false, - ], - 'hidden' => [ - 'description' => 'Specifies whether to hide the file or folder. By default, the file or folder is not hidden.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'description' => [ - 'title' => '描述信息', - 'description' => 'The description of the file. The description can be up to 1,024 characters in length. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '重要文件', - 'maxLength' => 1024, - ], - 'content_hash' => [ - 'title' => '内容hash', - 'description' => 'The hash value of the file content. The value is calculated based on the algorithm specified by content_hash_name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8941B', - ], - 'content_hash_name' => [ - 'title' => '内容hash算法名', - 'description' => 'The name of the algorithm that is used to calculate the hash value of the file content. Only SHA1 is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sha1', - 'enum' => [ - 'sha1', - ], - ], - 'pre_hash' => [ - 'description' => 'The SHA-1 hash value of the first 1 KB data of the file. This parameter is required if you perform instant file upload by using the pre-hashing feature. If the SHA-1 hash value is not matched on the cloud, the client does not need to calculate the SHA-1 hash value of the entire file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7C4A8D09CA3762AF61E59520943DC26494F89411', - ], - 'check_name_mode' => [ - 'title' => '重命名模式', - 'description' => 'The processing method that is used if the file that you want to create has the same name as an existing file in the cloud. Valid values:'."\n" - ."\n" - .'ignore: allows you to create the file by using the same name as an existing file in the cloud.'."\n" - ."\n" - .'auto_rename: automatically renames the file that you want to create. By default, the current point in time is added to the end of the file name. Example: xxx\\_20060102\\_150405.'."\n" - ."\n" - .'refuse: does not create the file that you want to create but returns the information about the file that has the same name in the cloud.'."\n" - ."\n" - .'Default value: ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'refuse' => 'refuse', - 'auto_rename' => 'auto_rename', - 'ignore' => 'ignore', - ], - 'example' => 'ignore', - 'enum' => [ - 'ignore', - 'auto_rename', - 'refuse', + 'required' => true, + 'title' => '', + 'example' => '', ], - ], - 'file_id' => [ - 'title' => '文件id', - 'description' => 'The file ID. This parameter is required if check_name_mode is set to ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9520943DC264', - ], - 'local_created_at' => [ - 'title' => '文件本地创建时间', - 'description' => 'The time when the local file was created. By default, this parameter is left empty. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format based on the UTC+0 time zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'local_modified_at' => [ - 'title' => '本地文件修改时间', - 'description' => 'The time when the local file was modified. By default, this parameter is left empty. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format based on the UTC+0 time zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'image_media_metadata' => [ - 'description' => 'The information about the image specified by the client.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/ImageMediaMetadata', - ], - 'video_media_metadata' => [ - 'description' => 'The information about the video specified by the client.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/VideoMediaMetadata', - ], - 'parallel_upload' => [ - 'description' => 'Specifies whether to enable the parallel upload feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'custom_updated_at' => [ - 'type' => 'string', - ], - 'custom_created_at' => [ - 'type' => 'string', + 'required' => true, + 'maxItems' => 1000, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8281,199 +4545,131 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The data returned.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'parent_file_id' => [ - 'title' => '父目录文件id', - 'description' => 'The ID of the parent directory.'."\n", - 'type' => 'string', - 'example' => 'fileid5', - ], - 'part_info_list' => [ - 'title' => '分段信息', - 'description' => 'The information about the file parts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file part.'."\n", - '$ref' => '#/components/schemas/UploadPartInfo', - ], - ], - 'upload_id' => [ - 'title' => '上传id', - 'description' => 'The ID of the upload task.'."\n", - 'type' => 'string', - 'example' => 'uploadid1', - ], - 'rapid_upload' => [ - 'title' => '是否已经秒传', - 'description' => 'Indicates whether the file is instantly uploaded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'type' => [ - 'description' => 'The type of the file.'."\n", - 'type' => 'string', - 'example' => 'file', - ], - 'file_id' => [ - 'title' => '文件id', - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'fileid1', - ], - 'domain_id' => [ - 'title' => '域id', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'title' => '空间id', - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_name' => [ - 'title' => '文件名', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'a.txt', - ], - 'status' => [ - 'title' => '文件状态', - 'description' => 'The state of the file.'."\n", - 'type' => 'string', - 'example' => 'uploading', - ], - 'exist' => [ - 'title' => '文件是否存在', - 'description' => 'Indicates whether the file exists.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'file_id' => ['title' => 'Id of the request', 'description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264'], ], + 'example' => '', ], ], ], - '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' => 'CreateFile', - ], - 'DeleteFile' => [ - 'summary' => 'Deletes a file or folder.', - 'path' => '/v2/file/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'FilePutUserTags', + 'summary' => 'Adds custom tags to a file.', + 'description' => 'This operation performs an incremental update:'."\n" + ."\n" + .'- If a tag with the same key already exists, its value is overwritten.'."\n" + ."\n" + .'- If a tag does not exist, it is added.'."\n" + ."\n" + .'- Existing tags with different keys are not affected.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"file_id\\": \\"9520943DC264\\"\\n}","type":"json"}]', + ], + 'FileRemovePermission' => [ + 'summary' => 'Revokes a file sharing permission.', + 'path' => '/v2/file/remove_permission', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => 'drive id 如果要删除drive下的文件时，drive_id时必需的参数', - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - 'pattern' => '^[0-9]*$', - ], - 'file_id' => [ - 'title' => 'file_id是文件的唯一标识，删除文件或者目录时必须指定file_id', - 'description' => 'The file ID or folder ID.'."\n", - 'type' => 'string', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], + 'member_list' => [ + 'description' => 'The members whose permissions you want to remove.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => ['description' => 'The identity from which to revoke the permission. An identity can be a user or a user group.', 'required' => true, '$ref' => '#/components/schemas/Identity', 'title' => '', 'example' => ''], + 'role_id' => ['description' => 'The ID of the role to remove. This parameter is mutually exclusive with `action_list`. If both are specified, `role_id` takes precedence.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'`SystemFileOwner` (file collaborator)'."\n" + ."\n" + .'`SystemFileDownloader` (downloader)'."\n" + ."\n" + .'`SystemFileEditor` (editor)'."\n" + ."\n" + .'`SystemFileEditorWithoutDelete` (editor without delete permission)'."\n" + ."\n" + .'`SystemFileEditorWithoutShareLink` (editor without share permission)'."\n" + ."\n" + .'`SystemFileMetaViewer` (list viewer)'."\n" + ."\n" + .'`SystemFileUploader` (uploader), and `SystemFileUploaderAndDownloader` (uploader/downloader)'."\n" + ."\n" + .'`SystemFileDownloaderWithShareLink` (downloader/sharer)'."\n" + ."\n" + .'`SystemFileUploaderAndDownloaderWithShareLink` (uploader/downloader/sharer)'."\n" + ."\n" + .'`SystemFileUploaderAndViewer` (viewer/uploader)'."\n" + ."\n" + .'`SystemFileUploaderWithShareLink` (uploader/sharer)'."\n" + ."\n" + .'`SystemFileViewer` (viewer)', 'type' => 'string', 'required' => true, 'example' => 'SystemFileDownloader', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '9520943DC264', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '9520943DC264', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task. This parameter is returned only in asynchronous processing scenarios. You can call the [GetAsyncTask](~~440456~~) operation to query the information about the asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', - ], - ], - 'description' => '', - ], + 204 => [ + 'headers' => [], ], ], - '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' => 'DeleteFile', - ], - 'UpdateFile' => [ - 'summary' => 'Modifies the information about a file instead of the file data.', - 'path' => '/v2/file/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'FileRemovePermission', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'GetAsyncTask' => [ + 'path' => '/v2/async_task/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -8482,26 +4678,24 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'async_task_id' => ['description' => 'The ID of the asynchronous task.'], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -8512,301 +4706,103 @@ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'name' => [ - 'description' => 'The name of the file. The name can be up to 1,024 bytes in length based on the UTF-8 encoding rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a.jpg', - 'maxLength' => 102, - 'minLength' => 1, - ], - 'description' => [ - 'description' => 'The description of the file. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 1024, - ], - 'labels' => [ - 'description' => 'The tags of the file. You can specify up to 100 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag of the file. The tag can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'maxItems' => 100, - ], - 'check_name_mode' => [ - 'description' => 'The processing method that is used if the file that you want to modify has the same name as an existing file on the cloud. Valid values:'."\n" - ."\n" - .'ignore: allows you to modify the file by using the same name as an existing file on the cloud.'."\n" - ."\n" - .'auto_rename: automatically renames the file that has the same name on the cloud. By default, the current point in time is added to the end of the file name. Example: xxx\\_20060102\\_150405.'."\n" - ."\n" - .'refuse: does not modify the file that you want to modify but returns the information about the file that has the same name on the cloud.'."\n" - ."\n" - .'Default value: ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'refuse' => 'refuse', - 'auto_rename' => 'auto_rename', - 'ignore' => 'ignore', - ], - 'example' => 'ignore', - 'enum' => [ - 'ignore', - 'auto_rename', - 'refuse', - ], - ], - 'local_modified_at' => [ - 'description' => 'The local time when the file was modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format based on the UTC+0 time zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'hidden' => [ - 'description' => 'Specifies whether to hide the file.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'starred' => [ - 'description' => 'Specifies whether to add the file to favorites.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'async_task_id' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'required' => true, 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the file.'."\n", - '$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' => 'UpdateFile', - ], - 'SearchFile' => [ - 'summary' => 'Searches for files.', - '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' => 'The request body.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'query' => [ - 'description' => 'The search conditions. Fuzzy searches based on the file name or directory name are supported. The value of this parameter can be up to 4,096 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'not name=123', - 'maxLength' => 4096, - ], - 'order_by' => [ - 'description' => 'The field by which to sort the returned entries. Default value: created_at. Valid values:'."\n" + 'async_task_id' => ['title' => 'Id of the request', 'description' => 'Asynchronous task ID', 'type' => 'string', 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b'], + 'status' => [ + 'description' => '><warning>'."\n" ."\n" - .'* created_at: sorts the entries by creation time.'."\n" - .'* updated_at: sorts the entries by update time.'."\n" - .'* size: sorts the entries by file size.'."\n" - .'* name: sorts the entries by file name.'."\n" + .'Deprecated. Use the state field instead.'."\n" ."\n" - .'The order in which you want to sort the returned entries. Valid values:'."\n" + .'></warning>'."\n" ."\n" - .'* ASC: ascending order'."\n" - .'* DESC: descending order'."\n" + .'Task status'."\n" ."\n" - .'You must specify this parameter in the \\<field> \\<ASC or DESC> format. Separate multiple fields with commas (,). A preceding field has a higher priority than a following field. Examples:'."\n" + .'- Failed'."\n" ."\n" - .'* If you want to sort the entries by file name in ascending order, set this parameter to "name ASC".'."\n" - .'* If you want to sort the entries by creation time in descending order, set this parameter to "created_at DESC".'."\n" - .'* If you want to sort the entries by creation time in descending order and sort the entries by file name in ascending order in case of the same creation time, set this parameter to "created_at DESC,name ASC".'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'name', - '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' => 'The maximum number of entries to return. Valid values: 1 to 100.'."\n" + .'- Running'."\n" ."\n" - .'The number of returned entries must be less than or equal to the value of this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '50', - 'default' => '50', - ], - 'marker' => [ - 'description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned.\\'."\n" - .'This parameter is left empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'return_total_count' => [ - 'description' => 'Specifies whether to return the total number of retrieved files.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'recursive' => [ - 'description' => 'Specifies whether to perform recursive search on a folder that is specified by setting parent_file_id in the query parameter.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'thumbnail_processes' => [ - 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - '$ref' => '#/components/schemas/ImageProcess', - 'description' => 'The rules used to generate the thumbnails of images, videos, and documents.'."\n", - ], - ], - 'fields' => [ - 'description' => 'The field that is used to return additional information about files. Valid values:'."\n" + .'- PartialSucceed'."\n" ."\n" - .'* dir_size: returns the statistics on each subfolder in the response.'."\n" - .'* id_path: returns the id_path value of each child subject in the response.'."\n" - .'* name_path: returns the name_path value of each child subject in the response.'."\n" - ."\n" - .'You can specify multiple fields by separating them with commas (,). Example: "id_path,name_path,dir_size".'."\n", + .'- Succeed', + 'enumValueTitles' => ['Failed' => 'Failed', 'Running' => 'Running', 'PartialSucceed' => 'PartialSucceed', 'Succeed' => 'Succeed'], 'type' => 'string', - 'required' => false, - 'example' => 'url,thumbnail', + 'example' => 'Succeed', + 'title' => '', ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The information about the files.'."\n", + 'state' => ['description' => 'Task status'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- PartialSucceed'."\n" + ."\n" + .'- Succeed', 'type' => 'string', 'example' => 'Succeed', 'title' => ''], + 'message' => ['description' => '><warning>'."\n" + ."\n" + .'Deprecated. Use the error\\_message field instead.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'Asynchronous task error message', 'type' => 'string', 'example' => 'The request has been failed due to some unknown error. Please try again later.', 'title' => ''], + 'err_code' => ['description' => '><warning>'."\n" + ."\n" + .'Deprecated. Use the error\\_code field instead.'."\n" + ."\n" + .'></warning>'."\n" + ."\n" + .'Asynchronous task error code', 'type' => 'integer', 'format' => 'int64', 'example' => '404', 'title' => ''], + 'total_process' => ['description' => 'Total number of items to process for the asynchronous task, such as the number of files to package for server-side packaging and download.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'consumed_process' => ['description' => 'Total number of items processed for the asynchronous task, such as the number of files already packaged for server-side packaging and download.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'url' => ['description' => 'Download URL for data generated by the asynchronous task, such as the download URL generated by a server-side packaging and download task.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], + 'error_code' => ['description' => 'Task error code', 'type' => 'string', 'example' => 'InternalError', 'title' => ''], + 'error_message' => ['description' => 'Task error message', 'type' => 'string', 'example' => 'The request has been failed due to some unknown error. Please try again later.', 'title' => ''], + 'uncompress_file_list' => [ + 'description' => 'List of uncompressed file information', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file.'."\n", - '$ref' => '#/components/schemas/File', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'total_count' => [ - 'description' => 'The total number of retrieved files.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1022', + 'items' => ['description' => 'Uncompressed file information', '$ref' => '#/components/schemas/UncompressedFileInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'category' => ['description' => 'Custom task category', 'type' => 'string', 'example' => 'album', 'title' => ''], + 'created_at' => ['description' => 'Task creation time, ISO format, such as: 2019-03-28T13:03:29.298Z', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'title' => ''], + 'started_at' => ['description' => 'Task start time, ISO format, such as: 2019-03-28T13:03:29.298Z', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'title' => ''], + 'finished_at' => ['description' => 'Task completion time, ISO format, such as: 2019-03-28T13:03:29.298Z', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'title' => ''], + 'skipped_process' => ['description' => 'Number of skipped items for the asynchronous task', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'failed_process' => ['description' => 'Number of failed items for the asynchronous task', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'task_type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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' => 'SearchFile', - ], - 'ListFile' => [ - 'summary' => 'Queries a list of files and folders.', - 'path' => '/v2/file/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'Obtain asynchronous task information', + 'summary' => 'Retrieves information about an asynchronous task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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\\": \\"5060\\",\\n \\"file_id\\": \\"66972349b2b12fa309a143fb9db29647b2ddabfd\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"1.mov\\",\\n \\"size\\": 218052,\\n \\"updated_at\\": 1721368014000,\\n \\"items\\": [\\n {\\n \\"drive_id\\": \\"5060\\",\\n \\"file_id\\": \\"66972349b2b12fa309a143fb9db29647b2ddabfd\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"1.mov\\",\\n \\"size\\": 218052,\\n \\"updated_at\\": 1721368014000,\\n \\"items\\": [\\n {\\n \\"drive_id\\": \\"5060\\",\\n \\"file_id\\": \\"66972349b2b12fa309a143fb9db29647b2ddabfd\\",\\n \\"is_folder\\": true,\\n \\"name\\": \\"1.mov\\",\\n \\"size\\": 218052,\\n \\"updated_at\\": 1721368014000,\\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 \\"task_type\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetDefaultDrive' => [ + 'path' => '/v2/drive/get_default_drive', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -8815,471 +4811,138 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID. If you want to share a file, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'parent_file_id' => [ - 'description' => 'The ID of the parent folder. If the parent folder is a root directory, set this parameter to root.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'root', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100.'."\n" - ."\n" - .'The number of returned entries must be less than or equal to the value of this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'marker' => [ - 'description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned.\\'."\n" - .'This parameter is left empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'status' => [ - 'description' => 'The state of the files to return. Valid values:'."\n" - ."\n" - .'available: returns only normal files. uploading: returns only files that are being uploaded.'."\n" - ."\n" - .'By default, only files in the available state are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'available' => '', - 'uploading' => '', - ], - 'example' => 'available', - 'enum' => [ - 'uploading', - 'available', - ], - ], - 'order_by' => [ - 'description' => 'The sorting field. Valid values:'."\n" - ."\n" - .'created_at: sorts the entries by creation time. updated_at: sorts the entries by update time. size: sorts the entries by file size. name: sorts the entries by file name.'."\n" - ."\n" - .'Default value: created_at.'."\n" - ."\n" - .'Enumeration:'."\n" - ."\n" - .'* updated_at: update time'."\n" - .'* size: file size'."\n" - .'* name: file name'."\n" - .'* created_at: creation time'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'updated_at' => '', - 'size' => '', - 'name' => '', - 'created_at' => '', - ], - 'example' => 'updated_at', - ], - 'order_direction' => [ - 'description' => 'The sorting direction. Valid values:'."\n" - ."\n" - .'ASC: ascending order DESC: descending order'."\n" - ."\n" - .'Default value: ASC.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], - 'example' => 'ASC', - 'enum' => [ - 'ASC', - 'DESC', - ], - ], - 'category' => [ - 'description' => 'The file category. Valid values:'."\n" - ."\n" - .'app: installation package zip: compressed package image doc: document video audio others'."\n" - ."\n" - .'By default, files of all categories are returned.'."\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' => 'The file type. Valid values:'."\n" - ."\n" - .'file: returns only files. folder: returns only folders.'."\n" - ."\n" - .'By default, files of all types are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'file' => '', - 'folder' => '', - ], - 'example' => 'file', - 'enum' => [ - 'file', - 'folder', - ], - ], - 'fields' => [ - 'description' => 'The field that is used to return additional information about a child subject. Valid values:'."\n" - ."\n" - .'* url: returns the URL of the thumbnail of a file in the response.'."\n" - .'* exif: returns the Exchangeable Image File Format (EXIF) data of a file in the response.'."\n" - .'* cropping_suggestion: returns the cropping suggestion on a file in the response.'."\n" - .'* characteristic_hash: returns the characteristic hash value of a file in the response.'."\n" - .'* video_metadata: returns the metadata of a video file, such as the video duration, bitrate, height, and width, in the response.'."\n" - .'* video_preview_metadata: returns the transcoding information of a video file, such as the transcoding specification for each definition, in the response.'."\n" - .'* investigation_info: returns the investigation information in the response.'."\n" - .'* dir_size: returns the statistics on each subfolder in the response.'."\n" - .'* user_tags: returns the user tags of each child subject in the response.'."\n" - ."\n" - .'You can specify multiple fields by separating them with commas (,). Example: "url,dir_size,user_tags".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'thumbnail_processes' => [ - 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - '$ref' => '#/components/schemas/ImageProcess', - 'description' => 'The rules used to generate the thumbnails of images, videos, and documents.'."\n", - ], - ], + 'user_id' => ['description' => 'The user ID. This parameter is required when you use an AK but optional when you use an access token. If omitted, the ID of the user associated with the access token is used.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The queried files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried file.'."\n", - '$ref' => '#/components/schemas/File', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - ], - ], + 'schema' => ['description' => 'The details of the default drive.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], ], ], - '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' => 'ListFile', - ], - 'GetFile' => [ - 'summary' => 'Queries the information about a file.', - 'path' => '/v2/file/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetDefaultDrive', + 'summary' => 'Retrieves the default drive for a specified user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n}","type":"json"}]', + ], + 'GetDomain' => [ + 'summary' => 'Obtain domain information.', + 'path' => '/v2/domain/get', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + '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' => 'The request body.'."\n", + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'url_expire_sec' => [ - 'description' => 'The time when the file expires. Unit: seconds. Valid values: 10 to 14400.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '14400', - 'minimum' => '10', - 'example' => '100', - ], - 'fields' => [ - 'description' => 'The fields to return.'."\n" - ."\n" - .'1. If this parameter is set to \\*, all fields of the file except the fields that must be specified are returned.'."\n" - .'2. If only specific fields are required, you can specify the following fields: url, thumbnail, exif, cropping_suggestion, characteristic_hash, video_metadata, and video_preview_metadata. If multiple fields are required, separate them with commas (,). Example: url,thumbnail.'."\n" - .'3. The investigation_info field is returned only if it is specified.'."\n" - ."\n" - .'By default, all fields except the fields that must be specified are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'thumbnail_processes' => [ - 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - '$ref' => '#/components/schemas/ImageProcess', - 'description' => 'The rules used to generate the thumbnails of images, videos, and documents.'."\n", - ], - ], - 'share_id' => [ - 'description' => 'The share ID. If you want to share a file, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], + 'domain_id' => ['description' => 'The ID of the domain.', 'type' => 'string', 'required' => true, 'example' => 'bj1', 'title' => ''], + 'get_quota_used' => ['description' => 'Specifies whether to return the used quota of the domain. Default value: false. If the quota of the domain is greater than 0 and you set this parameter to true, the used quota of the domain is returned.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'fields' => ['description' => 'The domain property fields to obtain, separated by commas. An empty value indicates that no enumeration fields are obtained.', 'type' => 'string', 'required' => false, 'example' => 'file_category', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - '$ref' => '#/components/schemas/File', - ], + 'schema' => ['description' => 'The information about the domain.', '$ref' => '#/components/schemas/Domain', 'title' => '', 'example' => ''], ], ], - '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' => 'GetFile', - ], - 'DownloadFile' => [ - 'summary' => 'Downloads a file.', - 'path' => '/v2/file/download', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"bj1\\",\\n \\"domain_id\\": \\"bj2\\",\\n \\"domain_name\\": \\"pdsdomain\\",\\n \\"description\\": \\"my domain\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 1073741824,\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"size_quota\\": 1099511627776,\\n \\"size_quota_used\\": 1099511627776,\\n \\"user_count_quota\\": 50,\\n \\"status\\": 1,\\n \\"used_size\\": 1099511627776,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"deny\\",\\n \\"except_app_id_list\\": [\\n \\"8ovxCTRUDdbpVWBP\\"\\n ]\\n },\\n \\"sharable\\": false,\\n \\"data_hash_name\\": \\"sha1\\",\\n \\"store_redundancy_type\\": \\"LRS\\"\\n}","type":"json"}]', + 'title' => 'Obtain Domain', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetDomainQuota' => [ + 'path' => '/v2/domain/get_quota', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/x-www-form-urlencoded', - ], - 'produces' => [ - 'application/octet-stream', ], + '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' => 'share_id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The share ID. If you want to manage a file by using a share link, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - ], - [ - 'name' => 'drive_id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'file_id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - ], - [ - 'name' => 'image_thumbnail_process', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method used to generate the thumbnail of an image. If this parameter is specified, you are redirected to the URL of the generated thumbnail.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0', - ], - ], - [ - 'name' => 'video_thumbnail_process', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method used to generate the thumbnail of a video. If this parameter is specified, you are redirected to the URL of the generated thumbnail.'."\n", - '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' => 'The method used to generate the thumbnail of a document. If this parameter is specified, you are redirected to the URL of the generated thumbnail.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,w_200', - ], - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [], 'responses' => [ - 302 => [ - 'headers' => [ - 'location' => [ - 'schema' => [ - 'title' => '下载地址', - 'type' => 'string', - ], + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'size_quota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'size_used' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'user_count_quota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'user_count_used' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DownloadFile', - 'description' => 'For information about best practices for downloading a file.', - ], - 'GetUploadUrl' => [ - 'summary' => 'Queries the upload URL of a file.', - 'path' => '/v2/file/get_upload_url', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => ' Get domain quota ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"size_quota\\": 0,\\n \\"size_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"user_count_used\\": 0\\n}","type":"json"}]', + 'title' => '', + ], + 'GetDownloadUrl' => [ + 'path' => '/v2/file/get_download_url', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -9288,23 +4951,28 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'share_id' => ['description' => 'The share ID. If you access the file through a share, include the `x-share-token` header for authentication and provide this field. In that case, the `drive_id` field is ignored. Otherwise, use an AccessKey pair or an access token for authentication and provide the `drive_id` field. You must specify either `share_id` or `drive_id`.'], + 'drive_id' => ['description' => 'The drive ID.'], + 'file_id' => ['description' => 'The file ID.'], + 'file_name' => ['description' => 'The file name. The maximum length is 1,024 characters.'], + 'expire_sec' => ['description' => 'The time-to-live (TTL) of the download URL, in seconds. The maximum value is 115200. The default value is 900.'], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -9312,104 +4980,21 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', - ], - 'upload_id' => [ - 'description' => 'The ID of the upload task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10166D06127B413BA1EC8ABB1144D111', - ], - 'part_info_list' => [ - 'description' => 'The information about the file parts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'part_number' => [ - 'description' => 'The serial number of a part.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'parallel_sha1_ctx' => [ - 'description' => 'The SHA-1 hash value of the file content before the file part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'type' => 'object', - 'properties' => [ - 'h' => [ - 'description' => 'The first to fifth 32-bit variables of the SHA-1 hash value of the file content before the file part. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The first to fifth 32-bit variables of the SHA-1 hash value of the file content before the file part.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'part_offset' => [ - 'description' => 'The size of the file part. Unit: bytes. The value must be a multiple of 64. This parameter takes effect only if the parallel upload feature is enabled.'."\n", - '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', - ], - ], - 'part_offset' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'share_id' => ['description' => 'The share ID.'."\n" + .'If you access the file through a share, include the `x-share-token` header for authentication and provide this field. In that case, the `drive_id` field is ignored. Otherwise, use an AccessKey pair or an access token for authentication and provide the `drive_id` field.'."\n" + .'You must specify either `share_id` or `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'file_name' => ['description' => 'The file name. The maximum length is 1,024 characters.', 'type' => 'string', 'example' => '1.txt', 'maxLength' => 1024, 'minLength' => 1, 'required' => false, 'title' => ''], + 'expire_sec' => ['description' => 'The time-to-live (TTL) of the download URL, in seconds. The maximum value is 115200. The default value is 900.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '115200', 'minimum' => '1', 'default' => '900', 'required' => false, 'example' => '100', 'title' => ''], + 'response_content_type' => ['type' => 'string', 'example' => 'video/mp4', 'description' => '', 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -9417,192 +5002,86 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', - ], - 'upload_id' => [ - 'description' => 'The ID of the upload task.'."\n", - 'type' => 'string', - 'example' => '10166D06127B413BA1EC8ABB1144D111', - ], - 'create_at' => [ - 'description' => 'The time when the upload task was created.'."\n", - 'type' => 'string', - 'example' => '2019-09-11T16:34:36.977Z', - ], - 'part_info_list' => [ - 'description' => 'The information about the file parts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file part.'."\n", - '$ref' => '#/components/schemas/UploadPartInfo', - ], - ], + 'url' => ['title' => 'Id of the request', 'description' => 'The public download URL. If you enable intelligent data endpoints, the system selects the best network line for the customer and returns a download URL with the corresponding domain name.', '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' => 'The download URL for use within a Virtual Private Cloud (VPC). This field is not used if you enable intelligent data endpoints. In that case, the system automatically returns the appropriate URL in the url field. To use this field, contact PDS technical support.', 'type' => 'string', 'example' => 'https://data-vpc.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt', 'title' => ''], + 'cdn_url' => ['description' => 'The Content Delivery Network (CDN) download URL. This field is not used if you enable intelligent data endpoints. In that case, the system automatically returns the appropriate URL in the url field. To use this field, contact PDS technical support.', 'type' => 'string', 'example' => 'https://data-cdn.aliyunpds.com/hz22%2F5d79219b0aa9a7c995a94a96993ba3205cd91c5a%2F5d79219bf3261a5d38744da0834ed489b677a27a?Expires=xxxOSSAccessKeyId=xxx&Signature=xxx&response-content-disposition=attachment%3Bfilename%3DtBiZAoJPC2c8b13450eda4292b7f5f8010618e078.txt', 'title' => ''], + 'expiration' => ['description' => 'The expiration time of the download URL.', 'type' => 'string', 'example' => '2022-01-02T15:04:05.999Z07:00', 'title' => ''], + 'size' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'crc64_hash' => ['description' => 'The CRC-64 value.', 'type' => 'string', 'example' => '5498595269368962671', 'title' => ''], + 'content_hash' => ['description' => 'The hash of the file content.', 'type' => 'string', 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA1', 'title' => ''], + 'content_hash_name' => ['description' => 'The name of the hash algorithm for the file content.', 'type' => 'string', 'example' => 'sha1', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'GetUploadUrl', - ], - 'ListUploadedParts' => [ - 'summary' => 'Queries the file parts that are uploaded.', - 'path' => '/v2/file/list_uploaded_parts', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetDownloadUrl', + 'summary' => 'Retrieves the download URL for a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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"}]', + ], + 'GetDrive' => [ + 'summary' => 'Returns information about a drive.', + 'path' => '/v2/drive/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'part_number_marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'upload_id' => [ - 'description' => 'The ID of the upload task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '00166D06127B413BA1EC8ABB1144D101', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2', - ], - 'drive_id' => [ - 'description' => 'The drive ID. This parameter is required if the file is not uploaded by using the share URL of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'share_id' => [ - 'description' => 'The share ID. This parameter is required if the file is uploaded by using the share URL of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'title' => 'Id of the request', - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2', - ], - 'upload_id' => [ - 'description' => 'The ID of the upload task.'."\n", - 'type' => 'string', - 'example' => '00166D06127B413BA1EC8ABB1144D101', - ], - 'uploaded_parts' => [ - 'description' => 'The information about the file parts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file part.'."\n", - '$ref' => '#/components/schemas/UploadPartInfo', - ], - ], - 'next_part_number_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'parallel_upload' => [ - 'description' => 'Indicates whether the parallel upload feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], + 'schema' => ['description' => 'A drive object.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], ], ], - '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' => 'ListUploadedParts', - ], - 'CompleteFile' => [ - 'summary' => 'Completes the upload of a file.', - 'path' => '/v2/file/complete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetDrive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n}","type":"json"}]', + ], + 'GetFile' => [ + 'path' => '/v2/file/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -9611,82 +5090,71 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'upload_id' => [ - 'description' => 'The upload ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'C9DCFE5A82644AC7A02DB74C30C934A6', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'crc64_hash' => [ - 'type' => 'string', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'url_expire_sec' => ['description' => 'The expiration time in seconds. The value must be an integer from 10 to 14,400, inclusive.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '14400', 'minimum' => '10', 'required' => false, 'example' => '100', 'title' => ''], + 'fields' => ['description' => 'Specifies which fields to return:'."\n" + ."\n" + .'1. If you set this parameter to `*`, this operation returns all file fields, except for those that must be explicitly requested.'."\n" + ."\n" + .'2. To return specific fields, provide a comma-separated list, such as `url,thumbnail`. Supported fields include `url`, `thumbnail`, `exif`, `cropping_suggestion`, `characteristic_hash`, `video_metadata`, and `video_preview_metadata`.'."\n" + ."\n" + .'3. You must include `investigation_info` in the value to retrieve the `investigation_info` field.'."\n" + ."\n" + .'By default, this operation returns all file fields, except for those that require an explicit request.', 'type' => 'string', 'example' => '*', 'required' => false, 'title' => ''], + 'thumbnail_processes' => [ + 'description' => 'Specifies the thumbnail configuration. Request up to five thumbnails in a single call by defining custom keys for the map. The response returns the URL for each requested thumbnail under its corresponding key.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Defines the processing rules for image, video, and document thumbnails.', '$ref' => '#/components/schemas/ImageProcess', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'share_id' => ['description' => 'The share ID. To access a file in a share, provide this parameter and authenticate with the `x-share-token` header, in which case `drive_id` is ignored. Otherwise, provide `drive_id` and authenticate with an AccessKey pair or an `access_token`. You must specify either `share_id` or `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The information about the file.'."\n", - '$ref' => '#/components/schemas/File', - ], + 'schema' => ['description' => 'The file object.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], ], ], - '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' => 'CompleteFile', - ], - 'MoveFile' => [ - 'summary' => 'Moves files or folders.', - 'path' => '/v2/file/move', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetFile', + 'summary' => 'Gets the details of a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n}","type":"json"}]', + ], + 'GetGroup' => [ + 'summary' => 'Retrieves information about a group.', + 'path' => '/v2/group/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -9695,143 +5163,49 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'to_parent_file_id' => [ - 'description' => 'The ID of the destination parent directory to which you want to move a file or folder. If you want to move a file or folder to the root directory, set this parameter to root.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6520943DC261', - ], - 'check_name_mode' => [ - 'description' => 'The processing method that is used if the file that you want to move has the same name as an existing file in the destination directory. Valid values:'."\n" - ."\n" - .'ignore: allows you to move the file by using the same name as an existing file in the destination directory.'."\n" - ."\n" - .'auto_rename: automatically renames the file that has the same name exists in the destination directory. By default, the current point in time is added to the end of the file name. Example: xxx\\_20060102\\_150405.'."\n" - ."\n" - .'refuse: does not move the file that you want to move but returns the information about the file that has the same name in the destination directory.'."\n" - ."\n" - .'Default value: ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ignore', - 'enum' => [ - 'ignore', - 'auto_rename', - 'refuse', - ], - ], + 'group_id' => ['description' => 'The ID of the group to retrieve.', 'type' => 'string', 'required' => true, 'example' => '2e43ec8427dd45f19431b7504649a1b1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'fileid1', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'If an empty string is returned, the file is moved.'."\n" - ."\n" - .'If a non-empty string is returned, an asynchronous task is required. You can call the GetAsyncTask operation to obtain the information about an asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '23ebd1a24dba4166b1527add476ef2866051b4d5del106', - ], - 'exist' => [ - 'description' => 'Indicates whether the file already exists in the destination directory.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'revision_id' => [ - 'type' => 'string', - ], - 'file_name' => [ - 'type' => 'string', - ], - 'updated_at' => [ - 'type' => 'string', - ], - ], - ], + 'schema' => ['description' => 'The details of the group.', '$ref' => '#/components/schemas/Group', 'title' => '', 'example' => ''], ], ], - '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' => 'MoveFile', - ], - 'CopyFile' => [ - 'summary' => 'Copies a file or folder.', - 'path' => '/v2/file/copy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"group_id\\": \\"b45c0c0c373c41ec9ebb5c85a025a08f\\",\\n \\"group_name\\": \\"test group\\",\\n \\"description\\": \\"created by system\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + ], + 'GetIdentityToBenefitPkgMapping' => [ + 'summary' => 'Retrieves the mapping between an identity and a benefit package. Use this operation to query the benefit packages that are bound to a user.', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/get', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -9840,269 +5214,134 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID. If you want to manage a file by using a share link, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID or folder ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', - ], - 'to_drive_id' => [ - 'description' => 'The ID of the drive to which you want to copy the file or folder. Default value: the value of drive_id.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'to_parent_file_id' => [ - 'description' => 'The ID of the destination parent folder. If you want to copy the file or folder to a root directory, set this parameter to root.'."\n", + 'identity_type' => [ + 'description' => 'The type of the identity. Set the value to `user` to manage user benefits.', 'type' => 'string', 'required' => true, - 'example' => '6520943DC261', - ], - 'auto_rename' => [ - 'description' => 'Specifies whether to automatically rename the file if the file name already exists in the destination folder. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'enum' => ['user'], + 'example' => 'user', + 'title' => '', ], + 'identity_id' => ['description' => 'The unique ID of the identity.'."\n" + ."\n" + .'To manage user benefits, set this parameter to the user ID.', 'type' => 'string', 'required' => true, 'example' => 'user123', 'title' => ''], + 'benefit_pkg_id' => ['description' => 'The unique ID of the benefit package.', 'type' => 'string', 'required' => true, 'example' => '40cb7794c9294', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The ID of the copied file or folder.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'If a file is copied, this parameter is not returned. If a folder is copied, the folder is asynchronously copied in the background and this parameter is returned. You can call the GetAsyncTask operation to query the information about the asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'Information about the benefit package associated with the identity.', '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', 'title' => '', 'example' => ''], ], ], - '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' => 'CopyFile', - ], - 'GetDownloadUrl' => [ - 'summary' => 'Queries the download URL of a file. For more information about best practices, visit https://help.aliyun.com/document_detail/175889.html.', - 'path' => '/v2/file/get_download_url', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetIdentityToBenefitPkgMapping', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"identity_type\\": \\"user\\",\\n \\"identity_id\\": \\"user123\\",\\n \\"benefit_pkg_owner_id\\": \\"bj1\\",\\n \\"benefit_pkg_id\\": \\"40cb7794c9294\\",\\n \\"benefit_pkg_type\\": \\"user_identity\\",\\n \\"benefit_pkg_name\\": \\"高级会员\\",\\n \\"benefit_pkg_priority\\": 1,\\n \\"benefit_pkg_computation_rule\\": \\"sum\\",\\n \\"delivery_info_list\\": [\\n {\\n \\"amount\\": 1,\\n \\"is_permanent\\": false,\\n \\"expire_time\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\"\\n }\\n ],\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\"\\n}","type":"json"}]', + ], + 'GetLinkInfo' => [ + 'summary' => 'Retrieves account information.', + 'path' => '/v2/account/get_link_info', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID. If you want to manage a file by using a sharing link, carry the `x-share-token` header in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify at least either `share_id` or `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'file_name' => [ - 'description' => 'The name of the file. The name can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.txt', - 'maxLength' => 1024, - 'minLength' => 1, - ], - 'expire_sec' => [ - 'description' => 'The validity period of the download URL. Maximum value: 115200. Default value: 900. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '115200', - 'minimum' => '1', - 'example' => '100', - 'default' => '900', - ], - 'response_content_type' => [ - 'type' => 'string', - 'example' => 'video/mp4', - ], + 'type' => ['description' => 'The account type. Valid values:'."\n" + ."\n" + .'- `mobile`: A mobile number.'."\n" + ."\n" + .'- `email`: An email address.'."\n" + ."\n" + .'- `ding`: A DingTalk account.'."\n" + ."\n" + .'- `ram`: An Alibaba Cloud RAM user.'."\n" + ."\n" + .'- `wechat`: A WeCom account.'."\n" + ."\n" + .'- `ldap`: An LDAP account.'."\n" + ."\n" + .'- `custom`: A custom account.', 'type' => 'string', 'required' => true, 'example' => 'mobile', 'title' => ''], + 'identity' => ['description' => 'The account\'s unique identifier, such as a mobile number.', 'type' => 'string', 'required' => true, 'example' => '130***', 'title' => ''], + 'extra' => ['description' => 'Additional information for the unique identifier. For example, if the account type is `mobile`, this is the country calling code.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'url' => [ - 'title' => 'Id of the request', - 'description' => 'The download URL of a file that is downloaded over the Internet.'."\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' => 'The download URL of a file that is downloaded over a virtual private cloud (VPC).'."\n", - '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' => 'The download URL of a file that is downloaded by using Alibaba Cloud CDN.'."\n", - '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' => 'The time when the download URL expires.'."\n", - 'type' => 'string', - 'example' => '2022-01-02T15:04:05.999Z07:00', - ], - 'size' => [ - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'crc64_hash' => [ - 'description' => 'The hash value calculated by using 64-bit cyclic redundancy check (CRC-64).'."\n", - 'type' => 'string', - 'example' => '5498595269368962671', - ], - 'content_hash' => [ - 'description' => 'The hash value of the file content.'."\n", - 'type' => 'string', - 'example' => 'EA4942AA8761213890A5C386F88E6464D2C31CA1', - ], - 'content_hash_name' => [ - 'description' => 'The name of the algorithm that is used to calculate the hash value of the file content.'."\n", - 'type' => 'string', - 'example' => 'sha1', - ], - ], - ], + 'headers' => [], + 'schema' => ['description' => 'The user account information.', '$ref' => '#/components/schemas/AccountLinkInfo', 'title' => '', 'example' => ''], ], ], - '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' => 'GetDownloadUrl', - ], - 'FilePutUserTags' => [ - 'summary' => 'Adds custom tags to a file.', - 'path' => '/v2/file/put_usertags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'api', + 'title' => 'GetLinkInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"authentication_type\\": \\"mobile\\",\\n \\"identity\\": \\"136***000\\",\\n \\"extra\\": \\"86\\",\\n \\"user_id\\": \\"00016a587b62b50003deea299a4f5b50\\",\\n \\"created_at\\": 1639762579768,\\n \\"display_name\\": \\"001\\",\\n \\"status\\": \\"normal\\",\\n \\"last_login_time\\": 1639762579769\\n}","type":"json"}]', + ], + 'GetLinkInfoByUserId' => [ + 'path' => '/v2/account/get_link_info_by_user_id', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -10111,113 +5350,69 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'user_tags' => [ - 'description' => 'The tags to be added to the file. You cannot leave this parameter empty. You can specify up to 1,000 tags. You cannot specify tags that have the same name.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The name of the tag. The tag name cannot be empty and cannot contain number signs (#).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tag', - 'pattern' => '^[^#]+$', - ], - 'value' => [ - 'description' => 'The value of the tag. The tag value cannot contain number signs (#).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - 'pattern' => '^[^#]+$', - ], - ], - 'required' => true, - ], - 'required' => true, - 'maxItems' => 1000, - 'minItems' => 1, - ], + 'user_id' => ['description' => 'User ID to query.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response struct.', 'type' => 'object', 'properties' => [ - 'file_id' => [ - 'title' => 'Id of the request', - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', + 'items' => [ + 'title' => 'items', + 'description' => 'List of user account information.', + 'type' => 'array', + 'items' => ['description' => 'User account information.', '$ref' => '#/components/schemas/AccountLinkInfo', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"file_id\\": \\"9520943DC264\\"\\n}","type":"json"}]', - 'title' => 'FilePutUserTags', - 'description' => 'This operation is an incremental update operation. Take note of the following items:'."\n" - ."\n" - .'* If a tag name specified in the request is the same as an existing tag name, the existing tag is overwritten.'."\n" - .'* If a tag name specified in the request is different from the existing tag names, the specified tag is added.'."\n" - .'* The existing tags with unique names are not affected.'."\n", - ], - 'FileDeleteUserTags' => [ - 'summary' => 'Removes custom tags from a file.', - 'path' => '/v2/file/delete_usertags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'api', + 'title' => 'GetLinkInfoByUserId', + 'summary' => 'Obtain account information by user ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"authentication_type\\": \\"mobile\\",\\n \\"identity\\": \\"136***000\\",\\n \\"extra\\": \\"86\\",\\n \\"user_id\\": \\"00016a587b62b50003deea299a4f5b50\\",\\n \\"created_at\\": 1639762579768,\\n \\"display_name\\": \\"001\\",\\n \\"status\\": \\"normal\\",\\n \\"last_login_time\\": 1639762579769\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetRevision' => [ + 'path' => '/v2/file/revision/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -10226,81 +5421,57 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'key_list' => [ - 'description' => 'The tags that you want to remove from a file. You cannot leave this parameter empty. You can specify up to 1,000 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the tag. The name cannot contain a number sign (#).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tag', - 'pattern' => '^[^#]+$', - ], - 'required' => true, - 'maxItems' => 1000, - 'minItems' => 1, - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'revision_id' => ['description' => 'The revision ID.', 'type' => 'string', 'required' => true, 'example' => '40CB7794C929', 'title' => ''], + 'url_expire_sec' => ['description' => 'The URL expiration time in seconds. The value must be between 10 and 86400.'."\n" + ."\n" + .'The default value is 900 seconds (15 minutes).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900', 'title' => ''], + 'fields' => ['description' => 'Specifies the fields to return.'."\n" + ."\n" + .'By default, this parameter is empty. If you set this parameter to an asterisk (\\*), all fields are returned, including the creator name.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'FileDeleteUserTags', - ], - 'VideoDRMLicense' => [ - 'summary' => 'Obtain the digital rights management (DRM) license of a video.', - 'path' => '/v2/file/video_drm_license', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 200 => [ + 'schema' => ['description' => 'The revision details.', '$ref' => '#/components/schemas/Revision', 'title' => '', 'example' => ''], + ], ], - 'tags' => [ - 'api', + 'title' => 'GetRevision', + 'summary' => 'Retrieves the details of a file revision.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"9520943DC264\\",\\n \\"revision_id\\": \\"40CB7794C929\\",\\n \\"revision_name\\": \\"1.mov\\",\\n \\"revision_version\\": 1,\\n \\"size\\": 1024,\\n \\"file_extension\\": \\"mov\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"keep_forever\\": false,\\n \\"revision_description\\": \\"aaa\\",\\n \\"is_latest_version\\": false,\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\"\\n}","type":"json"}]', + ], + 'GetShareLink' => [ + 'path' => '/v2/share_link/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -10309,278 +5480,188 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drmType' => [ - 'description' => 'The type of DRM encryption.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* fairplay'."\n" - .'* widevine'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'fairplay' => 'fairplay', - 'widevine' => 'widevine', - ], - 'example' => 'widevine', - ], - 'licenseRequest' => [ - 'description' => 'The request that is initiated to obtain the license.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAES6B8SQgpACioSENGxDhqCLIVwwCBOyPayyWoSENGxDhqCLIVwwCBOyPayyWpI88aJmwYQARoQdRV32', - ], + 'share_id' => ['description' => 'The share ID.', 'type' => 'string', 'required' => true, 'example' => '7JQX1FswpQ8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'data' => [ - 'description' => 'The returned DRM license.'."\n", - 'type' => 'string', - 'example' => 'cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3', - ], - 'states' => [ - 'description' => 'The request state returned by the DRM server.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'device_info' => [ - 'description' => 'The information about the device from which the DRM request was initiated.'."\n", - 'type' => 'string', - 'example' => '""', - ], - ], - ], + 'schema' => ['description' => 'The details of the share link.', '$ref' => '#/components/schemas/ShareLink', 'title' => '', 'example' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3\\",\\n \\"states\\": \\"0\\",\\n \\"device_info\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', - 'title' => 'VideoDRMLicense', - ], - 'DeleteRevision' => [ - 'summary' => 'Deletes a historical version of a file. You cannot delete the latest version of a file.', - 'path' => '/v2/file/revision/delete', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetShareLink', + 'summary' => 'Retrieves information about a share link.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"share_pwd\\": \\"abcF123x\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id_list\\": [\\n \\"[\\\\\\"xx\\\\\\"]\\"\\n ],\\n \\"expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"expired\\": false,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"videos\\",\\n \\"share_name\\": \\"video-1.MP4\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"status\\": \\"enabled\\",\\n \\"preview_count\\": 10,\\n \\"save_count\\": 2,\\n \\"download_count\\": 5,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 1,\\n \\"access_count\\": 4,\\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 \\"share_all_files\\": true,\\n \\"save_download_limit\\": 100,\\n \\"office_editable\\": true\\n}","type":"json"}]', + ], + 'GetShareLinkByAnonymous' => [ + 'summary' => 'Retrieves the metadata of a share link without authentication.', + 'path' => '/v2/share_link/get_by_anonymous', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ - 'BearerToken' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of struct', - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body. For more information, see the following parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'revision_id' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40CB7794C929', - ], + 'share_id' => ['description' => 'The ID of the share.', 'type' => 'string', 'required' => true, 'example' => '7JQX1FswpQ8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [], + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'creator_id' => ['description' => 'The ID of the share\'s creator.', 'type' => 'string', 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'creator_name' => ['description' => 'The desensitized name of the share\'s creator.', 'type' => 'string', 'example' => 'AB***CD', 'title' => ''], + 'creator_phone' => ['description' => 'The desensitized phone number of the share\'s creator.', 'type' => 'string', 'example' => '136****00', 'title' => ''], + 'expiration' => ['description' => 'The expiration time of the share link, specified in UTC and formatted according to RFC 3339.', 'type' => 'string', 'example' => '2020-08-20T06:51:27.292Z', 'title' => ''], + 'updated_at' => ['description' => 'The time when the share link was last modified, specified in UTC and formatted according to RFC 3339.', 'type' => 'string', 'example' => '2019-08-20T06:51:27.292Z', 'title' => ''], + 'avatar' => ['description' => 'The URL of the creator\'s avatar.', 'type' => 'string', 'example' => 'https://aliyunpds.com/a.jpg', 'title' => ''], + 'share_name' => ['description' => 'The name of the share.', 'type' => 'string', 'example' => 'LectureRoom-1.MP4', 'title' => ''], + 'preview_count' => ['description' => 'The total number of times the shared content has been previewed.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'save_count' => ['description' => 'The total number of times the shared content has been saved.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'download_count' => ['description' => 'The total number of times the shared content has been downloaded.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'report_count' => ['description' => 'The total number of times the share has been reported.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'video_preview_count' => ['description' => 'The total number of times a video in the share has been previewed.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'access_count' => ['description' => 'The total number of times the share link has been accessed.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'disable_preview' => ['description' => 'Specifies whether previews are disabled. If `true`, the shared content cannot be previewed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'disable_save' => ['description' => 'Specifies whether saving is disabled. If `true`, the shared content cannot be saved.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'disable_download' => ['description' => 'Specifies whether downloading is disabled. If `true`, the shared content cannot be downloaded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'preview_limit' => ['description' => 'The maximum number of previews allowed for the shared content.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'save_limit' => ['description' => 'The maximum number of saves allowed for the shared content.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'download_limit' => ['description' => 'The maximum number of downloads allowed for the shared content.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'save_download_limit' => ['description' => 'The maximum total number of saves and downloads allowed for the shared content.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'has_pwd' => ['description' => 'Specifies whether the share is protected by an access code.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteRevision', - ], - 'UpdateRevision' => [ - 'summary' => 'Updates the version information. You can call this operation to permanently retain a version or modify the description of a version. You can permanently retain up to 50 versions of a file.', - 'path' => '/v2/file/revision/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + '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\\": \\"LectureRoom-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' => 'GetShareLinkByAnonymous', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'GetShareLinkToken' => [ + 'path' => '/v2/share_link/get_share_token', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ - 'BearerToken' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'revision_id' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40CB7794C929', - ], - 'keep_forever' => [ - 'description' => 'Specifies whether to permanently retain a version.'."\n" - ."\n" - .'By default, this parameter is not specified, which indicates that you do not modify the permanent retention configuration of the version.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'revision_description' => [ - 'description' => 'The description of the version. The description can be up to 1,024 characters in length.'."\n" - ."\n" - .'By default, this parameter is not specified, which indicates that you do not modify the description of the version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aaa', - ], + 'share_id' => ['description' => 'The share ID.', 'type' => 'string', 'required' => true, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'share_pwd' => ['description' => 'The share password.', 'type' => 'string', 'required' => false, 'example' => 'abcF123x', 'title' => ''], + 'expire_sec' => ['description' => 'The requested validity period for the share token, in seconds. Valid values range from 1 to 7,200. If this parameter is omitted or set to 0, it defaults to 7,200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7200', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the version.'."\n", - '$ref' => '#/components/schemas/Revision', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'share_token' => ['title' => 'Id of the request', 'description' => 'The share token, in JWT format.', 'type' => 'string', 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs'], + 'expires_in' => ['description' => 'The duration, in seconds, until the token expires. For example, 7200 seconds (2 hours).', 'type' => 'integer', 'format' => 'int64', 'example' => '7200', 'title' => ''], + ], + 'example' => '', ], ], ], - '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' => 'UpdateRevision', - ], - 'RestoreRevision' => [ - 'summary' => 'Restores a historical version of a file. You cannot restore the latest version of a file.', - 'path' => '/v2/file/revision/restore', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetShareLinkToken', + 'summary' => 'Retrieves a share token anonymously.', + 'description' => 'A share token is required to access any shared file, including public ones that do not have a password (where the `share_pwd` parameter is empty).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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"}]', + ], + 'GetStory' => [ + 'summary' => 'Retrieves the details of a story, including its cover and file list.', + 'path' => '/v2/image/get_story', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -10589,78 +5670,65 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', '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' => true, - ], + 'schema' => ['description' => 'The ID of the domain.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Contains the request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'revision_id' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40CB7794C929', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The ID of the story.', 'type' => 'string', 'required' => true, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'cover_image_thumbnail_process' => ['description' => 'The processing parameters for the cover image thumbnail.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', 'title' => ''], + 'cover_video_thumbnail_process' => ['description' => 'The processing parameters for the cover video thumbnail.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', 'title' => ''], + 'image_url_process' => ['description' => 'The processing parameters for the URLs of images in the story.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', 'title' => ''], + 'image_thumbnail_process' => ['description' => 'The processing parameters for the thumbnails of images in the story.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', 'title' => ''], + 'video_thumbnail_process' => ['description' => 'The processing parameters for the thumbnails of videos in the story.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', 'title' => ''], + 'url_expire_sec' => ['description' => 'The expiration time of the thumbnail URL in seconds. The value must be an integer from 10 to 86,400.'."\n" + ."\n" + .'Default value: 900.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'maximum' => '86400', 'minimum' => '10', 'default' => '900', 'required' => false, 'example' => '900', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The information about the version.'."\n", - '$ref' => '#/components/schemas/Revision', - ], + 'schema' => ['description' => 'Contains the details of the story.', '$ref' => '#/components/schemas/Story', 'title' => '', 'example' => ''], ], ], - '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', - ], - 'ListRevision' => [ - 'summary' => 'Queries the versions of a file.', - 'path' => '/v2/file/revision/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain story details', + 'description' => '**Before calling this operation, ensure you understand the billing methods and [pricing](~~425220~~) of PDS**.'."\n" + ."\n" + .'You must activate the image processing value-added service to use this feature.'."\n" + ."\n" + .'This operation retrieves the details of a story.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\",\\n \\"story_type\\": \\"PeopleMemory\\",\\n \\"story_sub_type\\": \\"Solo\\",\\n \\"story_name\\": \\"test_name\\",\\n \\"story_start_time\\": \\"2021-01-14T10:17:18.102700407+08:00\\",\\n \\"story_end_time\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"created_at\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"updated_at\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"face_group_ids\\": [\\n \\"Cluster-be377f73-3502-433c-8309-a01e659c128c\\"\\n ],\\n \\"cover_file_id\\": \\"63e5e4340f76cb3ead5f40f68163f0f967c1a7bf\\",\\n \\"cover_file_thumbnail_url\\": \\"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\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"custom_id\\": \\"test\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key\\\\\\": \\\\\\"value\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + ], + 'GetTaskStatus' => [ + 'path' => '/v2/image/get_task_status', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -10669,75 +5737,31 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', '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' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.'."\n" - ."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '40CB7794C929', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 50.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '100', - ], - 'fields' => [ - 'description' => 'Specifies the returned fields.'."\n" - ."\n" - .'By default, this parameter is left empty. If you set this parameter to \\*, all fields are returned. If you leave this parameter empty, the creator of the file is not returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'task_id' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -10745,321 +5769,277 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The information about the versions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a version.'."\n", - '$ref' => '#/components/schemas/Revision', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", + 'status' => [ + 'description' => 'The status of the task.', + 'enumValueTitles' => ['running' => 'The task is running.', 'failed' => 'The task failed.', 'succeeded' => 'The task succeeded.'], 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + 'required' => false, + 'enum' => ['running', 'succeeded', 'failed'], + 'example' => 'running', + 'title' => '', ], ], + 'example' => '', ], ], ], - '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' => 'ListRevision', - ], - 'GetRevision' => [ - 'summary' => 'Queries the information about a version.', - 'path' => '/v2/file/revision/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetTaskStatus', + 'summary' => 'Gets the status of an asynchronous task for a value-added service.'."\n" + .'This API currently supports tasks created by operations such as `CreateSimilarImageClusterTask`.', + 'description' => '**Before calling this API, ensure you understand the billing methods and [pricing](~~425220~~) of PDS**.'."\n" + ."\n" + .'To use this feature, you must activate the image processing value-added service.'."\n" + ."\n" + .'To check the status of an asynchronous task for a value-added service, first obtain a task\\_id by calling an API such as `CreateSimilarImageClusterTask`. Then, call this API with the task\\_id to determine if the task has succeeded.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"running\\"\\n}","type":"json"}]', + ], + 'GetUploadUrl' => [ + 'summary' => 'Retrieves the upload address.', + 'path' => '/v2/file/get_upload_url', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'revision_id' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'share_id' => ['description' => 'The share ID.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', 'title' => ''], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'required' => true, 'example' => '10166D06127B413BA1EC8ABB1144D111', 'title' => ''], + 'part_info_list' => [ + 'description' => 'A list of file parts.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a single file part.', + 'type' => 'object', + 'properties' => [ + 'part_number' => ['description' => 'The part number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'parallel_sha1_ctx' => [ + 'description' => 'The SHA1 context for all data preceding this part. This parameter applies only to parallel uploads.', + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'description' => 'The five 32-bit state variables of the SHA1 context for all data preceding this part. This parameter applies only to parallel uploads.', + 'type' => 'array', + 'items' => ['description' => 'One of the five 32-bit variables of the SHA1 context.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'part_offset' => ['description' => 'The total size in bytes of all preceding parts. The value must be a multiple of 64. This parameter applies only to parallel uploads.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'content_md5' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'content_type' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'parallel_sha256_ctx' => [ + 'type' => 'object', + 'properties' => [ + 'h' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'part_offset' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '40CB7794C929', - ], - 'url_expire_sec' => [ - 'description' => 'The validity period of the file download or preview. Valid values: 10 to 86400.'."\n" - ."\n" - .'Default value: 900. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '900', - ], - 'fields' => [ - 'description' => 'Specifies the returned fields.'."\n" - ."\n" - .'By default, this parameter is left empty. If you set this parameter to \\*, all fields are returned. If you leave this parameter empty, the creator of the file is not returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the version.'."\n", - '$ref' => '#/components/schemas/Revision', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'example' => '5d5b846942cf94fa72324c14a4bda34e81da635d', 'title' => ''], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'example' => '10166D06127B413BA1EC8ABB1144D111', 'title' => ''], + 'create_at' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2019-09-11T16:34:36.977Z', 'title' => ''], + 'part_info_list' => [ + 'description' => 'The list of upload parts.', + 'type' => 'array', + 'items' => ['description' => 'Information about a single part.', '$ref' => '#/components/schemas/UploadPartInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], ], - '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' => 'GetRevision', - ], - 'ScanFile' => [ - 'summary' => 'Scans files.', - 'path' => '/v2/file/scan', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetUploadUrl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\",\\n \\"internal_upload_url\\": \\"https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\\\n\\",\\n \\"etag\\": \\"\\\\\\"0CC175B9C0F1B6A831C399E269772661\\\\\\"\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 10240\\n },\\n \\"upload_form_info\\": {\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"parallel_sha256_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetUser' => [ + 'path' => '/v2/user/get', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ + 'AK' => [], + ], + [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '50', - 'default' => '50', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", - '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' => 'The file properties to return.'."\n" - ."\n" - .'* If you want to return all file properties, set this parameter to \\*.'."\n" - .'* By default, if you do not specify this parameter, the following properties of a file are returned: - file_id, - drive_id, - parent_file_id, - type, - created_at, - updated_at, - file_extention, - size, - starred, - status, - category, and - permissions.'."\n" - .'* You can also specify properties to return. Separate multiple properties with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], + 'user_id' => ['description' => 'The user id. Required when authenticating with an AccessKey. If you use an access token, omit this parameter to retrieve your own user information.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The information about the files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file.'."\n", - '$ref' => '#/components/schemas/File', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - ], - ], + 'schema' => ['description' => 'User information', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], ], ], - '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' => 'ScanFile', - ], - 'ListDelta' => [ - 'summary' => 'Queries incremental information.', - 'path' => '/v2/file/list_delta', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetUser', + 'summary' => 'Retrieves user information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetVideoPreviewPlayInfo' => [ + 'path' => '/v2/file/get_video_preview_play_info', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], ], + [ + 'AK' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => '云端Drive id'."\n", - 'description' => 'The drive ID.'."\n", + 'share_id' => ['description' => 'Specify this parameter and use the `x-share-token` header for authentication when accessing a file from a share. In this scenario, `drive_id` is ignored. For all other cases, use an `AK/SK` pair or an `access token` for authentication and specify `drive_id`. You must specify either `share_id` or `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'category' => [ + 'description' => 'The transcoding category. The corresponding feature must be enabled. Valid values:'."\n" + ."\n" + .'- `live_transcoding`: live transcoding'."\n" + ."\n" + .'- `quick_video`: quick video transcoding'."\n" + ."\n" + .'- `offline_audio`: offline audio transcoding'."\n" + ."\n" + .'- `offline_video`: offline video transcoding', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '1', - ], - 'sync_root_id' => [ - 'title' => '如果是同步目录的增量信息，必须设置同步目录对应的云端根目录', - 'description' => 'The ID of the root file of the synced folder.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '622fb09598ae66777c7040109a16f49381f6abe1', - ], - 'cursor' => [ - 'title' => '增量信息的起始游标', - 'description' => 'The cursor of the incremental information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'title' => '获取增量信息的条数限制', - 'description' => 'The maximum number of results to return. Valid values: 0 to 100. Default value: 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'example' => 'quick_video', + 'title' => '', ], + 'template_id' => ['description' => 'The ID of the transcoding template. If this parameter is omitted, all available transcoding templates are retrieved.', 'type' => 'string', 'required' => false, 'example' => '264_480p', 'title' => ''], + 'get_without_url' => ['description' => 'Specifies whether to retrieve the playback URL. Set to `true` to return only transcoding metadata without triggering a transcode; the response will not include a playback URL. If set to `false` or omitted, the playback URL is returned. If the video has not yet been transcoded for the specified `template_id`, the backend initiates the process, which incurs value-added service fees.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'url_expire_sec' => ['description' => 'The expiration time of the URL, in seconds. Default value: 900 (15 minutes). Maximum value: 14400 (4 hours).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], + 're_transcode' => ['description' => 'Specifies whether to re-transcode the file. If set to `true`, the file is re-transcoded, and the API returns a `202` response, prompting you to wait and retry. Contact technical support to enable this parameter before use.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'get_master_url' => ['description' => 'Specifies whether to retrieve the URL of the master M3U8 playlist. This parameter is valid only when `category` is set to `quick_video`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -11067,118 +6047,97 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The incremental information returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'title' => '文件唯一id', - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '122fb09598ae66777c7040109a16f49381f6abe2', - ], - 'op' => [ - 'title' => '文件操作，主要包括', - 'description' => 'The operation that is performed. Valid values: Valid values:'."\n" - ."\n" - .'* create'."\n" - .'* overwrite'."\n" - .'* delete'."\n" - .'* update'."\n" - .'* move'."\n" - .'* trash'."\n" - .'* restore'."\n" - .'* rename'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'create', - ], - 'file' => [ - 'description' => 'The information about the file.'."\n", - '$ref' => '#/components/schemas/File', - ], - ], - ], - ], - 'has_more' => [ - 'description' => 'Indicates whether more information is returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'cursor' => [ - 'description' => 'The cursor of the incremental information.'."\n", - 'type' => 'string', - 'example' => '1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1', 'title' => ''], + 'share_id' => ['title' => 'Id of the request', 'description' => 'The share ID.', 'type' => 'string', 'example' => '7JQX1FswpQ8'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'fileid1', 'title' => ''], + 'video_preview_play_info' => ['description' => 'The detailed playback information, including transcoding status and URLs.', '$ref' => '#/components/schemas/VideoPreviewPlayInfo', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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' => 'ListDelta', - ], - 'DeltaGetLastCursor' => [ - 'summary' => 'Queries the cursor of incremental information.', - 'path' => '/v2/file/get_last_cursor', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'tags' => [ - 'api', + 'title' => 'GetVideoPreviewPlayInfo', + 'summary' => 'Gets video playback information.', + 'description' => '- **Before calling this API, ensure you understand the billing methods and [Pricing](~~425220~~) for Drive and Photo Service.**'."\n" + ."\n" + .'- Before calling this API, ensure the transcoding feature for the specified category is enabled for the current domain. To enable the feature and configure transcoding templates, contact technical support. For more information, see [Contact Us](~~175917~~).'."\n" + ."\n" + .'- This is a synchronous API. If the file has not been transcoded in the specified mode when you send the request, the API returns a **202 VideoPreviewWaitAndRetry** response, prompting you to wait and retry. If the file cannot be transcoded in the specified mode, the API returns a **404 NotFound.VideoPreviewInfo** response.'."\n" + ."\n" + .'- This API generates transcoded data and saves it to the tenant\'s value-added data space, allowing end users to play audio and video online. For specific transcoding modes, this API provides domain-level deduplicated transcoding.'."\n" + ."\n" + .'- When the transcoding type is `quick_video`, the returned playback URL contains unencoded `{ `and `}` characters. If you are developing for iOS, URL-decode and then URL-encode the returned URL to prevent decoding failures in the NSURL library.'."\n" + ."\n" + .'- When the transcoding type is `quick_video`, `Range` GET requests are not supported for retrieving segment content from the M3U8 playlist that corresponds to the playback URL.'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'For more information, see the best practice: [Online video preview](~~427477~~).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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\\": \\"quick_video\\",\\n \\"meta\\": {\\n \\"duration\\": 4.2898,\\n \\"width\\": 1920,\\n \\"height\\": 1080\\n },\\n \\"live_transcoding_task_list\\": [\\n {\\n \\"template_id\\": \\"264_480p\\",\\n \\"status\\": \\"finished\\",\\n \\"url\\": \\"https://example.data.aliyunpds.com/lt/xxx/media.m3u8\\",\\n \\"keep_original_resolution\\": true\\n }\\n ],\\n \\"quick_video_list\\": [\\n {\\n \\"template_id\\": \\"264_480p\\",\\n \\"status\\": \\"finished\\",\\n \\"url\\": \\"https://example.data.aliyunpds.com/qv/xxx/media.m3u8\\"\\n }\\n ],\\n \\"offline_video_transcoding_list\\": [\\n {\\n \\"template_id\\": \\"264_1080p\\",\\n \\"status\\": \\"finished\\",\\n \\"keep_original_resolution\\": true,\\n \\"url\\": \\"https://example.data.aliyunpds.com/xxx/master.mp4\\\\n\\"\\n }\\n ],\\n \\"live_transcoding_subtitle_task_list\\": [\\n {\\n \\"language\\": \\"en\\",\\n \\"status\\": \\"finished\\",\\n \\"url\\": \\"https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt\\"\\n }\\n ],\\n \\"quick_video_subtitle_list\\": [\\n {\\n \\"language\\": \\"en\\",\\n \\"status\\": \\"finished\\",\\n \\"url\\": \\"https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt\\"\\n }\\n ],\\n \\"offline_video_transcoding_subtitle_list\\": [\\n {\\n \\"language\\": \\"en\\",\\n \\"status\\": \\"finished\\",\\n \\"url\\": \\"https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt\\"\\n }\\n ],\\n \\"master_url\\": \\"https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8\\"\\n }\\n}","type":"json"}]', + ], + 'GetVideoPreviewPlayMeta' => [ + 'summary' => 'Retrieves the video playback metadata.', + 'path' => '/v2/file/get_video_preview_play_meta', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ + 'AK' => [], + ], + [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => '云端 drive id', - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'sync_root_id' => [ - 'title' => '同步目录的对应的云端跟目录', - 'description' => 'The ID of the root file of the synced folder.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '622fb09598ae66777c7040109a16f49381f6abe1', - ], + 'share_id' => ['description' => 'The ID of the share. To access a file from a share, specify this parameter and include the `x-share-token` header for authentication. In this case, `drive_id` is ignored. Alternatively, to access a file in a drive, specify `drive_id` and authenticate by using an AccessKey pair (`aksk`) or an access token (`access_token`). You must specify either `share_id` or `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'category' => ['description' => 'You must enable the corresponding transcoding feature. Valid values are:'."\n" + ."\n" + .'- `live_transcoding` (live transcoding)'."\n" + ."\n" + .'- `quick_video` (quick video transcoding)'."\n" + ."\n" + .'- `offline_audio` (offline audio transcoding)'."\n" + ."\n" + .'- `offline_video` (offline video transcoding)', 'type' => 'string', 'required' => true, 'example' => 'live_transcoding', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -11186,345 +6145,239 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'cursor' => [ - 'title' => '当前增量变化的最新游标', - 'description' => 'The latest cursor of incremental information in the specified drive or synced folder.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'share_id' => ['description' => 'The ID of the share.', 'type' => 'string', 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'example' => 'fileid1', 'title' => ''], + 'video_preview_play_meta' => ['description' => 'The playback metadata.', '$ref' => '#/components/schemas/VideoPreviewPlayMeta', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cursor\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', - 'title' => 'DeltaGetLastCursor', - ], - 'ListReceivedFile' => [ - 'summary' => 'Queries a list of files that are shared with a user. You can call this operation to query a list of files in a personal drive on which a user is granted permissions.', - 'path' => '/v2/file/list_received_file', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'GetVideoPreviewPlayMeta', + 'description' => '<props="china">'."\n" + ."\n" + .'For details, see the best practice: [Preview videos online](~~427477~~).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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"}]', + ], + 'GroupUpdateName' => [ + 'path' => '/v2/group/update_name', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], ], + [ + 'AK' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eym***', - ], + 'group_id' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The queried files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried file.'."\n", - 'example' => ' ', - '$ref' => '#/components/schemas/File', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'eym***', - ], - ], - ], + 204 => [ + 'schema' => ['$ref' => '#/components/schemas/BaseGroupResponse', 'description' => '', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'summary' => 'Update user group name', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'ListReceivedFile', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '', ], - 'ListMyGroupDrive' => [ - 'summary' => 'Queries the team drives that can be accessed by the authorized users.', - 'path' => '/v2/drive/list_my_group_drive', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ImportUser' => [ + 'path' => '/v2/user/import', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ + 'AK' => [], + ], + [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of struct', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'drive_name' => [ - 'type' => 'string', - ], + 'authentication_type' => ['description' => 'The authentication type. Valid values are:'."\n" + ."\n" + .'- `mobile`: a mobile number.'."\n" + ."\n" + .'- `email`: an email address.'."\n" + ."\n" + .'- `ding`: a DingTalk account.'."\n" + ."\n" + .'- `ram`: an Alibaba Cloud RAM sub-account.'."\n" + ."\n" + .'- `wechat`: a WeCom account.'."\n" + ."\n" + .'- `ldap`: an LDAP account.'."\n" + ."\n" + .'- `custom`: a custom account.', 'type' => 'string', 'required' => true, 'example' => 'mobile', 'title' => ''], + 'identity' => ['description' => 'The unique identifier for the user.', 'type' => 'string', 'required' => true, 'example' => '130****', 'title' => ''], + 'authentication_display_name' => ['description' => 'The display name of the authentication method.', 'type' => 'string', 'required' => false, 'example' => '10000', 'title' => ''], + 'extra' => ['description' => 'Extra information.'."\n" + ."\n" + .'If `authentication_type` is `mobile`, this parameter specifies the country code. The default is `86`.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'nick_name' => ['description' => 'The nickname of the user.', 'type' => 'string', 'required' => true, 'example' => 'pdsuer', 'title' => ''], + 'auto_create_drive' => ['description' => 'Specifies whether to automatically create a drive for the user.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'drive_total_size' => ['description' => 'The total size of the drive. The value must be an integer that is greater than or equal to `-1`. A value of `-1` indicates an unlimited size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''], + 'parent_group_id' => ['description' => 'The ID of the group to add the user to.', 'type' => 'string', 'required' => false, 'example' => 'g12', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The information about the team drives.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a team drive.'."\n", - '$ref' => '#/components/schemas/Drive', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'root_group_drive' => [ - '$ref' => '#/components/schemas/Drive', - ], - ], - ], + 'schema' => ['description' => 'The user information.', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ImportUser', + 'summary' => 'Imports a user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'ListMyGroupDrive', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'FileRemovePermission' => [ - 'summary' => 'Cancels the permissions on a shared file.', - 'path' => '/v2/file/remove_permission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'InvestigateFile' => [ + 'summary' => 'Submits a file for investigation.', + 'path' => '/v2/csi/investigate_file', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], - ], - [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', - ], - 'member_list' => [ - 'description' => 'The identities with whom the file is shared.'."\n", + 'drive_file_ids' => [ + 'description' => 'A list of drive and file ID pairs. You can specify up to five pairs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'identity' => [ - 'description' => 'The identity to whom the permissions are granted, which is a user or a group.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Identity', - ], - 'role_id' => [ - 'description' => 'The role ID. You can grant permissions by assigning roles to identities, or you can customize the permissions. To grant permissions by assigning roles to identities, specify role_id. role_id and action_list are mutually exclusive. If both parameters are specified, role_id has a higher priority.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'SystemFileOwner: collaborator.'."\n" - ."\n" - .'SystemFileDownloader: downloader.'."\n" - ."\n" - .'SystemFileEditor: editor.'."\n" - ."\n" - .'SystemFileEditorWithoutDelete: editor without permissions to delete the file.'."\n" - ."\n" - .'SystemFileEditorWithoutShareLink: editor without permissions to share the file.'."\n" - ."\n" - .'SystemFileMetaViewer: viewer of lists.'."\n" - ."\n" - .'SystemFileUploader: uploader. SystemFileUploaderAndDownloader: uploader and downloader.'."\n" - ."\n" - .'SystemFileDownloaderWithShareLink: downloader and sharer.'."\n" - ."\n" - .'SystemFileUploaderAndDownloaderWithShareLink: uploader, downloader, and sharer.'."\n" - ."\n" - .'SystemFileUploaderAndViewer: viewer and uploader.'."\n" - ."\n" - .'SystemFileUploaderWithShareLink: uploader and sharer.'."\n" - ."\n" - .'SystemFileViewer: viewer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SystemFileDownloader', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ - 'headers' => [], + 202 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + 'example' => '', + ], ], ], + 'title' => 'Review File', + 'description' => 'This operation investigates images and videos, but does not investigate their audio tracks. It captures one frame per second for an animated image (up to 100 frames), slices a long image into a maximum of 100 sections, and captures one frame every 3 seconds for a video (up to 1,500 frames). You can retrieve investigation results by calling operations such as List Files, Get File Details, and Get File Content Security Details, or receive them through event notifications. To prevent resource-related failures, do not use this operation for bulk submissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'FileRemovePermission', ], - 'FileAddPermission' => [ - 'summary' => 'Grants permissions to access files to a user or group.', - 'path' => '/v2/file/add_permission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'LinkAccount' => [ + 'path' => '/v2/account/link', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -11533,161 +6386,136 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The ID of the folder. If you want to authorize a user or group to access a team drive, set this parameter to root. If you want to authorize a user or group to access an individual drive, you cannot set this parameter to root.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', - ], - 'member_list' => [ - 'description' => 'The members that are authorized to access files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The authorization information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FilePermissionMember', - ], - 'required' => true, - ], + 'user_id' => ['description' => 'User ID to attach.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], + 'type' => ['description' => 'Account type.'."\n" + ."\n" + .'- mobile: mobile phone number'."\n" + ."\n" + .'- email: email address'."\n" + ."\n" + .'- ding: DingTalk'."\n" + ."\n" + .'- ram: Alibaba Cloud RAM sub-account'."\n" + ."\n" + .'- wechat: WeCom'."\n" + ."\n" + .'- ldap: LDAP account'."\n" + ."\n" + .'- custom: custom account', 'type' => 'string', 'required' => true, 'example' => 'ding', 'title' => ''], + 'identity' => ['description' => 'Unique identifier for the account, such as a mobile phone number.', 'type' => 'string', 'required' => true, 'example' => 'eyy***', 'title' => ''], + 'extra' => ['description' => 'Additional information for the unique identifier. For example, if the account uses a mobile phone number, this field contains the region code. The default value is 86 for the Chinese mainland.', 'type' => 'string', 'required' => false, 'example' => '86', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'headers' => [], + 'schema' => ['description' => 'Returns the user\'s authorization token information.', '$ref' => '#/components/schemas/Token', 'title' => '', 'example' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'FileAddPermission', - ], - 'FileListPermission' => [ - 'summary' => 'Queries the sharing authorization records of a file.', - 'path' => '/v2/file/list_permission', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'LinkAccount', + 'summary' => 'Links an account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListAddressGroups' => [ + 'path' => '/v2/image/list_address_groups', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'limit' => ['description' => 'The maximum number of address groups to return. The default is 100. The value cannot exceed 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination token that specifies the starting point of the query. The response returns results that are sorted alphabetically and appear after the token. If you do not specify this parameter, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'image_thumbnail_process' => ['description' => 'The image thumbnail processing style.', 'type' => 'string', 'required' => false, 'example' => 'image/resize,w_200', 'title' => ''], + 'video_thumbnail_process' => ['description' => 'The video thumbnail processing style.', 'type' => 'string', 'required' => false, 'example' => 'video_thumbnail_process', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the sharing authorization records of a file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a sharing authorization record of a file.'."\n", - '$ref' => '#/components/schemas/FilePermissionMember', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'A list of address groups.', + 'type' => 'array', + 'items' => ['description' => 'An address group.', '$ref' => '#/components/schemas/AddressGroup', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'next_marker' => ['description' => 'The pagination token to use in a subsequent request to retrieve the next page of results. If this field is empty, all results have been returned.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'ListAddressGroups', + 'summary' => 'Lists address groups.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'FileListPermission', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"location\\": \\"30.12231,120.1212\\",\\n \\"count\\": 10,\\n \\"cover_url\\": \\"\\",\\n \\"cover_file_id\\": \\"\\",\\n \\"address_detail\\": {\\n \\"country\\": \\"None \\",\\n \\"province\\": \\"None\\",\\n \\"city\\": \\"None\\",\\n \\"district\\": \\"None\\",\\n \\"township\\": \\"None\\\\n\\"\\n }\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', ], 'ListAssignment' => [ - 'summary' => 'Queries a list of assigned roles. For example, you can query the administrators of a group by group ID.', 'path' => '/v2/role/list_assignment', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -11696,29 +6524,16 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'body', @@ -11726,38 +6541,23 @@ 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'manage_resource_type' => [ - 'description' => 'The type of the managed resource. Set the value to RT_Group, which specifies that the administrators of a group are queried.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RT_Group', - ], - 'manage_resource_id' => [ - 'description' => 'The ID of the managed resource, such as a group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '105***b82', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'manage_resource_type' => ['description' => 'The type of the managed resource. Supported values include:'."\n" + ."\n" + .'- RT\\_Group (group)'."\n" + ."\n" + .'- RT\\_KnowledgeBase (knowledge base)'."\n" + ."\n" + .'- RT\\_KnowledgeCategory (knowledge category)', 'type' => 'string', 'required' => true, 'example' => 'RT_Group', 'title' => ''], + 'manage_resource_id' => ['description' => 'The ID of the managed resource, such as a group ID.', 'type' => 'string', 'required' => true, 'example' => '105***b82', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. The response lists items in alphabetical order, starting after the specified marker. If you omit this parameter, the list starts from the beginning. Default: none.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of resources to return. Value range: \\[1, 100].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -11765,649 +6565,428 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'assignment_list' => [ - 'description' => 'The assigned roles.'."\n", + 'description' => 'A list of assignments.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'hz1', - ], - 'identity' => [ - 'description' => 'The identity to whom the role is assigned, which is a user or a group.'."\n", - '$ref' => '#/components/schemas/Identity', - ], - 'role_id' => [ - 'description' => 'The ID of the role assigned to the identity.'."\n", - 'type' => 'string', - 'example' => 'SystemGroupAdmin', - ], - 'manage_resource_type' => [ - 'description' => 'The type of the managed resource. For example, a value of RT_Group indicates group.'."\n", - 'type' => 'string', - 'example' => 'RT_Group', - ], - 'manage_resource_id' => [ - 'description' => 'The ID of the managed resource, such as a group ID.'."\n", - 'type' => 'string', - 'example' => '105***b82', - ], - 'creator' => [ - 'description' => 'The ID of the user who assigned the role.'."\n", - 'type' => 'string', - 'example' => '216***c83', - ], - 'created_at' => [ - 'description' => 'The time when the role was assigned. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1622682267564', - ], + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'example' => 'hz1', 'title' => ''], + 'identity' => ['description' => 'The assigned identity, which can be a user or a group.', '$ref' => '#/components/schemas/Identity', 'title' => '', 'example' => ''], + 'role_id' => ['description' => 'The assigned role ID.', 'type' => 'string', 'example' => 'SystemGroupAdmin', 'title' => ''], + 'manage_resource_type' => ['description' => 'The type of the managed resource. For example, RT\\_Group indicates a group.', 'type' => 'string', 'example' => 'RT_Group', 'title' => ''], + 'manage_resource_id' => ['description' => 'The ID of the managed resource, such as a group ID.', 'type' => 'string', 'example' => '105***b82', 'title' => ''], + 'creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '216***c83', 'title' => ''], + 'created_at' => ['description' => 'The creation time, in milliseconds since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'example' => '1622682267564', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], + 'next_marker' => ['description' => 'The marker for retrieving the next page of results. This field is empty when there are no more results.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'ListAssignment', - ], - 'AssignRole' => [ - 'summary' => 'Assigns a group administrator role to a user.', - 'path' => '/v2/role/assign', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'summary' => 'Lists role assignments.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"assignment_list\\": [\\n {\\n \\"domain_id\\": \\"hz1\\",\\n \\"identity\\": {\\n \\"identity_type\\": \\"IT_User\\",\\n \\"identity_id\\": \\"16435bdf934248b788b7b3771ee9a3dw\\"\\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"}]', + ], + 'ListDelta' => [ + 'path' => '/v2/file/list_delta', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'identity' => [ - 'description' => 'The unique identifier of a user. The group administrator role can only be assigned to a user.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Identity', - ], - 'role_id' => [ - 'description' => 'The ID of the role that is assigned to a user. Valid value: SystemGroupAdmin.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SystemGroupAdmin', - ], - 'manage_resource_type' => [ - 'description' => 'The type of the resource that the role can manage. Valid value: RT_Group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RT_Group', - ], - 'manage_resource_id' => [ - 'description' => 'The ID of the resource that the role can manage. You can only set this parameter to the ID of a group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '105***b82', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1'], + 'sync_root_id' => ['description' => 'The file id of the sync root.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '622fb09598ae66777c7040109a16f49381f6abe1'], + 'cursor' => ['description' => 'The pagination cursor. Leave this empty for the first request. To retrieve subsequent pages, use the `cursor` value from the previous response.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'], + 'limit' => ['description' => 'The maximum number of items to return, from 0 to 100. If this parameter is not specified, the default is 100.'."\n" + ."\n" + .'The service may return fewer items than the specified value.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '50'], ], 'required' => false, - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', - 'properties' => [], + 'properties' => [ + 'items' => [ + 'description' => 'A list of deltas.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'file_id' => ['description' => 'The file id.', 'type' => 'string', 'title' => '', 'example' => '122fb09598ae66777c7040109a16f49381f6abe2'], + 'op' => [ + 'description' => 'The type of operation. Valid values:'."\n" + ."\n" + .'- create'."\n" + ."\n" + .'- overwrite'."\n" + ."\n" + .'- delete'."\n" + ."\n" + .'- update'."\n" + ."\n" + .'- move'."\n" + ."\n" + .'- trash'."\n" + ."\n" + .'- restore'."\n" + ."\n" + .'- rename', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'create', + ], + 'file' => ['description' => 'Details about the file involved in the operation.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'has_more' => ['description' => 'A value of `true` indicates that more deltas are available to fetch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'cursor' => ['description' => 'The pagination cursor for the next page of results. This field is returned only when `has_more` is `true`.', 'type' => 'string', 'example' => '1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ListDelta', + 'summary' => 'Lists deltas.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'AssignRole', - 'description' => 'You can call this operation to assign a group administrator role to a user.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"file_id\\": \\"122fb09598ae66777c7040109a16f49381f6abe2\\",\\n \\"op\\": \\"create\\",\\n \\"file\\": {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n }\\n ],\\n \\"has_more\\": true,\\n \\"cursor\\": \\"1WQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', ], - 'CancelAssignRole' => [ - 'summary' => 'Cancels a role.', - 'path' => '/v2/role/cancel_assign', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ListDomains' => [ + 'summary' => 'List domains.', + 'path' => '/v2/domain/list', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + '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', 'style' => 'json', 'schema' => [ + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'identity' => [ - 'description' => 'The unique identifier. You can cancel only the role assigned to a user.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Identity', - ], - 'role_id' => [ - 'description' => 'The ID of the role to be canceled. Set the value to SystemGroupAdmin, which is the ID of the group administrator role.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SystemGroupAdmin', - ], - 'manage_resource_type' => [ - 'description' => 'The type of the resource that the role manages. Set the value to RT_Group, which specifies group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RT_Group', - ], - 'manage_resource_id' => [ - 'description' => 'The ID of the resource that the role manages. Set the value to a group ID.'."\n", + 'parent_domain_id' => ['description' => 'The ID of the parent domain.', 'type' => 'string', 'required' => false, 'example' => 'bj1', 'title' => ''], + 'marker' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 50.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + 'service_code' => [ + 'description' => 'Service code. Default is pds.'."\n" + ."\n" + .'- edm (Enterprise Edition)'."\n" + ."\n" + .'- pds (Developer Edition)', + 'enumValueTitles' => ['pds' => 'pds', 'edm' => 'edm'], 'type' => 'string', - 'required' => true, - 'example' => '105***b82', + 'required' => false, + 'example' => 'pds', + 'title' => '', ], ], 'required' => false, - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'schema' => [ + 'description' => 'The returned domains.', 'type' => 'object', - 'properties' => [], + 'properties' => [ + 'items' => [ + 'description' => 'The information about the domains.', + 'type' => 'array', + 'items' => ['description' => 'The information about a domain.', '$ref' => '#/components/schemas/Domain', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'next_marker' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next\\_marker is empty, no next page exists.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"bj1\\",\\n \\"domain_id\\": \\"bj2\\",\\n \\"domain_name\\": \\"pdsdomain\\",\\n \\"description\\": \\"my domain\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 1073741824,\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"size_quota\\": 1099511627776,\\n \\"size_quota_used\\": 1099511627776,\\n \\"user_count_quota\\": 50,\\n \\"status\\": 1,\\n \\"used_size\\": 1099511627776,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"deny\\",\\n \\"except_app_id_list\\": [\\n \\"8ovxCTRUDdbpVWBP\\"\\n ]\\n },\\n \\"sharable\\": false,\\n \\"data_hash_name\\": \\"sha1\\",\\n \\"store_redundancy_type\\": \\"LRS\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'List Domains', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CancelAssignRole', - 'description' => 'You can cancel only the group administrator role.'."\n", ], - 'CreateShareLink' => [ - 'summary' => 'Creates a share URL.', - 'path' => '/v2/share_link/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ListDrive' => [ + 'path' => '/v2/drive/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'share_all_files' => [ - 'description' => 'Specifies whether to share all files in the drive.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'file_id_list' => [ - 'description' => 'The IDs of the files to share in the parent path. The number of files in the parent path ranges from 1 to 100. If share_all_files is set to true, this parameter does not take effect. Otherwise, you must specify this parameter.``'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the file to share in the parent path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9520943DC264', - ], - 'required' => false, - 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', - ], - 'user_id' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'u123', - ], - 'share_pwd' => [ - 'description' => 'The access code. An access code must be 0 to 64 bytes in length. If you do not specify this parameter or leave this parameter empty, the files can be accessed without an access code. In this case, you do not need to specify the share_pwd parameter when you call an operation to query the share URL. The access code can contain only visible ASCII characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcF123x', - ], - 'expiration' => [ - 'description' => 'The time when the share URL expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If expiration is set to "", the share URL never expires.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-06-28T11:33:00.000+08:00', - ], - 'description' => [ - 'description' => 'The description of the share. The description must be 0 to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'share_name' => [ - 'description' => 'The name of the share. If you leave this parameter empty, the file name that corresponds to the first ID in the file ID list is used. The name must be 0 to 128 characters in length.'."\n", + 'limit' => ['description' => 'The maximum number of drives to return. Valid values: 1 to 100. Default: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'exclusiveMinimum' => true, 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. If specified, the query starts from the drive that follows the marker in alphabetical order. If omitted, the query starts from the beginning of the list.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'owner' => ['description' => 'The ID of the owner. If omitted, drives of all owners are returned.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'owner_type' => [ + 'description' => 'The owner type. Valid values:'."\n" + ."\n" + .'user: An individual user.<br>group: A user group.<br>'."\n" + ."\n" + .'If omitted, drives of all owner types are returned.', 'type' => 'string', + 'example' => 'user', + 'enum' => ['user', 'group'], 'required' => false, - 'example' => '', - ], - 'disable_preview' => [ - 'description' => 'Specifies whether to disable the preview feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'disable_save' => [ - 'description' => 'Specifies whether to disable the dump feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'disable_download' => [ - 'description' => 'Specifies whether to disable the download feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'preview_limit' => [ - 'description' => 'The limit on the number of times that the shared files can be previewed. The value of this parameter must be equal to or greater than 0. A value of 0 indicates no limit.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'save_limit' => [ - 'description' => 'The limit on the number of times that the shared files can be dumped. The value of this parameter must be equal to or greater than 0. A value of 0 indicates no limit.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'download_limit' => [ - 'description' => 'The limit on the number of times that the shared files can be downloaded. The value of this parameter must be equal to or greater than 0. A value of 0 indicates no limit.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'require_login' => [ - 'type' => 'boolean', - ], - 'office_editable' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'creatable' => [ - 'type' => 'boolean', - ], - 'creatable_file_id_list' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", - '$ref' => '#/components/schemas/ShareLink', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'A list of drives.', + 'type' => 'array', + 'items' => ['description' => 'Drive information.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'next_marker' => ['description' => 'The marker for retrieving the next page of results. If no more results are available, this parameter is empty.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + ], + 'example' => '', ], ], ], - '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' => 'CreateShareLink', - 'description' => 'A share is a file view container. You can grant anonymous users the permissions to access files in the user drive by using the share URL. Anonymous users can access the files based on the granted permissions.'."\n", - ], - 'UpdateShareLink' => [ - 'summary' => 'Modifies a share link.', - 'path' => '/v2/share_link/update', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListDrive', + 'summary' => 'Lists drives.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListFacegroups' => [ + 'summary' => 'Lists face groups.', + 'path' => '/v2/image/list_facegroups', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7JQX1FswpQ8', - ], - 'share_pwd' => [ - 'description' => 'The access code. The access code can be up to 64 characters in length. A value of 0 specifies an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcF123x', - ], - 'expiration' => [ - 'description' => 'The time when the share link expires. The time follows the RFC 3339 standard. Example: 2020-06-28T11:33:00.000+08:00. If you leave this parameter empty, the share link never expires.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-06-28T11:33:00.000+08:00', - ], - 'description' => [ - 'description' => 'The description of the share link. The description can be up to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'share_name' => [ - 'description' => 'The name of the share link. By default, the name of the first file is used. The name can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'status' => [ - 'description' => 'The state of the share link. Valid values:'."\n" - ."\n" - .'* disabled: The share link is canceled.'."\n" - .'* enabled: The share link is effective.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - ], - 'preview_count' => [ - 'description' => 'The number of times that the shared files are previewed. The value must be greater than or equal to 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], - 'save_count' => [ - 'description' => 'The number of times that the shared files are saved. The value must be greater than or equal to 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - 'download_count' => [ - 'description' => 'The number of times that the shared files are downloaded. The value must be greater than or equal to 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], - 'report_count' => [ - 'description' => 'The number of times that the shared files are reported. The value must be greater than or equal to 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'video_preview_count' => [ - 'description' => 'The number of times that the videos are previewed in the shared files. The value must be greater than or equal to 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'disable_preview' => [ - 'description' => 'Specifies whether to prohibit the previews of the shared files.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'disable_save' => [ - 'description' => 'Specifies whether to prohibit the saves of the shared files.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'disable_download' => [ - 'description' => 'Specifies whether to prohibit the downloads of the shared files.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'preview_limit' => [ - 'description' => 'The maximum number of times that the shared files can be previewed. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'save_limit' => [ - 'description' => 'The maximum number of times that the shared files can be saved. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'download_limit' => [ - 'description' => 'The maximum number of times that the shared files can be downloaded. The value must be greater than or equal to 0. A value of 0 specifies that the number is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'office_editable' => [ - 'type' => 'boolean', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'remarks' => ['description' => 'Filters query results by exactly matching the remarks. The maximum length is 128 characters.', 'type' => 'string', 'example' => 'John Doe', 'maxLength' => 128, 'minLength' => 1, 'required' => false, 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination token. The results are returned in alphabetical order, starting from the item that follows the specified token. If you omit this parameter, the query starts from the beginning.<br>Default value: None<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'return_total_count' => ['description' => 'Specifies whether to return the total count of face groups found.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", - '$ref' => '#/components/schemas/ShareLink', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The list of face groups.', + 'type' => 'array', + 'items' => ['description' => 'A face group.', '$ref' => '#/components/schemas/FaceGroup', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'next_marker' => ['description' => 'The pagination token for the next page of results. This parameter is empty on the last page.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'total_count' => ['description' => 'The total count of matched face groups. This parameter is returned only when `return_total_count` in the request is set to `true`.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'UpdateShareLink', - ], - 'SearchShareLink' => [ - 'summary' => 'Queries share URLs.', - 'path' => '/v2/share_link/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + '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 }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 30\\n}","type":"json"}]', + 'title' => 'List face groups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'ListFile' => [ + 'summary' => 'Lists the files and folders that are immediate children of a specified folder.', + 'path' => '/v2/file/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'share_id' => ['description' => 'The share ID. To access files through sharing, include the `x-share-token` header for authentication and specify `share_id`. In this case, `drive_id` is ignored. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify either `share_id` or `drive_id`.'], + 'drive_id' => ['description' => 'The drive ID. You must specify either `drive_id` or `share_id`.'], + 'parent_file_id' => ['description' => 'The ID of the parent folder. Set this parameter to `root` to list files in the root directory.'], + 'limit' => ['description' => 'The maximum number of results to return per request. Valid values: 1 to 100. The actual number of returned results may be less than this value.'], + 'marker' => ['description' => 'The pagination token that indicates the position from which the next set of results begins. If this parameter is not specified, results are returned from the beginning. Leave this parameter empty by default.'], + 'status' => ['description' => 'The file status used to filter results. Valid values: `available` (returns only available files) and `uploading` (returns only files being uploaded). Default value: `available`.'], + 'order_by' => ['description' => 'The field by which to sort results. Valid values: `created_at` (creation time), `updated_at` (last modified time), `size` (file size), and `name` (file name). Default value: `created_at`.'], + 'order_direction' => ['description' => 'The sort order. Valid values: `ASC` (ascending) and `DESC` (descending). Default value: `ASC`.'], + 'category' => [ + 'description' => 'The file category used to filter results. Valid values: `app` (installation package), `zip` (compressed file), `image`, `doc` (document), `video`, `audio`, and `others`. By default, files of all categories are returned.', + 'enumValueTitles' => ['app' => 'app', 'zip' => 'zip', 'image' => 'image', 'doc' => 'doc', 'video' => 'video', 'audio' => 'audio', 'others' => 'others'], + ], + 'type' => ['description' => 'The item type used to filter results. Valid values: `file` (returns only files) and `folder` (returns only folders). By default, both files and folders are returned.'], + 'fields' => ['description' => 'Specifies additional fields to include in the response for each child item. Valid values: * `url`: includes the thumbnail and download URLs. * `exif`: includes Exchangeable Image File Format (EXIF) data. * `cropping_suggestion`: includes cropping suggestions. * `characteristic_hash`: includes the characteristic hash value. * `video_metadata`: includes video metadata such as duration, bitrate, height, and width. * `video_preview_metadata`: includes video transcoding information for each definition. * `investigation_info`: includes investigation information. * `dir_size`: includes statistics for each subfolder. * `user_tags`: includes user-defined tags. Separate multiple fields with commas (,). Example: `url,dir_size,user_tags`.'], + 'thumbnail_processes' => [ + 'description' => 'The thumbnail configurations specified as key-value pairs. You can define custom keys, and the corresponding thumbnail URLs are returned with those keys. A maximum of five thumbnails can be returned per request.', + 'additionalProperties' => ['description' => 'The processing rules for generating thumbnails of images, videos, and documents.'], + ], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -12415,82 +6994,98 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", + 'share_id' => ['description' => 'The share ID. If you want to share a file, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'parent_file_id' => ['description' => 'The ID of the parent folder. If the parent folder is a root directory, set this parameter to root.', 'type' => 'string', 'required' => true, 'example' => 'root', 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100.'."\n" + .'The number of returned entries must be less than or equal to the value of this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned.\\'."\n" + .'This parameter is left empty by default.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'status' => [ + 'description' => 'The state of the files to return. Valid values:'."\n" + .'available: returns only normal files. uploading: returns only files that are being uploaded.'."\n" + .'By default, only files in the available state are returned.', + 'enumValueTitles' => ['available' => '', 'uploading' => ''], 'type' => 'string', + 'enum' => ['uploading', 'available'], 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'return_total_count' => [ - 'description' => 'Specifies whether to return the total number of returned results.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'example' => 'available', + 'title' => '', ], 'order_by' => [ - 'description' => 'The field by which to sort the returned results. Default value: created_at. Valid values:'."\n" - ."\n" - .'* share_name: sorts the results by the name of the share.'."\n" - .'* updated_at: sorts the results by the time when the share was modified.'."\n" - .'* description: sorts the results by the description of the share.'."\n" - .'* created_at: sorts the results by the time when the share was created.'."\n", + 'description' => 'The sorting field. Valid values:'."\n" + .'created_at: sorts the entries by creation time. updated_at: sorts the entries by update time. size: sorts the entries by file size. name: sorts the entries by file name.'."\n" + .'Default value: created_at.'."\n" + .'Enumeration:'."\n" + .'\\* updated_at: update time'."\n" + .'\\* size: file size'."\n" + .'\\* name: file name'."\n" + .'\\* created_at: creation time', + 'enumValueTitles' => ['updated_at' => '', 'size' => '', 'name' => '', 'created_at' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'share_name' => '', - 'updated_at' => '', - 'description' => '', - 'created_at' => '', - ], - 'example' => 'created_at', + 'example' => 'updated_at', + 'title' => '', ], 'order_direction' => [ - 'description' => 'The order in which you want to sort the returned results. By default, order_direction is set to DESC if order_by is set to created_at or updated_at, and is set to ASC if order_by is set to other values. Valid values:'."\n" - ."\n" - .'* ASC: sorts the results in ascending order.'."\n" - .'* DESC: sorts the results in descending order.'."\n", + 'description' => 'The sorting direction. Valid values:'."\n" + .'ASC: ascending order DESC: descending order'."\n" + .'Default value: ASC.', + 'enumValueTitles' => ['ASC' => '', 'DESC' => ''], 'type' => 'string', + 'enum' => ['ASC', 'DESC'], 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], 'example' => 'ASC', + 'title' => '', ], - 'creators' => [ - 'description' => 'The creators of shares. Set this parameter to a user ID. If you do not specify this parameter, Drive and Photo Service automatically queries shares based on your permissions. If you are a drive administrator or the super administrator, the shares created by all members are queried. If you are a team administrator, the shares created by all team members are queried. If you are a common user, only the shares created by yourself are queried.'."\n" - ."\n" - .'If you specify this parameter, this parameter must be set to the ID of the super administrator, a drive administrator, or a team administrator.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The creator of the share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], + 'category' => [ + 'description' => 'The file category. Valid values:'."\n" + .'app: installation package zip: compressed package image doc: document video audio others'."\n" + .'By default, files of all categories are returned.', + 'enumValueTitles' => ['app' => 'app', 'zip' => 'zip', 'image' => 'image', 'doc' => 'doc', 'video' => 'video', 'audio' => 'audio', 'others' => 'others'], + 'type' => 'string', + 'enum' => ['image', 'video', 'audio', 'doc', 'app', 'zip', 'others'], 'required' => false, + 'example' => 'image', + 'title' => '', ], - 'query' => [ - 'description' => 'The query condition that is used to search for share URLs. You can use the following fields to specify query conditions: created_at: queries a share URL based on the time when the share URL was created. updated_at: queries a share URL based on the time when the share URL was modified. share_name_for_fuzzy: queries a share URL based on the name of the share. A fuzzy match is supported. status: queries a share URL based on the status of the share. Valid values: enabled and disabled. A value of enabled indicates that the share is valid. A value of disabled indicates that the share is canceled. expired_time: queries a share URL based on the expiration time of the share. If the share never expires, set this field to 1970-01-01T00:00:00. Otherwise, set this field to 1970-01-02T00:00:00.'."\n", + 'type' => [ + 'description' => 'The file type. Valid values:'."\n" + .'file: returns only files. folder: returns only folders.'."\n" + .'By default, files of all types are returned.', + 'enumValueTitles' => ['file' => '', 'folder' => ''], 'type' => 'string', + 'enum' => ['file', 'folder'], '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\'', + 'example' => 'file', + 'title' => '', + ], + 'fields' => ['description' => 'The field that is used to return additional information about a child subject. Valid values:'."\n" + .'\\* url: returns the URL of the thumbnail of a file in the response.'."\n" + .'\\* exif: returns the Exchangeable Image File Format (EXIF) data of a file in the response.'."\n" + .'\\* cropping_suggestion: returns the cropping suggestion on a file in the response.'."\n" + .'\\* characteristic_hash: returns the characteristic hash value of a file in the response.'."\n" + .'\\* video_metadata: returns the metadata of a video file, such as the video duration, bitrate, height, and width, in the response.'."\n" + .'\\* video_preview_metadata: returns the transcoding information of a video file, such as the transcoding specification for each definition, in the response.'."\n" + .'\\* investigation_info: returns the investigation information in the response.'."\n" + .'\\* dir_size: returns the statistics on each subfolder in the response.'."\n" + .'\\* user_tags: returns the user tags of each child subject in the response.'."\n" + .'You can specify multiple fields by separating them with commas (,). Example: "url,dir_size,user_tags".', 'type' => 'string', 'required' => false, 'example' => 'url,dir_size,user_tags', 'title' => ''], + 'thumbnail_processes' => [ + 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The rules used to generate the thumbnails of images, videos, and documents.', '$ref' => '#/components/schemas/ImageProcess', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -12498,257 +7093,190 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'items' => [ - 'description' => 'The share URLs.'."\n", + 'description' => 'The list of files and folders.', 'type' => 'array', - 'items' => [ - 'description' => 'A share URL.'."\n", - '$ref' => '#/components/schemas/ShareLink', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'total_count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', + 'items' => ['description' => 'The file or folder information.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The pagination token for the next page of results. This value is empty if the current page is the last page.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'SearchShareLink', - ], - 'CancelShareLink' => [ - 'summary' => 'Deletes a share link.', - 'path' => '/v2/share_link/cancel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListGroup' => [ + 'path' => '/v2/group/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7JQX1FswpQ8', - ], + 'limit' => ['description' => 'The maximum number of resources to return. The default value is 100, and the maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination token that specifies the starting point for the query. Results are returned in alphabetical order, starting from the item that follows the marker. If you do not specify this parameter, the query starts from the beginning of the collection.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - '_' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', + 'items' => [ + 'description' => 'A list of group objects.', + 'type' => 'array', + 'items' => ['description' => 'A group object.', '$ref' => '#/components/schemas/Group', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The token that you can use to retrieve the next page of results. This parameter is not returned if all results have been retrieved.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CancelShareLink', - ], - 'ListShareLink' => [ - 'summary' => 'Queries shares.', - 'path' => '/v2/share_link/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListGroup', + 'summary' => 'Lists groups.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"group_id\\": \\"b45c0c0c373c41ec9ebb5c85a025a08f\\",\\n \\"group_name\\": \\"test group\\",\\n \\"description\\": \\"created by system\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListGroupMember' => [ + 'path' => '/v2/group/list_member', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the domain.', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'creator' => [ - 'description' => 'The creator of the share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 0 to 100.'."\n" - ."\n" - .'The number of returned results must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.\\'."\n" - .'By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'order_by' => [ - 'description' => 'The field by which to sort the returned results. Default value: created_at. Valid values:'."\n" - ."\n" - .'* share_name: sorts the results by the name of the share.'."\n" - .'* updated_at: sorts the results by the time when the share was modified.'."\n" - .'* description: sorts the results by the description of the share.'."\n" - .'* created_at: sorts the results by the time when the share was created.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'share_name' => '', - 'updated_at' => '', - 'description' => '', - 'created_at' => '', - ], - 'example' => 'share_name', - ], - 'order_direction' => [ - 'description' => 'The order in which you want to sort the returned results. By default, order_direction is set to DESC if order_by is set to created_at or updated_at, and is set to ASC if order_by is set to other values. Valid values:'."\n" - ."\n" - .'* ASC: sorts the results in ascending order.'."\n" - .'* DESC: sorts the results in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], - 'example' => 'ASC', - ], - 'include_cancelled' => [ - 'description' => 'Specifies whether to return the shares that are canceled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'group_id' => ['description' => 'The ID of the group.', 'type' => 'string', 'required' => true, 'example' => '3e5***2c2', 'title' => ''], + 'member_type' => ['description' => 'The member type to list. If you do not specify this parameter, the API returns both users and groups.'."\n" + ."\n" + .'- user'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'Note: A group can be a member of only one other group. A user can be a member of multiple groups.', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. The value must be an integer from 1 to 100. The API may return fewer results than the specified limit.<br>default value: 100<br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. The API returns results starting from the first entry that follows the marker in alphabetical order. If you do not specify this parameter, the API returns results from the beginning of the collection.<br>default value: none<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The information about the shares.'."\n", + 'user_items' => [ + 'description' => 'The user list.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a share.'."\n", - '$ref' => '#/components/schemas/ShareLink', - ], + 'items' => ['description' => 'The user information.', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + 'group_items' => [ + 'description' => 'The group list.', + 'type' => 'array', + 'items' => ['description' => 'The group information.', '$ref' => '#/components/schemas/Group', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The marker to retrieve the next page of results. This parameter is empty if no more results are available.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'ListShareLink', - 'description' => 'This operation is discontinued. To query shares, you can call the SearchShareLink operation.'."\n", - ], - 'GetShareLink' => [ - 'summary' => 'Queries the share URL of a file.', - 'path' => '/v2/share_link/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListGroupMember', + 'summary' => 'Lists group members.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"user_items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ],\\n \\"group_items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"group_id\\": \\"b45c0c0c373c41ec9ebb5c85a025a08f\\",\\n \\"group_name\\": \\"test group\\",\\n \\"description\\": \\"created by system\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1\\"\\n}","type":"json"}]', + ], + 'ListIdentityToBenefitPkgMapping' => [ + 'summary' => 'Lists the mappings between identities and benefit packages. Use this API to retrieve the benefit packages bound to a user.', + 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/list', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -12757,86 +7285,101 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID.'."\n", + 'identity_type' => [ + 'description' => 'The type of the identity. To manage benefits for a user, set this parameter to `user`.', 'type' => 'string', 'required' => true, - 'example' => '7JQX1FswpQ8', + 'enum' => ['user'], + 'example' => 'user', + 'title' => '', ], + 'identity_id' => ['description' => 'The unique identifier of the identity.'."\n" + ."\n" + .'When managing benefits for a user, specify the ID of the user.', 'type' => 'string', 'required' => true, 'example' => 'user123', 'title' => ''], + 'include_expired' => ['description' => 'Specifies whether to return expired benefit packages. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", - '$ref' => '#/components/schemas/ShareLink', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'A list of benefit packages bound to the identity.', + 'type' => 'array', + 'items' => ['description' => 'Details of a bound benefit package.', '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetShareLink', - ], - 'GetShareLinkByAnonymous' => [ - 'summary' => 'Queries the information about a share link anonymously.', - 'path' => '/v2/share_link/get_by_anonymous', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListIdentityToBenefitPkgMapping', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"identity_type\\": \\"user\\",\\n \\"identity_id\\": \\"user123\\",\\n \\"benefit_pkg_owner_id\\": \\"bj1\\",\\n \\"benefit_pkg_id\\": \\"40cb7794c9294\\",\\n \\"benefit_pkg_type\\": \\"user_identity\\",\\n \\"benefit_pkg_name\\": \\"高级会员\\",\\n \\"benefit_pkg_priority\\": 1,\\n \\"benefit_pkg_computation_rule\\": \\"sum\\",\\n \\"delivery_info_list\\": [\\n {\\n \\"amount\\": 1,\\n \\"is_permanent\\": false,\\n \\"expire_time\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\"\\n }\\n ],\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListMyDrives' => [ + 'path' => '/v2/drive/list_my_drives', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], + ], + [ + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default: 100.'], + 'marker' => ['description' => 'The pagination token used to retrieve the next page of results. This parameter is not required for the first request. For subsequent requests, set this parameter to the `next_marker` value from the previous response. If this parameter is omitted, the query starts from the beginning.'], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -12847,207 +7390,82 @@ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7JQX1FswpQ8', - ], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'exclusiveMinimum' => true, 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination token used to retrieve the next page of results. This parameter is not required for the first request. For subsequent requests, set this parameter to the `next_marker` value from the previous response. If this parameter is omitted, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'creator_id' => [ - 'description' => 'The ID of the user who created the share link.'."\n", - 'type' => 'string', - 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', - ], - 'creator_name' => [ - 'description' => 'The name of the user who created the share link. The value is masked.'."\n", - 'type' => 'string', - 'example' => 'AB***CD', - ], - 'creator_phone' => [ - 'description' => 'The mobile number of the user who created the share link. The value is masked.'."\n", - 'type' => 'string', - 'example' => '136****00', - ], - 'expiration' => [ - 'description' => 'The time when the share link expires.'."\n", - 'type' => 'string', - 'example' => '2020-08-20T06:51:27.292Z', - ], - 'updated_at' => [ - 'description' => 'The time when the share link was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'avatar' => [ - 'description' => 'The profile picture of the user who created the share link.'."\n", - 'type' => 'string', - 'example' => 'https://aliyunpds.com/a.jpg', - ], - 'share_name' => [ - 'description' => 'The name of the share link.'."\n", - 'type' => 'string', + 'items' => [ + 'description' => 'The list of Drives.', + 'type' => 'array', + 'items' => ['description' => 'A Drive object.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', ], - 'preview_count' => [ - 'description' => 'The number of times that the shared files are previewed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'save_count' => [ - 'description' => 'The number of times that the shared files are saved.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'download_count' => [ - 'description' => 'The number of times that the shared files are downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'report_count' => [ - 'description' => 'The number of times that the shared files are reported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'video_preview_count' => [ - 'description' => 'The number of times that the videos are previewed in the shared files.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'access_count' => [ - 'description' => 'The number of times that the shared files are visited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'disable_preview' => [ - 'description' => 'Indicates whether the previews of the shared files are prohibited.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'disable_save' => [ - 'description' => 'Indicates whether the saves of the shared files are prohibited.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'disable_download' => [ - 'description' => 'Indicates whether the downloads of the shared files are prohibited.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'preview_limit' => [ - 'description' => 'The maximum number of times that the shared files can be previewed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'save_limit' => [ - 'description' => 'The maximum number of times that the shared files can be saved.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'download_limit' => [ - 'description' => 'The maximum number of times that the shared files can be downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'save_download_limit' => [ - 'description' => 'The maximum number of times that the shared files can be saved and downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'has_pwd' => [ - 'description' => 'Indicates whether a password is specified for the share link.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'next_marker' => ['description' => 'The pagination token to retrieve the next page of results. This parameter is empty when no more results are available.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'GetShareLinkByAnonymous', - ], - 'GetShareLinkToken' => [ - 'summary' => 'Queries a share token anonymously.', - 'path' => '/v2/share_link/get_share_token', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMyDrives', + 'summary' => 'Retrieves a list of Drives for the logged-in user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListMyGroupDrive' => [ + 'summary' => 'Lists the authorized group drives.', + 'path' => '/v2/drive/list_my_group_drive', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'Anonymous' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the domain.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7JQX1FswpQ8', - ], - 'share_pwd' => [ - 'description' => 'The access code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcF123x', - ], - 'expire_sec' => [ - 'description' => 'The validity period of the token. Valid values: (0,7200]. Default value: 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7200', - ], + 'limit' => ['description' => 'The maximum number of group drives to return. The maximum value is 100. If you do not specify this parameter, the default value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'A pagination token. Set this parameter to the value of `next_marker` from a previous response to retrieve the next page of results. If you do not set this parameter, the query starts from the beginning of the collection.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'drive_name' => ['description' => 'The name of the drive.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13055,151 +7473,103 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'share_token' => [ - 'title' => 'Id of the request', - 'description' => 'The JSON Web Token (JWT).'."\n", - 'type' => 'string', - 'example' => 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJjOWI3YTVhYTA0ZDE0YWUzODY3ZmRjODg2ZmEwMWRhNCIsImN1c3RvbUpzb24iOiJ7XCJjbGllbnRJZFwiOlwiMjVkelgzdmJZcWt0Vnh5WFwiLFwiZG9tYWluSWRcIjpcImJqMjlcIixcInNjb3BlXCI6W1wiRFJJVkUuQUxMXCIsXCJTSEFSRS5BTExcIixcIkZJTEUuQUxMXCIsXCJVU0VSLkFMTFwiLFwiVklFVy5BTExcIixcIlNUT1JBR0UuQUxMXCIsXCJTVE9SQUdFRklMRS5MSVNUXCIsXCJCQVRDSFwiLFwiT0FVVEguQUxMXCIsXCJJTUFHRS5BTExcIixcIklOVklURS5BTExcIixcIkFDQ09VTlQuQUxMXCJdLFwicm9sZVwiOlwidXNlclwiLFwicmVmXCI6XCJodHRwczovL3d3dy5hbGl5dW5kcml2ZS5jb20vXCIsXCJkZXZpY2VfaWRcIjpcImIyODIwNWU1YzU5NzRjY2JiODI3MDNiNjhkYjhjNDUxXCJ9IiwiZXhwIjoxNjQ4NjE0NDkzLCJpYXQiOjE2NDg2MDcyMzN9.d3HVLvv_LFw2QhPrhvjH_kICWQJX9sKKt7NjQEqI_xE2JO_b7D8rPsFTZz93PLvZ7MhCmudTjGImUpd-ehFnI4Go-1S7BGaKaHFILvP-sWy18Wpikowjxx9mSbzBM_cO6D1LI-kyYhXKWHgVdADfVIPniTDA7-ffhUpi7cAebEs', - ], - 'expires_in' => [ - 'description' => 'The validity period of the token. Unit: seconds. For example, a value of 7200 indicates two hours.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7200', + 'items' => [ + 'description' => 'A list of group drives.', + 'type' => 'array', + 'items' => ['description' => 'A group drive.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The pagination token to retrieve the next page of results. If this parameter is empty, no more results are available.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'root_group_drive' => ['description' => 'The root group drive.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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' => 'GetShareLinkToken', - 'description' => 'To access a file by using a share link, you must first obtain a share token, even if the value of share_pwd of this share is an empty string, which specifies that the share is not private.'."\n", - ], - 'TrashFile' => [ - 'summary' => 'Moves a file or folder to the recycle bin.', - 'path' => '/v2/recyclebin/trash', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List of Authorized Team Spaces Received', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"root_group_drive\\": {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n }\\n}","type":"json"}]', + ], + 'ListReceivedFile' => [ + 'path' => '/v2/file/list_received_file', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The ID of the file or folder.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', - ], - 'custom_trashed_at' => [ - 'type' => 'string', - ], + 'limit' => ['description' => 'The maximum number of items to return. The value cannot exceed 100. If you do not specify this parameter, the default is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination marker from a previous response. The query continues from the position indicated by this marker. If you do not specify this parameter, the query starts from the beginning of the file list.', 'type' => 'string', 'required' => false, 'example' => 'eym***', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The ID of the file or folder.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'If an empty string is returned, the file or folder is moved to the recycle bin.'."\n" - ."\n" - .'If a non-empty string is returned, an asynchronous task is required. You can call the GetAsyncTask operation to obtain the information about an asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', + 'items' => [ + 'description' => 'A list of file objects.', + 'type' => 'array', + 'items' => ['description' => 'A file object.', '$ref' => '#/components/schemas/File', 'example' => ' ', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The pagination marker for the next page of results. Pass this value in the marker parameter of a subsequent request to retrieve the next page.', 'type' => 'string', 'example' => 'eym***', 'title' => ''], ], + 'example' => '', ], ], - 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' => 'TrashFile', - ], - 'ClearRecyclebin' => [ - 'summary' => 'Empties the recycle bin.', - 'path' => '/v2/recyclebin/clear', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListReceivedFile', + 'summary' => 'Lists files shared with the current user from a personal space.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"eym***\\"\\n}","type":"json"}]', + ], + 'ListRecyclebin' => [ + 'path' => '/v2/recyclebin/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -13208,41 +7578,48 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. The API returns items starting from the one that alphabetically follows the marker. If you omit this parameter, the API returns items from the beginning of the list. Default: none.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of items to return. Valid values: 1 to 200. Default: 50.'."\n" + ."\n" + .'The number of items returned may be less than the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'fields' => ['description' => 'The fields to return in the response.'."\n" + ."\n" + .'Set to `*` to return all fields of a file.'."\n" + ."\n" + .'If this parameter is not specified, a partial set of fields is returned by default.'."\n" + ."\n" + .'This behavior excludes fields such as the file creator, file modifier, and user-defined tags.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], + 'thumbnail_processes' => [ + 'description' => 'Thumbnail settings. You can retrieve up to five thumbnails in a single request. The keys in this map are user-defined, and the response provides a thumbnail URL for each key.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The processing rules for image, video, and document thumbnails.', '$ref' => '#/components/schemas/ImageProcess', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13250,50 +7627,35 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'You can call the GetAsyncTask operation to query the information about the asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', + 'items' => [ + 'description' => 'A list of files and folders in the recycle bin.', + 'type' => 'array', + 'items' => ['description' => 'Information about the file or folder.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The pagination marker for the next page of results. If this parameter is empty, the current page is the last page.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', 'title' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'ListRecyclebin', + 'summary' => 'Lists the files and folders in the recycle bin.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', - 'title' => 'ClearRecyclebin', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1\\"\\n}","type":"json"}]', ], - 'ListRecyclebin' => [ - 'summary' => 'Queries the information about files and folders in the recycle bin.', - 'path' => '/v2/recyclebin/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ListRevision' => [ + 'path' => '/v2/file/revision/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -13302,77 +7664,40 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the domain.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'marker' => [ - 'description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned. This parameter is left empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'limit' => [ - 'description' => 'The maximum number of entries to return. Valid values: 1 to 200. Default value: 50.'."\n" - ."\n" - .'The number of returned entries must be less than or equal to the value of this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - 'fields' => [ - 'description' => 'The fields of an entry (file or folder) to return.'."\n" - ."\n" - .'1\\. If you set this parameter to \\*, all fields are returned.'."\n" - ."\n" - .'2\\. If you set this parameter to a null value or leave this parameter empty, the fields, such as file creator, file modifier, and custom tags, are not returned.'."\n" - ."\n" - .'The default value is a null value, which indicates that only some fields are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'thumbnail_processes' => [ - 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - '$ref' => '#/components/schemas/ImageProcess', - 'description' => 'The rules used to generate the thumbnails of images, videos, and documents.'."\n", - ], - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'marker' => ['description' => 'A pagination marker. The response includes only revisions that occur alphabetically after the specified value. If you do not specify this parameter, the query starts from the beginning of the collection.'."\n" + ."\n" + .'Default value: None', 'type' => 'string', 'required' => false, 'example' => '40CB7794C929', 'title' => ''], + 'limit' => ['description' => 'The maximum number of revisions to return. The value must be an integer from 1 to 100.'."\n" + ."\n" + .'The default value is 50.'."\n" + ."\n" + .'The actual number of returned revisions may be less than the specified value.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '200', 'minimum' => '1', 'required' => false, 'example' => '100', 'title' => ''], + 'fields' => ['description' => 'Specifies the fields to return.'."\n" + ."\n" + .'By default, this parameter is empty. If you set this parameter to `*`, all fields are returned, including the name of the creator.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13380,90 +7705,103 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response payload.', 'type' => 'object', 'properties' => [ 'items' => [ - 'description' => 'The information about the files and folders in the recycle bin.'."\n", + 'description' => 'An array of revision objects.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a file or folder.'."\n", - '$ref' => '#/components/schemas/File', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1', + 'items' => ['description' => 'A revision object.', '$ref' => '#/components/schemas/Revision', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The pagination marker for the next page of results. If this parameter is empty, it indicates that all results have been returned.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'ListRecyclebin', - ], - 'RestoreFile' => [ - 'summary' => 'Restores a file or folder from the recycle bin.', - 'path' => '/v2/recyclebin/restore', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListRevision', + 'summary' => 'Lists the revisions of a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"9520943DC264\\",\\n \\"revision_id\\": \\"40CB7794C929\\",\\n \\"revision_name\\": \\"1.mov\\",\\n \\"revision_version\\": 1,\\n \\"size\\": 1024,\\n \\"file_extension\\": \\"mov\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"keep_forever\\": false,\\n \\"revision_description\\": \\"aaa\\",\\n \\"is_latest_version\\": false,\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListShareLink' => [ + 'path' => '/v2/share_link/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", + 'creator' => ['description' => 'The user ID of the creator.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'limit' => ['description' => 'The maximum number of shares to return. The value must be in the range of \\[0, 100].'."\n" + ."\n" + .'The number of results returned can be less than the specified value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'A token for paginating results. To retrieve the next page, provide the `next_marker` value from the previous response. Omit this parameter to query from the beginning.<br>Default: none<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'order_by' => [ + 'description' => 'The field to sort results by.'."\n" + .'By default, results are sorted by creation time in descending order.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `share_name`: share name'."\n" + ."\n" + .'- `updated_at`: modification time'."\n" + ."\n" + .'- `description`: share description'."\n" + ."\n" + .'- `created_at`: creation time', + 'enumValueTitles' => ['share_name' => 'share name', 'updated_at' => 'modification time', 'description' => 'share description', 'created_at' => 'creation time'], 'type' => 'string', - 'required' => true, - 'example' => '1', + 'required' => false, + 'example' => 'share_name', + 'title' => '', ], - 'file_id' => [ - 'description' => 'The ID of the file or folder.'."\n", + 'order_direction' => [ + 'description' => 'The sort order.'."\n" + .'If the sort field is `created_at` or `updated_at`, the default order is descending. For other sort fields, the default is ascending.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `ASC`: ascending order'."\n" + ."\n" + .'- `DESC`: descending order', + 'enumValueTitles' => ['ASC' => 'ascending order', 'DESC' => 'descending order'], 'type' => 'string', - 'required' => true, - 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + 'required' => false, + 'example' => 'ASC', + 'title' => '', ], + 'include_cancelled' => ['description' => 'Specifies whether to include canceled shares in the response.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13471,54 +7809,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The ID of the file or folder.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', - ], - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'If an empty string is returned, the file or folder is restored.'."\n" - ."\n" - .'If a non-empty string is returned, an asynchronous task is required. You can call the GetAsyncTask operation to obtain the information about an asynchronous task based on the task ID.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + 'items' => [ + 'description' => 'The list of shares.', + 'type' => 'array', + 'items' => ['description' => 'A share.', '$ref' => '#/components/schemas/ShareLink', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'A token for the next page of results. This field is omitted if there are no more results to return.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], - 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' => 'RestoreFile', - ], - 'UpdateFacegroup' => [ - 'summary' => 'Updates a face-based group.', - 'path' => '/v2/image/update_facegroup_info', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', ], - 'tags' => [ - 'api', + 'title' => 'ListShareLink', + 'summary' => 'Lists shares.', + 'description' => 'Deprecated. Use `SearchShareLink` instead.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"share_pwd\\": \\"abcF123x\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id_list\\": [\\n \\"[\\\\\\"xx\\\\\\"]\\"\\n ],\\n \\"expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"expired\\": false,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"videos\\",\\n \\"share_name\\": \\"video-1.MP4\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"status\\": \\"enabled\\",\\n \\"preview_count\\": 10,\\n \\"save_count\\": 2,\\n \\"download_count\\": 5,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 1,\\n \\"access_count\\": 4,\\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 \\"share_all_files\\": true,\\n \\"save_download_limit\\": 100,\\n \\"office_editable\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + ], + 'ListTags' => [ + 'path' => '/v2/image/list_tags', + 'methods' => ['post'], + 'schemes' => ['https', 'http'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -13527,197 +7847,141 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'group_id' => [ - 'description' => 'The ID of the face-based group. You can call the ListFacegroups operation to query the group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'group-abc', - ], - 'group_name' => [ - 'description' => 'The name of the face-based group. The name can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 128, - 'minLength' => 1, - ], - 'group_cover_face_id' => [ - 'description' => 'The face ID of the thumbnail of the face-based group. You can obtain the face ID from the **image_media_metadata** parameter in the returned results of the GetFile, ListFile, or SearchFile operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'face1', - ], - 'remarks' => [ - 'description' => 'The remarks. The remarks can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'image_thumbnail_process' => ['description' => 'Specifies the processing style for image thumbnails.', 'type' => 'string', 'required' => false, 'example' => 'image/resize,w_200', 'title' => ''], + 'video_thumbnail_process' => ['description' => 'Specifies the processing style for video thumbnails.', 'type' => 'string', 'required' => false, 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => 'Id of the request', - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'group_id' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => 'group-abc', + 'tags' => [ + 'description' => 'The list of tag groups.', + 'type' => 'array', + 'items' => ['description' => 'The information for a single tag group.', '$ref' => '#/components/schemas/ImageTag', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"group_id\\": \\"group-abc\\"\\n}","type":"json"}]', - 'title' => 'UpdateFacegroup', - ], - 'ListTags' => [ - 'summary' => 'Queries tags.', - 'path' => '/v2/image/list_tags', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'api', + 'title' => 'ListTags', + 'summary' => 'Lists tag groups.', + 'description' => 'This operation returns the top 2,000 tag groups for a specified drive, sorted by the number of photos in each group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tags\\": [\\n {\\n \\"name\\": \\"动物\\",\\n \\"count\\": 1,\\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"}]', + ], + 'ListUploadedParts' => [ + 'summary' => 'Lists the parts that have been successfully uploaded for a specific multipart upload.', + 'path' => '/v2/file/list_uploaded_parts', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'image_thumbnail_process' => [ - 'description' => 'The method that is used to generate the thumbnail of an image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,w_200', - ], - 'video_thumbnail_process' => [ - 'description' => 'The method that is used to generate the thumbnail of a video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', - ], + 'part_number_marker' => ['description' => 'The marker that specifies the position after which to start listing parts. Obtain this value from the `next_part_number_marker` field in a previous response. If this parameter is omitted, the listing starts from the first part.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of parts to return. The value cannot exceed 100. The default is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'required' => true, 'example' => '00166D06127B413BA1EC8ABB1144D101', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2', 'title' => ''], + 'drive_id' => ['description' => 'The drive ID. Required for all scenarios except uploads from a share.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'share_id' => ['description' => 'The share ID. Required when uploading from a share.', 'type' => 'string', 'required' => false, 'example' => '7JQX1FswpQ8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'tags' => [ - 'description' => 'The information about the tags.'."\n", + 'file_id' => ['title' => 'Id of the request', 'description' => 'The file ID.', 'type' => 'string', 'example' => '322fb07b975f4b0ae1b543fe8475eee4c19eb2b2'], + 'upload_id' => ['description' => 'The upload ID.', 'type' => 'string', 'example' => '00166D06127B413BA1EC8ABB1144D101', 'title' => ''], + 'uploaded_parts' => [ + 'description' => 'A list of uploaded parts.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a tag.'."\n", - '$ref' => '#/components/schemas/ImageTag', - ], + 'items' => ['description' => 'Information about a single part.', '$ref' => '#/components/schemas/UploadPartInfo', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_part_number_marker' => ['description' => 'The marker for the next page of results. This value is empty when there are no more results to return.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'parallel_upload' => ['description' => 'Indicates whether parallel upload is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'ListTags', - 'description' => 'You can call this operation to query the tags within the specified drive at a time. The top 2,000 tags of the images are returned.'."\n", - ], - 'ListAddressGroups' => [ - 'summary' => 'Queries location-based groups.', - 'path' => '/v2/image/list_address_groups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListUploadedParts', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\",\\n \\"internal_upload_url\\": \\"https://data-vpc.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E269772661\\\\n\\",\\n \\"etag\\": \\"\\\\\\"0CC175B9C0F1B6A831C399E269772661\\\\\\"\\",\\n \\"parallel_sha1_ctx\\": {\\n \\"h\\": [\\n 0\\n ],\\n \\"part_offset\\": 10240\\n },\\n \\"upload_form_info\\": {\\n \\"endpoint\\": \\"\\",\\n \\"form_data\\": {\\n \\"key\\": \\"\\"\\n }\\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"}]', + ], + 'ListUser' => [ + 'path' => '/v2/user/list', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -13726,63 +7990,29 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'image_thumbnail_process' => [ - 'description' => 'The method that is used to generate a thumbnail of an image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,w_200', - ], - 'video_thumbnail_process' => [ - 'description' => 'The method that is used to generate a thumbnail of a video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video_thumbnail_process', - ], + 'marker' => ['description' => 'The pagination token that specifies the starting position of the results. The results are returned in alphabetical order. If you omit this parameter, results are returned from the start of the list.<br>**Default value**: none.<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of users to return.<br>**Value range**: 1 to 100.<br>**Default value**: 100.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -13790,41 +8020,35 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ + 'next_marker' => ['title' => 'Id of the request', 'description' => 'The token for retrieving the next page of results. This parameter is empty when all results have been returned.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'], 'items' => [ - 'description' => 'The information about the location-based groups.'."\n", + 'description' => 'A list of users.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a location-based group.'."\n", - '$ref' => '#/components/schemas/AddressGroup', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + 'items' => ['description' => 'The user information.', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'ListAddressGroups', - ], - 'ListFacegroups' => [ - 'summary' => 'Queries face-based groups.', - 'path' => '/v2/image/list_facegroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'ListUser', + 'summary' => 'Lists users.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'MoveFile' => [ + 'path' => '/v2/file/move', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -13833,21 +8057,27 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'drive_id' => ['description' => 'The drive ID.'], + 'file_id' => ['description' => 'The file ID.'], + 'to_parent_file_id' => ['description' => 'The ID of the destination parent directory to which you want to move a file or folder. If you want to move a file or folder to the root directory, set this parameter to root.'], + 'check_name_mode' => ['description' => 'The method for handling a name conflict if a file with the same name exists in the destination directory. Valid values: `ignore`: Moves the file without renaming it. `auto_rename`: Automatically renames the file. By default, the current time is appended to the file name, such as `xxx_20060102_150405`. `refuse`: Does not move the file and returns information about the existing file. Default value: `ignore`.'], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -13858,253 +8088,127 @@ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'remarks' => [ - 'description' => 'The filter condition that is used to query groups. The value can be up to 128 characters in length. An exact match is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 128, - 'minLength' => 1, - ], - 'limit' => [ - 'description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'marker' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker. By default, this parameter is left empty.'."\n", + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'to_parent_file_id' => ['description' => 'The ID of the destination parent directory to which you want to move a file or folder. If you want to move a file or folder to the root directory, set this parameter to root.', 'type' => 'string', 'required' => true, 'example' => '6520943DC261', 'title' => ''], + 'check_name_mode' => [ + 'description' => 'The method for handling a name conflict if a file with the same name exists in the destination directory. Valid values: `ignore`: Moves the file without renaming it. `auto_rename`: Automatically renames the file. By default, the current time is appended to the file name, such as `xxx_20060102_150405`. `refuse`: Does not move the file and returns information about the existing file. Default value: `ignore`.', 'type' => 'string', + 'enum' => ['ignore', 'auto_rename', 'refuse'], 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'return_total_count' => [ - 'type' => 'boolean', - 'required' => false, + 'example' => 'ignore', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => 'The information about the face-based groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a face-based group.'."\n", - '$ref' => '#/components/schemas/FaceGroup', - ], - ], - 'next_marker' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', - ], - 'total_count' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'fileid1', 'title' => ''], + 'async_task_id' => ['description' => 'The ID of the asynchronous task.'."\n" + ."\n" + .'If an empty string is returned, the move completed successfully.'."\n" + ."\n" + .'If a non-empty string is returned, the move is processed asynchronously. Call GetAsyncTask and pass the asynchronous task ID to get information about the task.', 'type' => 'string', 'example' => '23ebd1a24dba4166b1527add476ef2866051b4d5del106', 'title' => ''], + 'exist' => ['description' => 'Indicates whether the file already exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'revision_id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'file_name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'updated_at' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - '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' => 'ListFacegroups', - ], - 'SearchAddressGroups' => [ - 'summary' => 'Queries location-based groups based on specific locations.', - 'path' => '/v2/image/search_address_groups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'title' => 'MoveFile', + 'summary' => 'Moves a file or folder.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + '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"}]', + ], + 'PunishFile' => [ + 'summary' => 'Penalty information file.', + 'path' => '/v2/csi/business/punish_file', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'example' => 'bj2', 'description' => '', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", + 'drive_id' => ['description' => 'The ID of the drive that contains the file.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '2498DZ2', 'title' => ''], + 'action_code' => [ + 'description' => 'The penalty action. Valid values:`pds_file_meta_frozen`: Freezes the file.`pds_file_meta_share_forbidden`: Disables sharing for the file.`pds_file_meta_remove_punish`: Removes the penalty from the file.`pds_file_frozen`: Freezes the file at the content level.`pds_fileshare_forbidden`: Disables sharing for the file at the content level.`pds_file_remove_punish`: Removes the penalty from the file at the content level.A content-level penalty affects all files that have the same content. A non-content-level penalty affects only the specified file.', + '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'], 'type' => 'string', 'required' => true, - 'example' => '1', - ], - 'tl_geo_point' => [ - 'description' => 'The coordinates of the top left vertex of the rectangle. Set the value in the format of latitude,longitude.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '39.121,101.2121', - ], - 'br_geo_point' => [ - 'description' => 'The coordinates of the bottom right vertex of the rectangle. Set the value in the format of latitude,longitude.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '40.121,105.2121', - ], - 'address_level' => [ - 'description' => 'The level of the location.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* country'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* province'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* city'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* district'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* township'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'country' => 'country', - 'province' => 'province', - 'city' => 'city', - 'district' => 'district', - 'township' => 'township', - ], - 'example' => '', - ], - 'address_names' => [ - 'description' => 'The locations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The locations. You can specify up to 10 locations. The level of the specified locations must be the same as the value of address_level. This parameter and a combination of tl_geo_point and br_geo_point are mutually exclusive. Specify either address_names or a combination of tl_geo_point and br_geo_point.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'maxItems' => 10, - 'minItems' => 1, - ], - 'image_thumbnail_process' => [ - 'description' => 'The method used to generate the thumbnail of an image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,w_200', - ], - 'video_thumbnail_process' => [ - 'description' => 'The method used to generate the thumbnail of a video.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', + 'example' => 'pds_file_meta_frozen', + 'title' => '', ], + 'punish_reason' => ['description' => 'The reason for the penalty.', 'type' => 'string', 'example' => 'illegal', 'title' => '', 'required' => false], ], 'required' => false, + 'description' => 'The request body.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The location-based groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The location-based group.'."\n", - '$ref' => '#/components/schemas/AddressGroup', - ], - ], - ], + 'properties' => [], + 'example' => '', ], ], ], - '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' => 'SearchAddressGroups', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PunishFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'RemoveFaceGroupFile' => [ - 'summary' => '从人脸分组中的移除指定的文件', 'path' => '/v2/albums/unassign_facegroup_item', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -14113,72 +8217,50 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - 'face_group_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Cluster-abc', - ], - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'abcd', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + 'face_group_id' => ['description' => 'The face group ID.', 'type' => 'string', 'required' => true, 'example' => 'Cluster-abc', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file to remove.', 'type' => 'string', 'required' => true, 'example' => 'abcd', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 204 => [], ], + 'title' => 'Delete a Face Group File', + 'summary' => 'Removes a file from a face group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'RemoveFaceGroupFile', ], - 'CreateStory' => [ - 'summary' => '创建推荐故事', - 'path' => '/v2/image/create_story', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'RemoveGroupMember' => [ + 'path' => '/v2/group/remove_member', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -14187,163 +8269,64 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'story_start_time' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-12-30T16:00:00Z', - ], - 'story_end_time' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-30T16:00:00Z', - ], - 'min_image_count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - 'max_image_count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'example' => '30', - 'default' => '30', - ], - 'custom_labels' => [ - 'description' => '', - 'type' => 'object', - 'deprecated' => true, - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"key": "value"}', - 'description' => '', - ], - ], - 'address' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Address', - ], + 'group_id' => ['description' => 'The ID of the group to remove the member from.', 'type' => 'string', 'required' => true, 'example' => '3e5***2c2', 'title' => ''], + 'member_type' => ['description' => 'The member type. This operation only removes users. To remove a member that is a group, delete the group instead.'."\n" + ."\n" + .'- user'."\n" + ."\n" + .'Note: A group can be a member of only one other group. A user can be a member of multiple groups.', 'type' => 'string', 'required' => true, 'example' => 'user', 'title' => ''], + 'member_id' => ['description' => 'The member ID. If `member_type` is `user`, this is the `userID`.', 'type' => 'string', 'required' => true, 'example' => '2e4***1b1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 204 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', - 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], + 'properties' => [], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'RemoveGroupMember', + 'summary' => 'Removes a member from a group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', - 'title' => 'CreateStory', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'CreateCustomizedStory' => [ - 'summary' => '创建自定义故事', - 'path' => '/v2/image/create_customized_story', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'RemoveStoryFiles' => [ + 'path' => '/v2/image/remove_story_files', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -14352,116 +8335,50 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_name', - ], - 'story_cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', - ], - ], - 'required' => true, - ], - 'story_files' => [ - 'description' => '', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'required' => true, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'files' => [ + 'description' => 'The files to remove from the story.', 'type' => 'array', 'items' => [ + 'description' => 'The details of a file to remove.', 'type' => 'object', 'properties' => [ - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', - ], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'revision_id' => ['description' => 'The revision ID.', 'type' => 'string', 'required' => false, 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'minItems' => 1, - ], - 'custom_labels' => [ - 'description' => '', - 'type' => 'object', - 'deprecated' => true, 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"key":"value"}', - 'description' => '', - ], + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -14469,41 +8386,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Remove files from a story', + 'summary' => 'Removes one or more files from a specified story.', + 'description' => '**Before calling this operation, ensure you understand PDS billing and review its [Pricing](~~425220~~).**'."\n" + ."\n" + .'To use this feature, you must enable the image processing value-added service.'."\n" + ."\n" + .'After you create a story, you can remove unwanted files from it as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', - 'title' => 'CreateCustomizedStory', ], - 'SearchStories' => [ - 'summary' => '查询故事列表', - 'path' => '/v2/image/find_stories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'RestoreFile' => [ + 'summary' => 'Restores a file or folder from the recycle bin.', + 'path' => '/v2/recyclebin/restore', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -14512,214 +8424,30 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'story_type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PeopleMemory', - ], - 'story_name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'story_start_time_range' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'start' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-12-31T00:00:00+08:00', - ], - 'end' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-31T00:00:00+08:00', - ], - ], - 'required' => false, - ], - 'story_end_time_range' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'start' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-12-31T00:00:00+08:00', - ], - 'end' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-31T00:00:00+08:00', - ], - ], - 'required' => false, - ], - 'create_time_range' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'start' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-12-31T00:00:00+08:00', - ], - 'end' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-12-31T00:00:00+08:00', - ], - ], - 'required' => false, - ], - 'face_group_ids' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', - ], - 'required' => false, - ], - 'custom_labels' => [ - 'description' => '', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'key1=value1,key2!=value2', - ], - 'with_empty_stories' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'marker' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'NWQ1Yjk4YmI1ZDODBhNDQ2Nzhl***', - ], - 'limit' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'maximum' => '86400', - 'minimum' => '10', - 'example' => '900', - 'default' => '900', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file or folder ID.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -14727,44 +8455,35 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/Story', - ], - ], - 'next_marker' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***', - ], + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file or folder ID.', 'type' => 'string', 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', 'title' => ''], + 'async_task_id' => ['description' => 'The asynchronous task ID.'."\n" + ."\n" + .'If this parameter is empty, the file or folder is restored synchronously.'."\n" + ."\n" + .'If this parameter contains a value, the restore is asynchronous. You can then call the GetAsyncTask operation with this ID to query the task status.', 'type' => 'string', 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], ], + 'example' => '', ], ], + 204 => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'RestoreFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'SearchStories', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"4221bf6e6ab43a255edc4463bffa6f5f5d317401\\",\\n \\"async_task_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d317406\\"\\n}","type":"json"}]', ], - 'GetStory' => [ - 'summary' => '获取故事详情', - 'path' => '/v2/image/get_story', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'RestoreRevision' => [ + 'path' => '/v2/file/revision/restore', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -14773,213 +8492,102 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the domain.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'cover_image_thumbnail_process' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', - 'deprecated' => true, - ], - 'cover_video_thumbnail_process' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', - 'deprecated' => true, - ], - 'image_url_process' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', - 'deprecated' => true, - ], - 'image_thumbnail_process' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', - 'deprecated' => true, - ], - 'video_thumbnail_process' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', - 'deprecated' => true, - ], - 'url_expire_sec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '86400', - 'minimum' => '10', - 'example' => '900', - 'default' => '900', - 'deprecated' => true, - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The ID of the file.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'revision_id' => ['description' => 'The ID of the revision.', 'type' => 'string', 'required' => true, 'example' => '40CB7794C929', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => '', - '$ref' => '#/components/schemas/Story', - ], + 'schema' => ['description' => 'The revision information.', '$ref' => '#/components/schemas/Revision', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'RestoreRevision', + 'summary' => 'Restores a historical revision of a file, making it the latest revision. This action creates a new revision, and the original historical revision remains unchanged. You cannot restore the latest revision.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'GetStory', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"9520943DC264\\",\\n \\"revision_id\\": \\"40CB7794C929\\",\\n \\"revision_name\\": \\"1.mov\\",\\n \\"revision_version\\": 1,\\n \\"size\\": 1024,\\n \\"file_extension\\": \\"mov\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"keep_forever\\": false,\\n \\"revision_description\\": \\"aaa\\",\\n \\"is_latest_version\\": false,\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\"\\n}","type":"json"}]', ], - 'UpdateStory' => [ - 'summary' => '更新故事', - 'path' => '/v2/image/update_story', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'ScanFile' => [ + 'path' => '/v2/file/scan', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], - ], - [ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'story_name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name1', - ], - 'custom_labels' => [ - 'description' => '', - 'type' => 'object', - 'deprecated' => true, - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"key":"value"}', - 'description' => '', - ], - ], - 'cover' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', - ], - ], - 'required' => false, - ], + 'drive_id' => ['description' => 'Drive ID', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'limit' => ['description' => 'Limit the number of resources returned in this response. Valid values: \\[1, 100].'."\n" + ."\n" + .'The actual number of results may be less than the specified limit but never more.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'Return results starting from the first item after the marker, sorted alphabetically. If not set, return results from the beginning.<br>Default value: none<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'fields' => ['description' => 'File properties to include in the scan response.'."\n" + ."\n" + .'- Use \'\\*\' to get all properties.'."\n" + ."\n" + .'- If not specified, the following properties are returned by default:'."\n" + .' \\- file\\_id,'."\n" + .' \\- drive\\_id,'."\n" + .' \\- parent\\_file\\_id,'."\n" + .' \\- type,'."\n" + .' \\- created\\_at,'."\n" + .' \\- updated\\_at,'."\n" + .' \\- file\\_extension,'."\n" + .' \\- size,'."\n" + .' \\- starred,'."\n" + .' \\- status,'."\n" + .' \\- category,'."\n" + .' \\- permissions.'."\n" + ."\n" + .'- You can also specify individual properties. Separate multiple properties with commas.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '*'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -14987,41 +8595,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + 'items' => [ + 'description' => 'List of files', + 'type' => 'array', + 'items' => ['description' => 'File information', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'Identifier of the first resource on the next page. This value is empty on the last page.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ScanFile', + 'summary' => 'Scans a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', - 'title' => 'UpdateStory', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', ], - 'DeleteStory' => [ - 'summary' => '删除故事', - 'path' => '/v2/image/delete_story', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchAddressGroups' => [ + 'summary' => 'Searches for address groups based on a list of locations or a geographic area.', + 'path' => '/v2/image/search_address_groups', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -15030,50 +8633,50 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'tl_geo_point' => ['description' => 'The top-left point of the rectangle (latitude, longitude).', 'type' => 'string', 'required' => false, 'example' => '39.121,101.2121', 'title' => ''], + 'br_geo_point' => ['description' => 'The bottom-right point of the rectangle (latitude, longitude).', 'type' => 'string', 'required' => false, 'example' => '40.121,105.2121', 'title' => ''], + 'address_level' => [ + 'description' => 'The address level for the query.', + 'enumValueTitles' => ['country' => '', 'province' => '', 'city' => '', 'district' => '', 'township' => ''], 'type' => 'string', - 'required' => true, - 'example' => '1', + 'example' => 'city', + 'required' => false, + 'title' => '', ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + 'address_names' => [ + 'description' => 'A list of address names.', + 'type' => 'array', + 'items' => ['description' => 'The array can contain up to 10 address names. Each name must correspond to the specified `address_level`. This parameter is mutually exclusive with `tl_geo_point` and `br_geo_point`.', 'type' => 'string', 'required' => false, 'example' => '["杭州市","北京市"]', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'example' => '["Hangzhou","Beijing"]', ], + 'image_thumbnail_process' => ['description' => 'The processing style for image thumbnails.', 'type' => 'string', 'required' => false, 'example' => 'image/resize,w_200', 'title' => ''], + 'video_thumbnail_process' => ['description' => 'The processing style for video thumbnails.', 'type' => 'string', 'required' => false, 'example' => 'video/snapshot,t_7000,f_jpg,w_800,h_600,m_fast', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15081,164 +8684,102 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', + 'items' => [ + 'description' => 'The list of address groups.', + 'type' => 'array', + 'items' => ['description' => 'An address group.', '$ref' => '#/components/schemas/AddressGroup', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"location\\": \\"30.12231,120.1212\\",\\n \\"count\\": 10,\\n \\"cover_url\\": \\"\\",\\n \\"cover_file_id\\": \\"\\",\\n \\"address_detail\\": {\\n \\"country\\": \\"None \\",\\n \\"province\\": \\"None\\",\\n \\"city\\": \\"None\\",\\n \\"district\\": \\"None\\",\\n \\"township\\": \\"None\\\\n\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SearchAddressGroups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', - 'title' => 'DeleteStory', + 'translator' => 'machine', ], - 'AddStoryFiles' => [ - 'summary' => '故事添加文件', - 'path' => '/v2/image/add_story_files', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchDomains' => [ + 'summary' => 'Searches for domains', + 'path' => '/v2/domain/search', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - ], - 'consumes' => [ - 'application/json', ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'files' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => ['description' => 'The name of the domain. Fuzzy search is supported.', 'type' => 'string', 'example' => 'Hello Drive', 'required' => false, 'title' => ''], + 'marker' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.<br> By default, this parameter is empty.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 100.'."\n" + ."\n" + .'The number of returned results must be less than or equal to the specified number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + 'order_by' => ['description' => 'The sorting rule. Set the value to created\\_at, which specifies that the results are sorted based on the time when the domain was created.', 'type' => 'string', 'required' => false, 'example' => 'created_at', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'files' => [ + 'items' => [ + 'description' => 'The queried domains.', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/AddStoryFile', - ], - ], - 'request_id' => [ - 'type' => 'string', + 'items' => ['description' => 'The queried domain.', '$ref' => '#/components/schemas/Domain', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If next\\_marker is empty, no next page exists.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"bj1\\",\\n \\"domain_id\\": \\"bj2\\",\\n \\"domain_name\\": \\"pdsdomain\\",\\n \\"description\\": \\"my domain\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 1073741824,\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"size_quota\\": 1099511627776,\\n \\"size_quota_used\\": 1099511627776,\\n \\"user_count_quota\\": 50,\\n \\"status\\": 1,\\n \\"used_size\\": 1099511627776,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"deny\\",\\n \\"except_app_id_list\\": [\\n \\"8ovxCTRUDdbpVWBP\\"\\n ]\\n },\\n \\"sharable\\": false,\\n \\"data_hash_name\\": \\"sha1\\",\\n \\"store_redundancy_type\\": \\"LRS\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'SearchDomains', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'AddStoryFiles', + 'translator' => 'manual', ], - 'RemoveStoryFiles' => [ - 'summary' => '故事移除文件', - 'path' => '/v2/image/remove_story_files', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchDrive' => [ + 'summary' => 'Searches for drives.', + 'path' => '/v2/drive/search', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -15247,75 +8788,42 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', + 'drive_name' => ['description' => 'The drive name.', 'type' => 'string', 'example' => 'My personal space', 'required' => false, 'title' => ''], + 'limit' => ['description' => 'The maximum number of drives to return. The value must be from 1 to 100. Default: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'exclusiveMinimum' => true, 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + 'marker' => ['description' => 'The pagination token. The server returns results alphabetically, starting from the entry after the marker. If this parameter is omitted, the query starts from the beginning of the list.<br>Default: none<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'owner' => ['description' => 'The ID of the owner.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'owner_type' => [ + 'description' => 'The owner type. Valid values:'."\n" + ."\n" + .'`user`: An individual user.<br>`group`: A group of users.<br>', 'type' => 'string', - 'required' => true, - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', - ], - 'files' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', - ], - 'revision_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', - ], - ], - 'required' => false, - ], + 'example' => 'user', + 'enum' => ['user', 'group'], 'required' => false, - 'maxItems' => 100, + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15323,41 +8831,35 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'story_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + 'items' => [ + 'description' => 'The list of drives.', + 'type' => 'array', + 'items' => ['description' => 'The drive information.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The token used to retrieve the next page of results. This parameter is not returned when all results have been retrieved.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'SearchDrive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', - 'title' => 'RemoveStoryFiles', + 'translator' => 'machine', ], - 'CreateSimilarImageClusterTask' => [ - 'summary' => '创建相似图片聚类任务', - 'path' => '/v2/image/create_similar_image_cluster_task', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchFile' => [ + 'path' => '/v2/file/search', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -15366,26 +8868,35 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', 'schema' => [ + 'properties' => [ + 'drive_id' => ['description' => 'The drive ID.'], + 'query' => ['description' => 'The search conditions. Fuzzy searches based on the file name or directory name are supported. The value of this parameter can be up to 4,096 characters in length.'], + 'order_by' => ['description' => 'The field by which to sort the returned entries. Default value: created_at. Valid values: * created_at: sorts the entries by creation time. * updated_at: sorts the entries by update time. * size: sorts the entries by file size. * name: sorts the entries by file name. The order in which you want to sort the returned entries. Valid values: * ASC: ascending order * DESC: descending order You must specify this parameter in the <field> <asc> format. Separate multiple fields with commas (,). A preceding field has a higher priority than a following field. Examples: * If you want to sort the entries by file name in ascending order, set this parameter to "name ASC". * If you want to sort the entries by creation time in descending order, set this parameter to "created_at DESC". * If you want to sort the entries by creation time in descending order and sort the entries by file name in ascending order in case of the same creation time, set this parameter to "created_at DESC,name ASC".'], + 'limit' => ['description' => 'The maximum number of entries to return. Valid values: 1 to 100. The number of returned entries must be less than or equal to the value of this parameter.'], + 'marker' => ['description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned.\\ This parameter is left empty by default.'], + 'return_total_count' => ['description' => 'Specifies whether to return the total number of retrieved files.'], + 'recursive' => ['description' => 'Specifies whether to perform recursive search on a folder that is specified by setting parent_file_id in the query parameter.'], + 'thumbnail_processes' => [ + 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.', + 'additionalProperties' => ['description' => 'The rules used to generate the thumbnails of images, videos, and documents.'], + ], + 'fields' => ['description' => 'The field that is used to return additional information about files. Valid values: * dir_size: returns the statistics on each subfolder in the response. * id_path: returns the id_path value of each child subject in the response. * name_path: returns the name_path value of each child subject in the response. You can specify multiple fields by separating them with commas (,). Example: "id_path,name_path,dir_size".'], + ], 'type' => 'string', 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -15393,104 +8904,186 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'query' => ['description' => 'The search conditions. Fuzzy searches based on the file name or directory name are supported. The value of this parameter can be up to 4,096 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 4096, 'example' => 'name="123"', 'title' => ''], + 'order_by' => [ + 'description' => 'The field by which to sort the returned entries. Default value: created_at. Valid values:'."\n" + .'\\* created_at: sorts the entries by creation time.'."\n" + .'\\* updated_at: sorts the entries by update time.'."\n" + .'\\* size: sorts the entries by file size.'."\n" + .'\\* name: sorts the entries by file name.'."\n" + .'The order in which you want to sort the returned entries. Valid values:'."\n" + .'\\* ASC: ascending order'."\n" + .'\\* DESC: descending order'."\n" + .'You must specify this parameter in the <field> <asc> format. Separate multiple fields with commas (,). A preceding field has a higher priority than a following field. Examples:'."\n" + .'\\* If you want to sort the entries by file name in ascending order, set this parameter to "name ASC".'."\n" + .'\\* If you want to sort the entries by creation time in descending order, set this parameter to "created_at DESC".'."\n" + .'\\* If you want to sort the entries by creation time in descending order and sort the entries by file name in ascending order in case of the same creation time, set this parameter to "created_at DESC,name ASC".', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => '123', + 'enum' => ['name', 'type', 'created_at', 'updated_at', 'size', 'image_time', 'last_access_at', 'custom_type', 'custom_field_1', 'custom_field_2', 'image_overall_score'], + 'required' => false, + 'example' => 'name ASC', + 'title' => '', + ], + 'limit' => ['description' => 'The maximum number of entries to return. Valid values: 1 to 100.'."\n" + .'The number of returned entries must be less than or equal to the value of this parameter.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'The name of the entry after which the list begins. Entries whose names are alphabetically after the value of this parameter are returned. If you do not specify this parameter, all entries are returned.\\'."\n" + .'This parameter is left empty by default.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'return_total_count' => ['description' => 'Specifies whether to return the total number of retrieved files.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'recursive' => ['description' => 'Specifies whether to perform recursive search on a folder that is specified by setting parent_file_id in the query parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'thumbnail_processes' => [ + 'description' => 'The thumbnail configurations. Up to five thumbnails can be returned at a time. The value contains key-value pairs. You can customize the keys. The URL of a thumbnail is returned based on the key.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The rules used to generate the thumbnails of images, videos, and documents.', '$ref' => '#/components/schemas/ImageProcess', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'fields' => ['description' => 'The field that is used to return additional information about files. Valid values:'."\n" + .'\\* dir_size: returns the statistics on each subfolder in the response.'."\n" + .'\\* id_path: returns the id_path value of each child subject in the response.'."\n" + .'\\* name_path: returns the name_path value of each child subject in the response.'."\n" + .'You can specify multiple fields by separating them with commas (,). Example: "id_path,name_path,dir_size".', 'type' => 'string', 'required' => false, 'example' => 'id_path,name_path', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + 'items' => [ + 'description' => 'List of file information.', + 'type' => 'array', + 'items' => ['description' => 'File information', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The identity of the starting resource on the next page. This value is empty on the last page.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'total_count' => ['description' => 'Total number of files that match the search.', 'type' => 'integer', 'format' => 'int64', 'example' => '1022', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'SearchFile', + 'summary' => 'Searches for files.', + 'description' => '<props="china">'."\n" + ."\n" + .'For best practices, see [Search files](https://help.aliyun.com/document_detail/175890.html).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"task_id\\": \\"i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb\\"\\n}","type":"json"}]', - 'title' => 'CreateSimilarImageClusterTask', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 1022\\n}","type":"json"}]', ], - 'GetTaskStatus' => [ - 'summary' => 'Queries the execution status of a value-added asynchronous task. You can call this operation to query the execution status of an asynchronous task that is created by calling the CreateSimilarImageClusterTask operation.', - 'path' => '/v2/image/get_task_status', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchShareLink' => [ + 'path' => '/v2/share_link/search', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", + 'limit' => ['description' => 'The maximum number of shares to return. Valid values: 1-100. Default: 100.'."\n" + ."\n" + .'The number of shares returned may be less than the specified limit.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'marker' => ['description' => 'Use the `next_marker` value from a previous response to retrieve the next page of results.<br>If this parameter is not specified, the first page of results is returned.<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'return_total_count' => ['description' => 'Specifies whether to return the total count of matched shares.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'order_by' => [ + 'description' => 'The sort field.'."\n" + .'By default, results are sorted by creation time in descending order.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `share_name`: The share name.'."\n" + ."\n" + .'- `updated_at`: The update time.'."\n" + ."\n" + .'- `description`: The description.'."\n" + ."\n" + .'- `created_at`: The creation time.', + 'enumValueTitles' => ['share_name' => '', 'updated_at' => '', 'description' => '', 'created_at' => ''], 'type' => 'string', - 'required' => true, - 'example' => '1', + 'required' => false, + 'example' => 'created_at', + 'title' => '', ], - 'task_id' => [ - 'description' => 'The ID of the task.'."\n", + 'order_direction' => [ + 'description' => 'The sort order.'."\n" + .'If the sort field is `created_at` or `updated_at`, the default order is descending. For other sort fields, the default order is ascending.'."\n" + .'Valid values:'."\n" + ."\n" + .'- `ASC`: ascending'."\n" + ."\n" + .'- `DESC`: descending', + 'enumValueTitles' => ['ASC' => '', 'DESC' => ''], 'type' => 'string', - 'required' => true, - 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + 'required' => false, + 'example' => 'ASC', + 'title' => '', ], + 'creators' => [ + 'description' => 'The IDs of the creators.'."\n" + .'<br>1) If this parameter is not specified, the search scope depends on the user\'s role:'."\n" + .'<br> - A drive administrator or super administrator can search for shares from all members.'."\n" + .'<br> - A team administrator can search for shares from team members.'."\n" + .'<br> - A regular user can only search for their own shares.<br><br><br><br>'."\n" + ."\n" + .'2\\) You can only specify user IDs that are within your role\'s search scope, as described in point 1).', + 'type' => 'array', + 'items' => ['description' => 'The ID of a creator.', 'type' => 'string', 'required' => false, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'query' => ['description' => 'The query conditions.'."\n" + .'<br>1) Supported fields:'."\n" + .'<br> 1.1 `created_at`: The creation time.'."\n" + .'<br> 1.2 `updated_at`: The update time.'."\n" + .'<br> 1.3 `share_name_for_fuzzy`: The share name. Fuzzy search (`match`) is supported.'."\n" + .'<br> 1.4 `status`: The share status. Valid values: `enabled` (active) or `disabled` (canceled).'."\n" + .'<br> 1.5 `expired_time`: The expiration time.'."\n" + .'<br> To search for shares that never expire, set `expired_time=\'1970-01-01T00:00:00\'`. For these shares, the `expiration` field in the response is an empty string.'."\n" + .'<br> The time range `expired_time<\'1970-01-02T00:00:00\'` is reserved for system use and does not represent a valid expiration time.<br><br><br><br><br><br><br><br>', '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\'', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15498,96 +9091,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'status' => [ - 'description' => 'The state of the task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* running'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' : The task is'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' running'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* failed'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' : The task'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' fails'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n" - ."\n" - .'* succeeded'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' : The task is'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' successful'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'running' => '', - 'failed' => '', - 'succeeded' => '', - ], - 'example' => 'running', - 'enum' => [ - 'running', - 'succeeded', - 'failed', - ], + 'items' => [ + 'description' => 'The share list.', + 'type' => 'array', + 'items' => ['description' => 'A share.', '$ref' => '#/components/schemas/ShareLink', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The next marker.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'total_count' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'SearchShareLink', + 'summary' => 'Searches for shares.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"running\\"\\n}","type":"json"}]', - 'title' => 'GetTaskStatus', - 'description' => '**Before you call this operation, make sure that you are familiar with the [billing](~~425220~~) of Drive and Photo Service**.'."\n" - ."\n" - .'To call this operation, make sure that the value-added image processing feature is enabled.'."\n" - ."\n" - .'Before you call this operation, a value-added asynchronous task must be created. For example, you can call the CreateSimilarImageClusterTask operation to create an asynchronous task. Then, you can call this operation to query the execution status of the asynchronous task based on the task ID.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"share_pwd\\": \\"abcF123x\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id_list\\": [\\n \\"[\\\\\\"xx\\\\\\"]\\"\\n ],\\n \\"expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"expired\\": false,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"videos\\",\\n \\"share_name\\": \\"video-1.MP4\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"status\\": \\"enabled\\",\\n \\"preview_count\\": 10,\\n \\"save_count\\": 2,\\n \\"download_count\\": 5,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 1,\\n \\"access_count\\": 4,\\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 \\"share_all_files\\": true,\\n \\"save_download_limit\\": 100,\\n \\"office_editable\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"total_count\\": 101\\n}","type":"json"}]', ], 'SearchSimilarImageClusters' => [ - 'summary' => '获取相似图片聚类结果', 'path' => '/v2/image/query_similar_image_clusters', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -15596,82 +9129,43 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'marker' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'YWRzX3VzZXJfcHJvZmlsZV9je1bnQh***', - ], - 'limit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '50', - 'default' => '50', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. To retrieve the next page of results, set this parameter to the `next_marker` value from the previous response. If you leave this parameter empty, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'YWRzX3VzZXJfcHJvZmlsZV9je1bnQh***', 'title' => ''], + 'limit' => ['description' => 'The maximum number of results to return. Valid values: 1 to 100. Default value: 50. The number of results returned may be less than the specified limit.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '0', 'example' => '50', 'default' => '50', 'required' => false, 'title' => ''], 'order' => [ - 'description' => '', + 'description' => 'The sort order.', + 'enumValueTitles' => ['asc' => 'ascending', 'desc' => 'descending'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', - ], 'example' => 'desc', 'default' => 'desc', - 'enum' => [ - 'desc', - 'asc', - ], - ], - 'image_thumbnail_process' => [ - 'description' => '', - 'type' => 'string', - 'deprecated' => true, + 'enum' => ['desc', 'asc'], 'required' => false, - 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + 'title' => '', ], + 'image_thumbnail_process' => ['description' => 'The image thumbnail processing style.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15679,54 +9173,63 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'similar_image_clusters' => [ - 'description' => '', + 'description' => 'A list of similar image clusters.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The details of a similar image cluster.', 'type' => 'object', 'properties' => [ 'files' => [ - 'description' => '', + 'description' => 'A list of similar images in the cluster.', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/File', - ], + 'items' => ['description' => 'The file details.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'next_marker' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***', - ], + 'next_marker' => ['description' => 'A pagination marker. If the response does not include all results, the service returns this marker. Use this marker in a subsequent request to retrieve the next page of results.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Similar Image Clustering Results', + 'summary' => 'Retrieves similar image clusters in a specified drive.', + 'description' => '**Before you use this API, make sure that you understand the billing methods and [pricing](~~425220~~) of PDS.**'."\n" + ."\n" + .'To use this feature, you must enable the image processing value-added service.'."\n" + ."\n" + .'To query for similar image cluster results, you must first call the CreateSimilarImageClusterTask API to create a clustering task and obtain its task\\_id. Then, call the GetTaskStatus API to confirm that the task has succeeded. You can then call the SearchSimilarImageClusters API to retrieve the results.'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'\\- If you call this API before a clustering task has run, the API returns an empty list.'."\n" + .'\\- Similar image clustering tasks update clustering results incrementally. If the current clustering task is not yet complete, the API returns the results from the last successful task.'."\n" + ."\n" + .'></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'SearchSimilarImageClusters', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"similar_image_clusters\\": [\\n {\\n \\"files\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ]\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***\\"\\n}","type":"json"}]', ], - 'GetAsyncTask' => [ - 'summary' => 'Queries the information about an asynchronous task.', - 'path' => '/v2/async_task/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], + 'SearchStories' => [ + 'summary' => 'Retrieves stories from a specified drive that match the specified conditions.', + 'path' => '/v2/image/find_stories', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -15735,42 +9238,99 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'async_task_id' => [ - 'description' => 'The ID of the asynchronous task.'."\n", + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'required' => false, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'story_type' => ['description' => 'The type of the story. You can specify this parameter when you create a story.', 'type' => 'string', 'required' => false, 'example' => 'PeopleMemory', 'title' => ''], + 'story_name' => ['description' => 'The name of the story. The name can be up to 1,024 bytes in length.', 'type' => 'string', 'example' => 'Food', 'required' => false, 'title' => ''], + 'story_start_time_range' => [ + 'description' => 'The time range of the start time of the photos or videos in a story.', + 'type' => 'object', + 'properties' => [ + 'start' => ['description' => 'The start time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2016-12-31T00:00:00+08:00', 'title' => ''], + 'end' => ['description' => 'The end time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2022-12-31T00:00:00+08:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'story_end_time_range' => [ + 'description' => 'The time range of the end time of the photos or videos in a story.', + 'type' => 'object', + 'properties' => [ + 'start' => ['description' => 'The start time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2016-12-31T00:00:00+08:00', 'title' => ''], + 'end' => ['description' => 'The end time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2022-12-31T00:00:00+08:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'create_time_range' => [ + 'description' => 'The time range when the story was created.', + 'type' => 'object', + 'properties' => [ + 'start' => ['description' => 'The start time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2016-12-31T00:00:00+08:00', 'title' => ''], + 'end' => ['description' => 'The end time in RFC 3339 format.', 'type' => 'string', 'required' => false, 'example' => '2022-12-31T00:00:00+08:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'face_group_ids' => [ + 'description' => 'The list of face groups. This parameter is used to query people stories.', + 'type' => 'array', + 'items' => ['description' => 'The face group ID.', 'type' => 'string', 'required' => false, 'example' => 'Cluster-be377f73-3502-433c-8309-a01e659c128c', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'custom_labels' => ['description' => 'Custom labels. You can query multiple fields separated by commas (,).', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'key1=value1,key2!=value2', 'title' => ''], + 'with_empty_stories' => ['description' => 'Specifies whether to return empty stories. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'marker' => ['description' => 'The pagination marker. If this parameter is empty, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDODBhNDQ2Nzhl***', 'title' => ''], + 'limit' => ['description' => 'The maximum number of resources to return. Valid values: 1 to 100. Default value: 100. The number of returned resources can be less than the specified number, but cannot be greater than the specified number.', 'type' => 'integer', 'format' => 'int64', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''], + 'sort' => [ + 'description' => 'The sort field.', + 'enumValueTitles' => ['StoryName' => 'Sorts the results by story name.', 'StoryEndTime' => 'Sorts the results by story end time.', 'CreateTime' => 'Sorts the results by story creation time.', 'StoryStartTime' => 'Sorts the results by story start time.'], 'type' => 'string', - 'required' => true, - 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + 'enum' => ['CreateTime', 'StoryName', 'StoryStartTime', 'StoryEndTime'], + 'required' => false, + 'example' => 'CreateTime', + 'title' => '', + ], + 'order' => [ + 'description' => 'The sort order.', + 'enumValueTitles' => ['asc' => 'Ascending order.', 'desc' => 'Descending order.'], + 'type' => 'string', + 'enum' => ['asc', 'desc'], + 'required' => false, + 'example' => 'desc', + 'title' => '', ], + 'cover_image_thumbnail_process' => ['description' => 'The parameters for processing the thumbnail of the cover image.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', 'title' => ''], + 'cover_video_thumbnail_process' => ['description' => 'The parameters for processing the thumbnail of the cover video.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'video/snapshot,t_1000,f_jpg,w_0,h_0,m_fast,ar_auto', 'title' => ''], + 'url_expire_sec' => ['description' => 'The validity period of the thumbnail URL. Unit: seconds. Valid values: 10 to 86400.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'maximum' => '86400', 'minimum' => '10', 'default' => '900', 'required' => false, 'example' => '900', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15778,207 +9338,105 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The API response body.', 'type' => 'object', 'properties' => [ - 'async_task_id' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', - ], - 'status' => [ - 'description' => '<warning>This parameter is no longer used. We recommend that you use state instead.</warning>'."\n" - ."\n" - .'The state of the task. Valid values:'."\n" - ."\n" - .'* Failed'."\n" - .'* Running'."\n" - .'* PartialSucceed'."\n" - .'* Succeed', - 'type' => 'string', - 'enumValueTitles' => [ - 'Failed' => '', - 'Running' => '', - 'PartialSucceed' => '', - 'Succeed' => '', - ], - 'example' => 'Succeed', - ], - 'state' => [ - 'description' => 'The state of the task. Valid values:'."\n" - ."\n" - .'* Failed'."\n" - .'* Running'."\n" - .'* PartialSucceed'."\n" - .'* Succeed'."\n", - 'type' => 'string', - 'example' => 'Succeed', - ], - 'message' => [ - 'description' => '<warning>This parameter is no longer used. We recommend that you use error_message instead.</warning>'."\n" - ."\n" - .'The error message returned if the asynchronous task failed.', - 'type' => 'string', - 'example' => 'The request has been failed due to some unknown error. Please try again later.', - ], - 'err_code' => [ - 'description' => '<warning>This parameter is no longer used. We recommend that you use error_code instead.</warning>'."\n" - ."\n" - .'The error code returned if the asynchronous task failed.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'InternalError', - ], - 'total_process' => [ - 'description' => 'The total amount of work to be done in the asynchronous task, such as the number of files to be packaged for package download on the server.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'consumed_process' => [ - 'description' => 'The total amount of work that is done in the asynchronous task, such as the number of files that are packaged for package download on the server.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'url' => [ - 'description' => 'The download URL of the data generated by the asynchronous task, such as the download URL of the packaged files generated by the task of package download on the server.'."\n", - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], - 'error_code' => [ - 'description' => 'The error code returned if the asynchronous task failed.'."\n", - 'type' => 'string', - 'example' => 'InternalError', - ], - 'error_message' => [ - 'description' => 'The error message returned if the asynchronous task failed.'."\n", - 'type' => 'string', - 'example' => 'The request has been failed due to some unknown error. Please try again later.', - ], - 'uncompress_file_list' => [ - 'description' => 'The extracted files.'."\n", + 'items' => [ + 'description' => 'A list of `Story` objects.', 'type' => 'array', - 'items' => [ - 'description' => 'The extracted file.'."\n", - '$ref' => '#/components/schemas/UncompressedFileInfo', - ], - ], - 'category' => [ - 'description' => 'The custom category of the task.'."\n", - 'type' => 'string', - 'example' => 'album', - ], - 'created_at' => [ - 'description' => 'The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2019-03-28T13:03:29.298Z.'."\n", - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'started_at' => [ - 'description' => 'The time when the task was started. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2019-03-28T13:03:29.298Z.'."\n", - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'finished_at' => [ - 'description' => 'The time when the task was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2019-03-28T13:03:29.298Z.'."\n", - 'type' => 'string', - 'example' => '2019-08-20T06:51:27.292Z', - ], - 'skipped_process' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'failed_process' => [ - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['description' => 'Details for a single `Story` object.', '$ref' => '#/components/schemas/Story', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'next_marker' => ['description' => 'The token to retrieve the next page of results. This field is null or omitted if no more results are available.', 'type' => 'string', 'example' => 'Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'GetAsyncTask', - ], - 'GetVideoPreviewPlayMeta' => [ - 'summary' => 'Queries the preview metadata of a video.', - 'path' => '/v2/file/get_video_preview_play_meta', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\",\\n \\"story_type\\": \\"PeopleMemory\\",\\n \\"story_sub_type\\": \\"Solo\\",\\n \\"story_name\\": \\"test_name\\",\\n \\"story_start_time\\": \\"2021-01-14T10:17:18.102700407+08:00\\",\\n \\"story_end_time\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"created_at\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"updated_at\\": \\"2022-01-14T10:17:18.102700407+08:00\\",\\n \\"face_group_ids\\": [\\n \\"Cluster-be377f73-3502-433c-8309-a01e659c128c\\"\\n ],\\n \\"cover_file_id\\": \\"63e5e4340f76cb3ead5f40f68163f0f967c1a7bf\\",\\n \\"cover_file_thumbnail_url\\": \\"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\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n }\\n ],\\n \\"custom_id\\": \\"test\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key\\\\\\": \\\\\\"value\\\\\\"\\\\n}\\"\\n }\\n }\\n ],\\n \\"next_marker\\": \\"Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***\\"\\n}","type":"json"}]', + 'title' => '[parameters_body_schema_properties_url_expire_sec_type]integer ', + 'description' => '**Before using this operation, ensure you understand PDS billing and its [pricing](~~425220~~).**'."\n" + ."\n" + .'To use this feature, you must enable the image processing value-added service.'."\n" + ."\n" + .'Before you retrieve a list of stories, you must call the CreateStory or CreateCustomizedStory operation. Otherwise, an empty list is returned.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'SearchUser' => [ + 'path' => '/v2/user/search', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'AK' => [], + 'BearerToken' => [], ], [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID. If you want to manage a file by using a sharing link, carry the `x-share-token` header in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify at least either `share_id` or `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", + 'nick_name' => ['description' => 'The user\'s nickname. The maximum length is 128 characters.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'required' => false, 'example' => 'pdsuer', 'title' => ''], + 'nick_name_for_fuzzy' => ['description' => 'A keyword for a fuzzy search of nicknames. The maximum length is 128 characters.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'required' => false, 'example' => 'la', 'title' => ''], + 'user_name' => ['description' => 'The user\'s name. The maximum length is 128 characters.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'required' => false, 'example' => 'pds', 'title' => ''], + 'phone' => ['description' => 'The user\'s phone number.', 'type' => 'string', 'required' => false, 'example' => '13900001111', 'title' => ''], + 'email' => ['description' => 'The user\'s email address.', 'type' => 'string', 'required' => false, 'example' => '123@pds.com', 'title' => ''], + 'status' => [ + 'description' => 'The status of the user.'."\n" + ."\n" + .'- `disabled`: The user is disabled.'."\n" + ."\n" + .'- `enabled`: The user is enabled.', + 'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'], 'type' => 'string', 'required' => false, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', + 'example' => 'enabled', + 'title' => '', ], - 'category' => [ - 'description' => 'The preview type. You must enable the corresponding video transcoding feature. Valid values:'."\n" + 'role' => [ + 'description' => 'The role of the user. Valid values:'."\n" + ."\n" + .'- `superadmin`: super administrator'."\n" ."\n" - .'* live_transcoding: previews a live stream while transcoding is in progress.'."\n" - .'* quick_video: previews a video while transcoding is in progress.'."\n" - .'* offline_audio: previews a piece of audio after the audio is transcoded offline.'."\n" - .'* offline_video: previews a video after the video is transcoded offline.'."\n", + .'- `admin`: administrator'."\n" + ."\n" + .'- `user`: regular user', + 'enumValueTitles' => ['superadmin' => 'super administrator', 'admin' => 'administrator', 'user' => 'user'], 'type' => 'string', - 'required' => true, - 'example' => 'live_transcoding', + 'required' => false, + 'example' => 'user', + 'title' => '', ], + 'marker' => ['description' => 'The pagination marker. Results are returned in alphabetical order, starting from the entry that follows the marker. If this parameter is not specified, the query starts from the beginning of the list.<br>Default value: None<br>', 'type' => 'string', 'required' => false, 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', 'title' => ''], + 'limit' => ['description' => 'The maximum number of users to return per page. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -15986,152 +9444,165 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'title' => 'Id of the request', - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'share_id' => [ - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'fileid1', - ], - 'video_preview_play_meta' => [ - 'description' => 'The preview metadata of the video.'."\n", - '$ref' => '#/components/schemas/VideoPreviewPlayMeta', + 'next_marker' => ['title' => 'Id of the request', 'description' => 'The token to retrieve the next page of results. This parameter is empty when there are no more results to return.', 'type' => 'string', 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg'], + 'items' => [ + 'description' => 'A list of users.', + 'type' => 'array', + 'items' => ['description' => 'The user information.', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'GetVideoPreviewPlayMeta', - 'description' => 'For more information about best practices, see [Preview videos online](~~427477~~).'."\n", + 'title' => 'SearchUser', + 'summary' => 'Searches for users.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], - 'GetVideoPreviewPlayInfo' => [ - 'summary' => 'Queries the information about video playback.', - 'path' => '/v2/file/get_video_preview_play_info', - 'methods' => [ - 'post', + 'Token' => [ + 'summary' => 'Obtains an access token as part of the OAuth 2.0 authorization flow.', + '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, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'grant_type', + 'in' => 'formData', + 'schema' => ['description' => 'The grant type. Valid values:'."\n" + ."\n" + .'`authorization_code`: Exchanges an authorization code, returned after successful authentication, for an access token.'."\n" + ."\n" + .'`refresh_token`: Uses a refresh token from a previous authorization to obtain a new access token.'."\n" + ."\n" + .'`urn:ietf:params:oauth:grant-type:jwt-bearer`: Obtains an access token by using a JWT.', 'type' => 'string', 'required' => true, 'example' => 'refresh_token', 'title' => ''], + ], + [ + 'name' => 'code', + 'in' => 'formData', + 'schema' => ['description' => 'The authorization code returned in the redirect URI after successful authentication. This parameter is required when `grant_type` is `authorization_code`.', 'type' => 'string', 'required' => false, 'example' => '0045157fa8e24f4f9a0d9e3ff158c1e0', 'title' => ''], + ], + [ + 'name' => 'redirect_uri', + 'in' => 'formData', + 'schema' => ['description' => 'The redirect URI used in the authorization request. This parameter is required when `grant_type` is `authorization_code`.', 'type' => 'string', 'required' => false, 'example' => 'https://aliyun.com/pds'."\n", 'title' => ''], + ], + [ + 'name' => 'client_id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the app you create in the Alibaba Cloud PDS console.', 'type' => 'string', 'required' => true, 'example' => '1Zu***flH', 'title' => ''], + ], + [ + 'name' => 'client_secret', + 'in' => 'formData', + 'schema' => ['description' => 'The secret of the app you create in the Alibaba Cloud PDS console. This parameter is required for WebServer applications.', 'type' => 'string', 'required' => false, 'example' => '80D***3i5'."\n", 'title' => ''], + ], + [ + 'name' => 'refresh_token', + 'in' => 'formData', + 'schema' => ['description' => 'The token used to refresh an access token. This parameter is required when `grant_type` is `refresh_token`.', 'type' => 'string', 'required' => false, 'example' => '399623e13353490391266c7d48a13ed1', 'title' => ''], + ], + [ + 'name' => 'assertion', + 'in' => 'formData', + 'schema' => ['description' => 'A JWT-signed string that contains user information and authorization parameters to be granted. For the structure, see JWTPayload. This parameter is required when `grant_type` is `urn:ietf:params:oauth:grant-type:jwt-bearer`.', 'type' => 'string', 'required' => false, 'example' => 'ey***asd'."\n", 'title' => ''], + ], ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => ['description' => 'Contains details about the access token.', '$ref' => '#/components/schemas/Token', 'title' => '', 'example' => ''], + ], ], - 'tags' => [ - 'api', + 'title' => 'Token', + 'description' => '<props="china">'."\n" + ."\n" + .'For more information, see the [user guide](https://help.aliyun.com/document_detail/175894.html).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'For details on JWT-based logon, see [JWT-based logon](https://help.aliyun.com/document_detail/175893.html).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'For more information, see the [user guide](https://www.alibabacloud.com/help/zh/pds/latest/oauth2-for-web-server-app?spm=a2c63.p38356.0.0.267148fbJdRB0P).'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'For details on JWT-based logon, see [JWT-based logon](https://www.alibabacloud.com/help/zh/pds/latest/jwt-application?spm=a2c63.p38356.0.0.45ab5f06NnPJqj).'."\n" + ."\n" + .'</props>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'TrashFile' => [ + 'path' => '/v2/recyclebin/trash', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], [ - 'AK' => [], + 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'share_id' => [ - 'description' => 'The share ID. If you want to share a file, carry the `x-share-token` header for authentication in the request and specify share_id. In this case, `drive_id` is invalid. Otherwise, use an `AccessKey pair` or `access token` for authentication and specify `drive_id`. You must specify one of `share_id` and `drive_id`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - 'category' => [ - 'description' => 'The category. It is the transcoding mode that you want to use. Valid values:'."\n" - ."\n" - .'* live_transcoding: plays a live stream while transcoding is in progress.'."\n" - .'* quick_video: plays a video while transcoding is in progress.'."\n" - .'* offline_audio: plays a piece of audio after the audio is transcoded offline.'."\n" - .'* offline_video: plays a video after the video is transcoded offline.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'live_transcoding', - ], - 'template_id' => [ - 'description' => 'The ID of the definition template. If you leave this parameter empty, all definition templates are available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '264_480p', - ], - 'get_without_url' => [ - 'description' => 'Specifies whether not to query the playback URL. If you set this parameter to true, only transcoding metadata is returned. The video is not transcoded in the TS format, and the playback URL is not returned. If you set this parameter to false, the playback URL is returned. If the video has not been transcoded by using the template specified by template_id, the transcoding process is triggered. You are charged value-added service fees generated for transcoding.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'url_expire_sec' => [ - 'description' => 'The validity period of the URL. Unit: seconds. Default value: 900, which is 15 minutes. Maximum value: 14400, which is 4 hours.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], - 're_transcode' => [ - 'description' => 'Specifies whether to initiate re-transcoding. If you set this parameter to true, the file is re-transcoded, with a fixed 202 response for retries. Before you use this parameter, contact us to enable it for you.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'get_master_url' => [ - 'description' => 'Specifies whether to obtain the URL of the master M3U8 playlist. This parameter is valid only if the category parameter is set to quick_video.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file or folder ID.', 'type' => 'string', 'required' => true, 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -16139,66 +9610,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'domain_id' => [ - 'description' => 'The domain ID.'."\n", - 'type' => 'string', - 'example' => 'bj1', - ], - 'share_id' => [ - 'title' => 'Id of the request', - 'description' => 'The share ID.'."\n", - 'type' => 'string', - 'example' => '7JQX1FswpQ8', - ], - 'drive_id' => [ - 'description' => 'The drive ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'file_id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'fileid1', - ], - 'video_preview_play_info' => [ - 'description' => 'The information about video playback.'."\n", - '$ref' => '#/components/schemas/VideoPreviewPlayInfo', - ], + 'domain_id' => ['title' => 'Id of the request', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'bj1'], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file or folder ID.', 'type' => 'string', 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', 'title' => ''], + 'async_task_id' => ['description' => 'The asynchronous task ID.'."\n" + ."\n" + .'An empty string indicates that the operation completed synchronously.'."\n" + ."\n" + .'A non-empty string indicates that the operation is asynchronous. Call the GetAsyncTask operation with this ID to query the task status.', 'type' => 'string', 'example' => '13ebd3a24dba4166b1527add676ef2866051b4d5dele16', 'title' => ''], ], + 'example' => '', ], ], + 204 => [], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'TrashFile', + 'summary' => 'Moves a file or folder to the trash.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'GetVideoPreviewPlayInfo', - 'description' => '* **Before you call this operation, make sure that you fully understand the billing methods and [pricing](~~425220~~) of Drive and Photo Service (PDS).**'."\n" - .'* Before you call this operation, make sure that the transcoding mode which you want to specify by using the category parameter is enabled for the domain. To enable the transcoding feature and configure transcoding templates, contact our technical support. For more information, see [Contact us](~~175917~~).'."\n" - .'* This operation is a synchronous operation. If the specified file is not transcoded in the specified transcoding mode, the API call returns **202 VideoPreviewWaitAndRetry**, which indicates that you need to wait a moment and try again. If the specified file cannot be transcoded in the specified transcoding mode, the API call returns **404 NotFound.VideoPreviewInfo**.'."\n" - .'* This operation generates transcoding data and stores it in the space that is used to store the value-added data of the tenant domain. This way, end users can play audio and videos online. For specific transcoding modes, this operation provides domain-level deduplication for transcoding.'."\n" - .'* If the transcoding mode is set to quick_video, the playback URL returned by this operation contains the `{` and `}` characters that are not URL-encoded. For development on iOS, decode and encode the returned URL first to avoid decoding failure of the NSURL library of the system.'."\n" - .'* If the transcoding mode is set to quick_video, you cannot use the GET Range method to obtain segments of the M3U8 file in the playback URL.'."\n" - ."\n" - .'> '."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d317406\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', ], - 'CreateIdentityToBenefitPkgMapping' => [ - 'summary' => 'Creates a mapping between an entity and a benefit package. You can call this operation to associate a benefit package with a user.', - 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/create', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'api', - ], + 'UnLinkAccount' => [ + 'path' => '/v2/account/unlink', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -16207,99 +9648,125 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'description' => 'The type of the entity.'."\n" - ."\n" - .'If you want to manage the benefits of a user, set this parameter to user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - ], - ], - 'identity_id' => [ - 'description' => 'The unique identifier of the entity.'."\n" - ."\n" - .'If you want to manage the benefits of a user, set this parameter to a user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user123', - ], - 'benefit_pkg_id' => [ - 'description' => 'The unique identifier of the benefit package.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40cb7794c9294', - ], - 'amount' => [ - 'description' => 'The number of benefit packages.'."\n" - ."\n" - .'This parameter takes effect only for the benefit packages of the resource type. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'expire_time' => [ - 'description' => 'The time when the benefit package expires. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'By default, the benefit package never expires.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1633167071000', - ], + 'user_id' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'uid1', 'title' => ''], + 'type' => ['description' => 'The account type. Valid values:'."\n" + ."\n" + .'`mobile`: Mobile number'."\n" + ."\n" + .'`email`: Email address'."\n" + ."\n" + .'`ding`: DingTalk account'."\n" + ."\n" + .'`ram`: Alibaba Cloud RAM sub-account'."\n" + ."\n" + .'`wechat`: WeCom account'."\n" + ."\n" + .'`ldap`: LDAP account'."\n" + ."\n" + .'`custom`: Custom account', 'type' => 'string', 'required' => true, 'example' => 'mobile', 'title' => ''], + 'identity' => ['description' => 'The account\'s unique identifier, such as a mobile number.', 'type' => 'string', 'required' => true, 'example' => '139****'."\n", 'title' => ''], + 'extra' => ['description' => 'Additional information about the identity. For `mobile` accounts, this parameter specifies the country code. The default value is `86` (mainland China).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [], + 204 => [], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Unlink Account', + 'summary' => 'Unlinks a specified identity from a user account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CreateIdentityToBenefitPkgMapping', - 'description' => 'If you need to manage a large number of users based on Drive and Photo Service, you can control the features and quotas that users can use based on the benefits to which they are entitled. For more information, join the DingTalk group (ID 23146118).'."\n", ], - 'UpdateIdentityToBenefitPkgMapping' => [ - 'summary' => 'Updates the mapping between an entity and a benefit package. You can call this operation to associate a benefit package with a user.', - 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/update', - 'methods' => [ - 'post', + 'UpdateDomain' => [ + 'summary' => 'Update domain information.', + 'path' => '/v2/domain/update', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['admin'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', - 'http', + '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' => 'The request parameters.', + 'type' => 'object', + 'properties' => [ + 'domain_id' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => 'bj1', 'title' => ''], + 'domain_name' => ['description' => 'The name of the domain.', 'type' => 'string', 'example' => 'Hello Enterprise Drive', 'required' => false, 'title' => ''], + 'description' => ['description' => 'The description of the domain.', 'type' => 'string', 'example' => 'Hello enterprise drive debug environment', 'required' => false, 'title' => ''], + 'init_drive_enable' => ['description' => 'Specifies whether to enable the default drive feature. A value of true specifies that all users are assigned a drive by default on the first logon. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'init_drive_size' => ['description' => 'The size of the default drive. Unit: bytes. You must specify init\\_drive\\_size if you set init\\_drive\\_enable to true. Default value: 0. A value of 0 specifies that the size of the default drive is 0 bytes and you cannot upload files to the drive. To initialize the default drive, set init\\_drive\\_size to 0. A value of -1 specifies that the size is unlimited.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1073741824', 'title' => ''], + 'user_count_quota' => ['description' => 'The maximum number of users that can be created in the domain.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + 'size_quota' => ['description' => 'The total storage quota for all drives in the domain. A value of 0 specifies that the quota is unlimited.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1099511627776', 'title' => ''], + 'published_app_access_strategy' => ['description' => 'The access policy of the application.', '$ref' => '#/components/schemas/AppAccessStrategy', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], - 'tags' => [ - 'api', + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The information about the updated domain.', '$ref' => '#/components/schemas/Domain', 'title' => '', 'example' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"bj1\\",\\n \\"domain_id\\": \\"bj2\\",\\n \\"domain_name\\": \\"pdsdomain\\",\\n \\"description\\": \\"my domain\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 1073741824,\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"size_quota\\": 1099511627776,\\n \\"size_quota_used\\": 1099511627776,\\n \\"user_count_quota\\": 50,\\n \\"status\\": 1,\\n \\"used_size\\": 1099511627776,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"deny\\",\\n \\"except_app_id_list\\": [\\n \\"8ovxCTRUDdbpVWBP\\"\\n ]\\n },\\n \\"sharable\\": false,\\n \\"data_hash_name\\": \\"sha1\\",\\n \\"store_redundancy_type\\": \\"LRS\\"\\n}","type":"json"}]', + 'title' => 'UpdateDomain', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'manual', + ], + 'UpdateDrive' => [ + 'summary' => 'Modifies drive information.', + 'path' => '/v2/drive/update', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -16308,96 +9775,66 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'description' => 'The type of the entity. If you call this operation to manage the benefits of a user, set this parameter to user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - ], - ], - 'identity_id' => [ - 'description' => 'The unique identifier of the entity.'."\n" + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'drive_name' => ['description' => 'The drive name. The name can be up to 128 characters long.', 'type' => 'string', 'example' => 'My personal space', 'maxLength' => 128, 'required' => false, 'title' => ''], + 'description' => ['description' => 'The description of the drive. The description can be up to 1,024 characters long.', 'type' => 'string', 'example' => 'VIP space', 'maxLength' => 1024, 'required' => false, 'title' => ''], + 'status' => [ + 'description' => 'The status of the drive. Valid values:'."\n" ."\n" - .'If you call this operation to manage the benefits of a user, set this parameter to the ID of the user.'."\n", + .'enabled: The drive is available for use.<br>disabled: The drive cannot be used.<br>', + 'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'], 'type' => 'string', - 'required' => true, - 'example' => 'user123', - ], - 'benefit_pkg_id' => [ - 'description' => 'The unique identifier of the benefit package.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40cb7794c9294', - ], - 'amount' => [ - 'description' => 'The number of benefit packages.'."\n" - ."\n" - .'This parameter specifies the number of benefit packages of the resource type. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'enum' => ['enabled', 'disabled'], 'required' => false, - 'example' => '1', - ], - 'expire_time' => [ - 'description' => 'The expiration time of the benefit package. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'By default, the benefit package never expires.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1633167071000', + 'example' => 'enabled', + 'title' => '', ], + 'total_size' => ['description' => 'The total size of the drive, in bytes. Set this value to -1 to have no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''], + 'owner' => ['description' => 'The owner of the drive. Note: To change the owner of a personal drive, you must use an access key (AK).', 'type' => 'string', 'required' => false, 'example' => 'user1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateIdentityToBenefitPkgMapping', - ], - 'GetIdentityToBenefitPkgMapping' => [ - 'summary' => 'Queries the mapping between an entity and a benefit package. You can call this operation to query the benefit package that is associated with a user.', - 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/get', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', + 200 => [ + 'schema' => ['description' => 'The updated Drive object.', '$ref' => '#/components/schemas/Drive', 'title' => '', 'example' => ''], + ], ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"drive_name\\": \\"drv1\\",\\n \\"description\\": \\"vipdrive\\",\\n \\"owner\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"owner_type\\": \\"user\\",\\n \\"drive_type\\": \\"normal\\",\\n \\"status\\": \\"enabled\\",\\n \\"used_size\\": 20480,\\n \\"total_size\\": 204800,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\"\\n}","type":"json"}]', + 'title' => 'UpdateDrive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'UpdateFacegroup' => [ + 'summary' => 'Updates the information for a specified face group.', + 'path' => '/v2/image/update_facegroup_info', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -16406,83 +9843,63 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'description' => 'The type of the entity. If you want to manage the benefits of a user, set this parameter to user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - ], - ], - 'identity_id' => [ - 'description' => 'The unique identifier of the entity.'."\n" - ."\n" - .'If you want to manage the benefits of a user, set this parameter to a user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user123', - ], - 'benefit_pkg_id' => [ - 'description' => 'The unique identifier of the benefit package.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '40cb7794c9294', - ], + 'drive_id' => ['description' => 'The ID of the drive.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'group_id' => ['description' => 'The ID of the face group. You can obtain this ID in the response from the list face groups operation.', 'type' => 'string', 'required' => true, 'example' => 'group-abc', 'title' => ''], + 'group_name' => ['description' => 'The name of the face group. The name can be up to 128 characters long.', 'type' => 'string', 'example' => 'Face of John', 'maxLength' => 128, 'minLength' => 1, 'required' => false, 'title' => ''], + 'group_cover_face_id' => ['description' => 'The ID of the group cover face. You can obtain this ID from the **ImageMediaMetadata** field in the response from the file/get, file/list, or file/search operations.', 'type' => 'string', 'required' => false, 'example' => 'face1', 'title' => ''], + 'remarks' => ['description' => 'Remarks about the face group. The remarks can be up to 128 characters long.', 'type' => 'string', 'example' => 'John Doe', 'maxLength' => 128, 'minLength' => 1, 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the benefit package that is associated with the entity.'."\n", - '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'drive_id' => ['title' => 'Id of the request', 'description' => 'The ID of the drive.', 'type' => 'string', 'example' => '1'], + 'group_id' => ['description' => 'The ID of the face group.', 'type' => 'string', 'example' => 'group-abc', 'title' => ''], + ], + 'example' => '', ], ], ], - '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' => 'GetIdentityToBenefitPkgMapping', - ], - 'ListIdentityToBenefitPkgMapping' => [ - 'summary' => 'Queries the mappings between entities and benefit packages. You can call this operation to query the benefit packages that are associated with a user.', - 'path' => '/v2/benefit/identity_to_benefit_pkg_mapping/list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"group_id\\": \\"group-abc\\"\\n}","type":"json"}]', + 'title' => 'UpdateFacegroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'UpdateFile' => [ + 'summary' => 'Updates the metadata of a file without modifying its content.', + 'path' => '/v2/file/update', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -16491,270 +9908,263 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'identity_type' => [ - 'description' => 'The type of the entity. If you call this operation to manage the benefits of a user, set this parameter to user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user', - 'enum' => [ - 'user', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'name' => ['description' => 'The name of the file. The value must be UTF-8 encoded and no longer than 1,024 bytes.', 'type' => 'string', 'maxLength' => 102, 'minLength' => 1, 'required' => false, 'example' => 'a.jpg', 'title' => ''], + 'description' => ['description' => 'The description of the file. Maximum length: 1,024 characters.', 'type' => 'string', 'maxLength' => 1024, 'required' => false, 'example' => 'VIP user', 'title' => ''], + 'labels' => [ + 'description' => 'The labels of the file. A maximum of 100 labels are allowed.', + 'type' => 'array', + 'items' => ['description' => 'A label. Maximum length: 128 characters.', 'type' => 'string', 'required' => false, 'example' => 'animal', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], - 'identity_id' => [ - 'description' => 'The unique identifier of the entity.'."\n" + 'check_name_mode' => [ + 'description' => 'The naming policy to apply when a file with the same name already exists. Valid values:'."\n" + ."\n" + .'`ignore`: Allow the duplicate file name.'."\n" + ."\n" + .'`auto_rename`: Automatically rename the file by appending a timestamp. Example: `xxx_20060102_150405`.'."\n" + ."\n" + .'`refuse`: Reject the request and return the details of the existing file.'."\n" ."\n" - .'If you call this operation to manage the benefits of a user, set this parameter to the ID of the user.'."\n", + .'Default value: `ignore`.', + 'enumValueTitles' => ['refuse' => 'refuse', 'auto_rename' => 'auto\\_rename', 'ignore' => 'ignore'], 'type' => 'string', - 'required' => true, - 'example' => 'user123', - ], - 'include_expired' => [ - 'description' => 'Specifies whether to return the benefit packages that expire. Default value: false.'."\n", - 'type' => 'boolean', + 'enum' => ['ignore', 'auto_rename', 'refuse'], 'required' => false, - 'example' => 'false', + 'example' => 'ignore', + 'title' => '', ], + 'local_modified_at' => ['description' => 'The modification time of the file on the local device. Specify a UTC timestamp in ISO 8601 format: `YYYY-MM-DDTHH:mm:ssZ`.', 'type' => 'string', 'required' => false, 'example' => '2019-08-20T06:51:27.292Z', 'title' => ''], + 'hidden' => ['description' => 'Specifies whether the file is hidden.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'starred' => ['description' => 'Specifies whether the file is starred.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => 'The information about the benefit packages that are associated with an entity.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about a benefit package that is associated with an entity.'."\n", - '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', - ], - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'The updated file metadata.', '$ref' => '#/components/schemas/File', 'title' => '', 'example' => ''], ], ], - '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' => 'ListIdentityToBenefitPkgMapping', - ], - 'InvestigateFile' => [ - 'summary' => '送审文件', - 'path' => '/v2/csi/investigate_file', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"5d79206586bb5dd69fb34c349282718146c55da7\\",\\n \\"name\\": \\"1.mov\\",\\n \\"type\\": \\"file\\",\\n \\"content_type\\": \\"application/json\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"image file\\",\\n \\"trashed_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"file_extension\\": \\"txt\\",\\n \\"hidden\\": false,\\n \\"size\\": 1024,\\n \\"starred\\": false,\\n \\"status\\": \\"available\\",\\n \\"labels\\": [\\n \\"[\\\\\\"label1:1\\\\\\", \\\\\\"label2:2\\\\\\"]\\"\\n ],\\n \\"upload_id\\": \\"C9DCFE5A82644AC7A02DB74C30C934A6\\",\\n \\"parent_file_id\\": \\"3d5b846942cf94fa72324c8a4bda34e81da635a\\",\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"category\\": \\"image\\",\\n \\"local_created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"local_modified_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"revision_id\\": \\"5d5b846942cf94fa72324c14a4bda34e81da635d\\",\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\\\\\"128X128\\\\\\": \\\\\\"https://url1\\\\\\", \\\\\\"800X800\\\\\\": \\\\\\"url2\\\\\\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1024,\\n \\"height\\": 1024,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"China\\\\n\\",\\n \\"province\\": \\"Zhejiang\\\\n\\",\\n \\"city\\": \\"Hangzhou\\\\n\\",\\n \\"district\\": \\"Binjiang District\\\\n\\",\\n \\"township\\": \\"Xixing Street\\\\n\\",\\n \\"address_line\\": \\"Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\\\\n\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"sport\\",\\n \\"name\\": \\"basketball\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"play basketball\\",\\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 \\"user_tags\\": {\\n \\"key\\": \\"\\\\\\"k1\\\\\\":\\\\\\"v1\\\\\\", \\\\\\"k2\\\\\\",\\\\\\"v2\\\\\\"\\"\\n },\\n \\"video_media_metadata\\": {\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\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 \\"id_path\\": \\"id1/id2\\",\\n \\"name_path\\": \\"root/f1/f2\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 1,\\n \\"file_count\\": 10\\n },\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"auto_delete_left_sec\\": 0\\n}","type":"json"}]', + 'title' => 'UpdateFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'UpdateGroup' => [ + 'summary' => 'Updates a specified group.', + 'path' => '/v2/group/update', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ + 'BearerToken' => [], + ], + [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_file_ids' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '9520943DC264', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'group_id' => ['description' => 'The ID of the group to update.', 'type' => 'string', 'required' => true, 'example' => '2e43ec8427dd45f19431b7504649a1b4', 'title' => ''], + 'group_name' => ['description' => 'The new name of the group.', 'type' => 'string', 'required' => false, 'example' => 'test group', 'title' => ''], + 'description' => ['description' => 'The new description of the group.', 'type' => 'string', 'required' => false, 'example' => 'test group description', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 202 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [], - ], + 200 => [ + 'schema' => ['description' => 'The updated group information.', '$ref' => '#/components/schemas/Group', 'title' => '', 'example' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'InvestigateFile', - ], - 'CsiGetFileInfo' => [ - 'summary' => '获取文件内容安全信息', - 'path' => '/v2/csi/get_file_info', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], - 'tags' => [ - 'api', + 'title' => 'UpdateGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"group_id\\": \\"b45c0c0c373c41ec9ebb5c85a025a08f\\",\\n \\"group_name\\": \\"test group\\",\\n \\"description\\": \\"created by system\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + ], + 'UpdateIdentityToBenefitPkgMapping' => [ + 'summary' => 'Updates the association between an identity and a benefit package. Use this operation to assign a benefit package to a user.', + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'description' => '', + 'identity_type' => [ + 'description' => 'The type of the identity. To manage user benefits, set this parameter to `user`.', 'type' => 'string', 'required' => true, - 'example' => '9520943DC264', - ], - 'url_expire_sec' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '14400', - 'minimum' => '10', - 'example' => '100', + 'enum' => ['user'], + 'example' => 'user', + 'title' => '', ], + 'identity_id' => ['description' => 'The unique ID of the identity.'."\n" + ."\n" + .'When managing user benefits, set this parameter to the user ID.', 'type' => 'string', 'required' => true, 'example' => 'user123', 'title' => ''], + 'benefit_pkg_id' => ['description' => 'The unique ID of the benefit package.', 'type' => 'string', 'required' => true, 'example' => '40cb7794c9294', 'title' => ''], + 'amount' => ['description' => 'The quantity of the benefit package.'."\n" + ."\n" + .'This parameter applies to resource-type benefit packages. It is optional and defaults to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'expire_time' => ['description' => 'The expiration time of the benefit package, in milliseconds since the Unix epoch (00:00:00 GMT on January 1, 1970).'."\n" + ."\n" + .'If omitted, the benefit package never expires.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1633167071000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 200 => [ + 200 => [], + ], + 'title' => 'UpdateIdentityToBenefitPkgMapping', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'UpdateRevision' => [ + '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' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', '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', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'example' => '9520943DC264', 'title' => ''], + 'revision_id' => ['description' => 'The revision ID.', 'type' => 'string', 'required' => true, 'example' => '40CB7794C929', 'title' => ''], + 'keep_forever' => ['description' => 'Specifies whether to keep the revision forever.'."\n" + ."\n" + .'If you omit this parameter, the current value remains unchanged.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'revision_description' => ['description' => 'The revision description, with a maximum length of 1,024 characters.'."\n" + ."\n" + .'If you omit this parameter, the current value remains unchanged.', 'type' => 'string', 'required' => false, 'example' => 'aaa', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - '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' => 'CsiGetFileInfo', - ], - 'Batch' => [ - 'summary' => 'Calls multiple operations at a time to improve call efficiency.', - 'path' => '/v2/batch', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The details of the updated revision.', '$ref' => '#/components/schemas/Revision', 'title' => '', 'example' => ''], + ], ], - 'tags' => [ - 'api', + 'title' => 'UpdateRevision', + 'summary' => 'Updates information for a revision. You can set a revision to be kept forever or add a description. A maximum of 50 revisions per file can be kept forever.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"9520943DC264\\",\\n \\"revision_id\\": \\"40CB7794C929\\",\\n \\"revision_name\\": \\"1.mov\\",\\n \\"revision_version\\": 1,\\n \\"size\\": 1024,\\n \\"file_extension\\": \\"mov\\",\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"keep_forever\\": false,\\n \\"revision_description\\": \\"aaa\\",\\n \\"is_latest_version\\": false,\\n \\"crc64_hash\\": \\"3574582125365864471\\",\\n \\"content_hash\\": \\"EA4942AA8761213890A5C386F88E6464D2C31CA3\\",\\n \\"content_hash_name\\": \\"sha1\\",\\n \\"thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\",\\n \\"download_url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateShareLink' => [ + 'summary' => 'Updates a share link.', + 'path' => '/v2/share_link/update', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'BearerToken' => [], @@ -16763,226 +10173,79 @@ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'resource' => [ - 'description' => 'The type of the resource that you want to manage. Valid values:'."\n" + 'share_id' => ['description' => 'The share ID.', 'type' => 'string', 'required' => true, 'example' => '7JQX1FswpQ8', 'title' => ''], + 'share_pwd' => ['description' => 'The share password. The password must be 0 to 64 characters long. An empty string ("") indicates no password is required.', 'type' => 'string', 'required' => false, 'example' => 'abcF123x', 'title' => ''], + 'expiration' => ['description' => 'The expiration time. The value must be in RFC 3339 format, for example, `2020-06-28T11:33:00.000+08:00`. An empty string ("") indicates that the share link never expires.', 'type' => 'string', 'required' => false, 'example' => '2020-06-28T11:33:00.000+08:00', 'title' => ''], + 'description' => ['description' => 'The description of the share link, which can be up to 1,024 characters long.', 'type' => 'string', 'example' => 'Complete lecture series', 'required' => false, 'title' => ''], + 'share_name' => ['description' => 'The share name. If not specified, the name of the first file is used by default. The name must be 0 to 128 characters long.', 'type' => 'string', 'example' => 'Lecture-1.mp4', 'required' => false, 'title' => ''], + 'status' => [ + 'description' => 'The status of the share link. Valid values:'."\n" ."\n" - .'* file: a file.'."\n" - .'* drive: an individual drive or a team drive.'."\n" - .'* user: a user.'."\n" - .'* group: a group.'."\n" - .'* membership: a group member.'."\n" - .'* share_link: a share.'."\n" - .'* async_task: an asynchronous task.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'share_link' => '', - 'file' => '', - 'async_task' => '', - 'membership' => '', - 'drive' => '', - 'user' => '', - 'group' => '', - ], - 'example' => 'file', - ], - 'requests' => [ - 'description' => 'The child requests.'."\n" + .'- `disabled`: The share is canceled.'."\n" ."\n" - .'The number of child requests. Valid value: 1 to 100.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => 'The ID of the child request. The ID is used to associate a child request with a response. The ID of a child request must be unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '93433894994ad2e1', - ], - 'method' => [ - 'description' => 'The method of a child request. Valid values:'."\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' => 'The API path of a child request. Valid values:'."\n" - ."\n" - .'* /file/get: queries the information about a file.'."\n" - .'* /file/update: modifies the information about a file.'."\n" - .'* /file/search: searches for a file.'."\n" - .'* /file/copy: copies a file or folder.'."\n" - .'* /file/move: moves a file or folder.'."\n" - .'* /file/delete: deletes a file or folder.'."\n" - .'* /file/get_download_url: queries the download URL of a file.'."\n" - .'* /file/get_share_link_download_url: queries the download URL of a file in a share.'."\n" - .'* /recyclebin/trash: moves a file or folder to the recycle bin.'."\n" - .'* /recyclebin/restore: restores a file or folder.'."\n" - .'* /file/put_usertags: adds tags to a user.'."\n" - .'* /file/delete_usertags: removes tags from a user.'."\n" - .'* /drive/get: queries the information about a drive.'."\n" - .'* /user/get: queries the information about a user.'."\n" - .'* /group/get: queries the information about a group.'."\n" - .'* /share_link/create: creates a share.'."\n" - .'* /share_link/update: modifies a share.'."\n" - .'* /share_link/cancel: cancels a share.'."\n" - .'* /share_link/list: queries shares.'."\n" - .'* /share_link/get: queries the information about a share.'."\n" - .'* /share_link/get_share_token: queries an access token of a share.'."\n" - .'* /async_task/get: queries the information about an asynchronous task.'."\n", - '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' => 'The request parameters of a child request. The parameter value must be a JSON string. For more information, see the topic of the corresponding child request.'."\n" - ."\n" - .'Before you specify the request body, you must specify a header by using Content-Type. Content-Type can only be set to application/json.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The request body of a child request.'."\n", - 'example' => '{"domain_id":"1","drive_id":"1"}', - ], - ], - 'headers' => [ - 'description' => 'The header of a child request, which indicates the type of the data specified in the request body.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The header of a child request.'."\n", - 'example' => '{"Content-Type":"application/json"}', - ], - ], - ], - 'required' => false, - ], - 'required' => true, + .'- `enabled`: The share is active.', + 'enumValueTitles' => ['disabled' => '', 'enabled' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + 'title' => '', ], + 'preview_count' => ['description' => 'The preview count. The value must be greater than or equal to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'save_count' => ['description' => 'The save count. The value must be greater than or equal to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'download_count' => ['description' => 'The download count. The value must be greater than or equal to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + 'report_count' => ['description' => 'The report count. The value must be greater than or equal to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'video_preview_count' => ['description' => 'The video preview count. The value must be greater than or equal to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'disable_preview' => ['description' => 'Whether to disable previews for the share.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'disable_save' => ['description' => 'Whether to prevent users from saving files from the share.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'disable_download' => ['description' => 'Whether to prevent users from downloading files from the share.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'preview_limit' => ['description' => 'The maximum number of times the shared content can be previewed. The value must be greater than or equal to 0. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'save_limit' => ['description' => 'The maximum number of times the shared content can be saved. The value must be greater than or equal to 0. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'download_limit' => ['description' => 'The maximum number of times the shared content can be downloaded. The value must be greater than or equal to 0. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'office_editable' => ['description' => 'Whether to allow online editing of the shared documents.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'responses' => [ - 'description' => 'All responses of the child requests.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => 'The ID of the child request. The ID is used to associate a child request with a response.'."\n", - 'type' => 'string', - 'example' => '93433894994ad2e1', - ], - 'status' => [ - 'description' => 'The returned HTTP status code of a child request. For more information, see the topic of the corresponding child request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'body' => [ - 'description' => 'The response parameters of a child request. For more information, see the topic of the corresponding child request.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The response body of a child request.'."\n", - 'example' => '{"domain_id":"1","drive_id":"1","file_id":"9520943DC264"}', - ], - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => 'Details of the updated share.', '$ref' => '#/components/schemas/ShareLink', 'title' => '', 'example' => ''], ], ], - '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' => 'Batch', - ], - 'AuditLogExport' => [ - 'summary' => 'Exports audit logs.', - 'path' => '/v2/audit_log/export', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"share_pwd\\": \\"abcF123x\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id_list\\": [\\n \\"[\\\\\\"xx\\\\\\"]\\"\\n ],\\n \\"expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"expired\\": false,\\n \\"created_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"updated_at\\": \\"2019-08-20T06:51:27.292Z\\",\\n \\"description\\": \\"videos\\",\\n \\"share_name\\": \\"video-1.MP4\\",\\n \\"creator\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"status\\": \\"enabled\\",\\n \\"preview_count\\": 10,\\n \\"save_count\\": 2,\\n \\"download_count\\": 5,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 1,\\n \\"access_count\\": 4,\\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 \\"share_all_files\\": true,\\n \\"save_download_limit\\": 100,\\n \\"office_editable\\": true\\n}","type":"json"}]', + 'title' => 'Modify a share ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'UpdateStory' => [ + 'summary' => 'Updates a specified story, including its name, tags, and cover.', + 'path' => '/v2/image/update_story', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], @@ -16991,72 +10254,52 @@ 'BearerToken' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', '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, - ], + 'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'query' => [ - 'description' => 'The fields used for query. You can specify one or more of the following fields:'."\n" - ."\n" - .'* drive_id (space ID, in the form of a string)'."\n" - .'* actor_id (operator ID, in the form of a string)'."\n" - .'* acted_at (operation time, in the yyyy-MM-ddTHH:mm:ssZ format in UTC, for example, 2006-01-02T00:00:00)'."\n" - .'* action_type (operation type, in the form of a string)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acted_at > \'2025-03-10T16:00:00\' and acted_at < \'2025-03-17T15:59:59\'', - ], - 'order_by' => [ - 'description' => 'The sort order based on the operation time. If you leave this parameter empty, the value acted_at DESC is used. Valid values:'."\n" - ."\n" - .'* acted_at DESC: sorts the entries by operation time in descending order'."\n" - .'* acted_at ASC: sorts the entries by operation time in ascending order'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acted_at DESC', - ], - 'file_name' => [ - 'description' => 'The name of the exported file. The name can be up to 1,024 characters in length. The default name suffix is log.csv.'."\n", - 'type' => 'string', + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'required' => true, 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], + 'story_name' => ['description' => 'The name of the story. The maximum length is 1,024 bytes.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + 'custom_labels' => [ + 'description' => 'The custom labels. You can specify up to 20 labels.', + 'type' => 'object', + 'deprecated' => true, 'required' => false, - 'example' => '2024-01-log.csv', + 'additionalProperties' => ['description' => 'The value of the custom label.', 'type' => 'string', 'example' => 'label_value', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'language' => [ - 'description' => 'The export language. Default value: zh-CN. Valid values:'."\n" - ."\n" - .'* zh-CN: Chinese'."\n" - .'* en_US: English'."\n", - 'type' => 'string', + 'cover' => [ + 'description' => 'The story cover.', + 'type' => 'object', + 'properties' => [ + 'file_id' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', 'title' => ''], + 'revision_id' => ['description' => 'The revision ID.', 'type' => 'string', 'required' => false, 'example' => '642a88dd06e49d9c0a14411ebae606f70edd9a59', 'title' => ''], + ], 'required' => false, - 'example' => 'zh_CN', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -17064,309 +10307,301 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'async_task_id' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the asynchronous task used to export audit logs.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43c255edc4463bf3a6f5f5d31****', - ], + 'drive_id' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'story_id' => ['description' => 'The story ID.', 'type' => 'string', 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Story', + 'description' => '**Before you call this operation, ensure you understand the billing methods and [pricing](~~425220~~) of PDS.**'."\n" + ."\n" + .'This feature requires the image processing value-added service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"async_task_id\\": \\"4221bf6e6ab43c255edc4463bf3a6f5f5d31****\\"\\n}","type":"json"}]', - 'title' => 'AuditLogExport', - 'description' => 'Log audit is a value-added feature that is provided by Drive and Photo Service (PDS) Developer Edition. Before you call this operation, make sure that you learn about the [value-added billable items](https://www.alibabacloud.com/help/document_detail/425220.html).', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', ], - 'GetDomainQuota' => [ - 'summary' => '获取domain限额', - 'path' => '/v2/domain/get_quota', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'admin', - ], + 'UpdateUser' => [ + 'summary' => 'Modifies user information.', + 'path' => '/v2/user/update', + 'methods' => ['post'], + 'schemes' => ['https'], + 'tags' => ['api'], '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' => null, - ], - 'GroupUpdateName' => [ - 'summary' => '更新用户组名字', - 'path' => '/v2/group/update_name', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'tags' => [ - 'api', - ], - 'security' => [ [ 'BearerToken' => [], ], - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'group_id' => [ + 'user_id' => ['description' => 'The user ID. The maximum length is 64 characters. The value cannot contain the `#` character.', 'type' => 'string', 'required' => true, 'maxLength' => 1024, 'minLength' => 1, 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', 'title' => ''], + 'nick_name' => ['description' => 'The nickname. The maximum length is 128 characters.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'required' => false, 'example' => 'pdsuer', 'title' => ''], + 'status' => [ + 'description' => 'The user status. Valid values:'."\n" + ."\n" + .'- `disabled`'."\n" + ."\n" + .'- `enabled`', + 'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'], 'type' => 'string', - 'required' => true, + 'enum' => ['enabled', 'disabled'], + 'required' => false, + 'example' => 'enabled', + 'title' => '', ], - 'name' => [ + 'role' => [ + 'description' => 'The role. Valid values:'."\n" + ."\n" + .'- `superadmin`: super administrator'."\n" + ."\n" + .'- `admin`: administrator'."\n" + ."\n" + .'- `user`: regular user', + 'enumValueTitles' => ['superadmin' => 'super administrator', 'admin' => 'administrator', 'user' => 'regular user'], 'type' => 'string', + 'enum' => ['user', 'admin', 'superadmin', 'subdomain_admin', 'subdomain_super_admin'], + 'required' => false, + 'example' => 'user', + 'title' => '', + ], + 'avatar' => ['description' => 'The URL of the avatar.'."\n" + ."\n" + .'HTTP URLs must start with `http://` or `https://` and be 4 KB or smaller.'."\n" + ."\n" + .'Data URLs must start with `data://`, be Base64-encoded, and be 300 KB or smaller.', 'type' => 'string', 'required' => false, 'example' => 'http://a.b.c/pds.jpg', 'title' => ''], + 'description' => ['description' => 'The description. The maximum length is 1,024 characters.', 'type' => 'string', 'example' => 'Vip user', 'maxLength' => 1024, 'minLength' => 0, 'required' => false, 'title' => ''], + 'phone' => ['description' => 'The mobile number.', 'type' => 'string', 'required' => false, 'example' => '13900001111', 'title' => ''], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'a@aliyunpds.com', 'title' => ''], + 'user_data' => [ + 'description' => 'The custom user data. The maximum length is 1,024 characters.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The value of a custom data field.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'group_info_list' => [ + 'description' => 'The group list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a group.', + 'type' => 'object', + 'properties' => [ + 'group_id' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'g123', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ - 'schema' => [ - '$ref' => '#/components/schemas/BaseGroupResponse', - ], + 200 => [ + 'schema' => ['description' => 'The user information.', '$ref' => '#/components/schemas/User', 'title' => '', 'example' => ''], ], ], - 'responseDemo' => null, - ], - 'PunishFile' => [ - 'summary' => 'Penalizes files.', - 'path' => '/v2/csi/business/punish_file', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'tags' => [ - 'api', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"c9b7a5aa04d14ae3867fdc886fa01da4\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"email\\": \\"a@aliyunpds.com\\",\\n \\"nick_name\\": \\"001\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"role\\": \\"user\\",\\n \\"status\\": \\"enabled\\",\\n \\"user_name\\": \\"pds\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"creator\\": \\"user1\\",\\n \\"last_login_time\\": 0,\\n \\"last_refresh_token_time\\": 0,\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateUser', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'translator' => 'machine', + ], + 'VideoDRMLicense' => [ + 'summary' => 'Acquires a DRM license for a video.', + 'path' => '/v2/file/video_drm_license', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'tags' => ['api'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'domain_id', 'in' => 'host', - 'schema' => [ - 'title' => '域id', - 'type' => 'string', - 'example' => 'bj2', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'drive_id' => [ - 'title' => '处罚的文件所属空间 ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'file_id' => [ - 'title' => '处罚的文件 ID', - 'description' => '', - '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' => '', + 'drmType' => [ + 'description' => 'The DRM type.', + 'enumValueTitles' => ['fairplay' => 'Apple\'s FairPlay DRM technology.', 'widevine' => 'Google\'s Widevine DRM technology.'], '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', + 'example' => 'widevine', + 'title' => '', ], + 'licenseRequest' => ['description' => 'The license request payload.', 'type' => 'string', 'required' => false, 'example' => 'CAES6B8SQgpACioSENGxDhqCLIVwwCBOyPayyWoSENGxDhqCLIVwwCBOyPayyWpI88aJmwYQARoQdRV32', 'title' => ''], ], 'required' => false, - 'title' => '请求体', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ - 204 => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', - 'properties' => [], + 'properties' => [ + 'data' => ['description' => 'The DRM license.', 'type' => 'string', 'example' => 'cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3', 'title' => ''], + 'states' => ['description' => 'The request status returned by the DRM server.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'device_info' => ['description' => 'Information about the device that made the license request.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'PunishFile', + 'title' => 'VideoDRMLicense', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"cb9swCy8P50H9KePsxET3jZ1tm41bDs9HTsxbWnsjf3bsf6QGdiS4kZPhDaskimbNyAfNjmhQRmWFt3AhwNF3\\",\\n \\"states\\": \\"0\\",\\n \\"device_info\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', ], ], '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', - ], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-zhangjiakou.admin.aliyunpds.com', 'endpoint' => 'cn-zhangjiakou.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shenzhen.admin.aliyunpds.com', 'endpoint' => 'cn-shenzhen.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shanghai.admin.aliyunpds.com', 'endpoint' => 'cn-shanghai.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hongkong.admin.aliyunpds.com', 'endpoint' => 'cn-hongkong.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hangzhou.admin.aliyunpds.com', 'endpoint' => 'cn-hangzhou.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-guangzhou.admin.aliyunpds.com', 'endpoint' => 'cn-guangzhou.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-beijing.admin.aliyunpds.com', 'endpoint' => 'cn-beijing.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-5.admin.aliyunpds.com', 'endpoint' => 'ap-southeast-5.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-1.admin.aliyunpds.com', 'endpoint' => 'ap-southeast-1.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-central-1.admin.aliyunpds.com', 'endpoint' => 'eu-central-1.admin.aliyunpds.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-west-1.admin.aliyunpds.com', 'endpoint' => 'us-west-1.admin.aliyunpds.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'AccessTokenInvalid', 'message' => 'AccessTokenInvalid', 'http_code' => 401, 'description' => ''], + ['code' => 'AccountInDebt', 'message' => 'AccountInDebt', 'http_code' => 403, 'description' => ''], + ['code' => 'AccountNotFound', 'message' => 'AccountNotFound', 'http_code' => 403, 'description' => ''], + ['code' => 'AKPolicyDenied', 'message' => 'AKPolicyDenied', 'http_code' => 403, 'description' => ''], + ['code' => 'BadArchive', 'message' => 'BadArchive', 'http_code' => 400, 'description' => ''], + ['code' => 'BenefitNotEnabled', 'message' => 'BenefitNotEnabled', 'http_code' => 400, 'description' => ''], + ['code' => 'ClearRecycleBinPartialSuccess', 'message' => 'ClearRecycleBinPartialSuccess', 'http_code' => 500, 'description' => ''], + ['code' => 'ConcurrencyUpdateConflict', 'message' => 'ConcurrencyUpdateConflict', 'http_code' => 409, 'description' => ''], + ['code' => 'CreateShareForbidden', 'message' => 'CreateShareForbidden', 'http_code' => 403, 'description' => ''], + ['code' => 'CrossAccountAccessForbidden', 'message' => 'CrossAccountAccessForbidden', 'http_code' => 403, 'description' => ''], + ['code' => 'CrossSubdomainAccessForbidden', 'message' => 'CrossSubdomainAccessForbidden', 'http_code' => 403, 'description' => ''], + ['code' => 'DriveTotalSizeLessThanUsedSize', 'message' => 'DriveTotalSizeLessThanUsedSize', 'http_code' => 400, 'description' => ''], + ['code' => 'DriveTotalSizeNeed', 'message' => 'DriveTotalSizeNeed', 'http_code' => 400, 'description' => ''], + ['code' => 'FileNotInRecycleBinCannotBeDelete', 'message' => 'FileNotInRecycleBinCannotBeDelete', 'http_code' => 400, 'description' => ''], + ['code' => 'Forbidden', 'message' => 'Forbidden', 'http_code' => 403, 'description' => ''], + ['code' => 'ForbiddenDriveLocked', 'message' => 'ForbiddenDriveLocked', 'http_code' => 403, 'description' => ''], + ['code' => 'ForbiddenFileInTheRecycleBin', 'message' => 'ForbiddenFileInTheRecycleBin', 'http_code' => 403, 'description' => ''], + ['code' => 'ForbiddenFileInTrashedFolder', 'message' => 'ForbiddenFileInTrashedFolder', 'http_code' => 403, 'description' => ''], + ['code' => 'ForbiddenFileLocked', 'message' => 'ForbiddenFileLocked', 'http_code' => 403, 'description' => ''], + ['code' => 'ForbiddenUpload', 'message' => 'ForbiddenUpload', 'http_code' => 403, 'description' => ''], + ['code' => 'InternalError', 'message' => 'InternalError', 'http_code' => 500, 'description' => 'An internal error occurred.'], + ['code' => 'InvalidAccountStatus', 'message' => 'InvalidAccountStatus', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFieldMissing', 'message' => 'InvalidFieldMissing', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFieldNotMatch', 'message' => 'InvalidFieldNotMatch', 'http_code' => 400, 'description' => 'Unmatched parameters.'], + ['code' => 'InvalidFieldNotSupported', 'message' => 'InvalidFieldNotSupported', 'http_code' => 400, 'description' => 'Unsupported request parameters.'], + ['code' => 'InvalidFieldOutOfRange', 'message' => 'InvalidFieldOutOfRange', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFieldWrongFormat', 'message' => 'InvalidFieldWrongFormat', 'http_code' => 400, 'description' => 'Invalid parameter format.'], + ['code' => 'InvalidFileStatus', 'message' => 'InvalidFileStatus', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidHeader', 'message' => 'InvalidHeader', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidJSONFormat', 'message' => 'InvalidJSONFormat', 'http_code' => 400, 'description' => 'Invalid JSON format.'], + ['code' => 'InvalidParameter', 'message' => 'InvalidParameter', 'http_code' => 400, 'description' => 'Invalid parameters.'], + ['code' => 'InvalidParameterEmpty', 'message' => 'InvalidParameterEmpty', 'http_code' => 400, 'description' => 'The parameter is required.'], + ['code' => 'InvalidPassword', 'message' => 'InvalidPassword', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRapidProof', 'message' => 'InvalidRapidProof', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResource', 'message' => 'InvalidResource', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResourceAlreadyExist', 'message' => 'InvalidResourceAlreadyExist', 'http_code' => 409, 'description' => ''], + ['code' => 'InvalidResourceNotEmpty', 'message' => 'InvalidResourceNotEmpty', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResourceNotFound', 'message' => 'InvalidResourceNotFound', 'http_code' => 404, 'description' => ''], + ['code' => 'InvalidResourceStatus', 'message' => 'InvalidResourceStatus', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResourceUnsupported', 'message' => 'InvalidResourceUnsupported', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserStatus', 'message' => 'InvalidUserStatus', 'http_code' => 400, 'description' => ''], + ['code' => 'LimitArchive', 'message' => 'LimitArchive', 'http_code' => 400, 'description' => ''], + ['code' => 'LoginDenied', 'message' => 'LoginDenied', 'http_code' => 403, 'description' => ''], + ['code' => 'NeedChangePassword', 'message' => 'NeedChangePassword', 'http_code' => 400, 'description' => ''], + ['code' => 'NoPermissionToAccess', 'message' => 'NoPermissionToAccess', 'http_code' => 403, 'description' => ''], + ['code' => 'NotFound.VideoPreviewInfo', 'message' => 'The resource video_preview_info cannot be found. $detail_info', 'http_code' => 404, 'description' => ''], + ['code' => 'NotSupportedFileType', 'message' => 'NotSupportedFileType', 'http_code' => 400, 'description' => ''], + ['code' => 'OfficeEditNotEnabled', 'message' => 'OfficeEditNotEnabled', 'http_code' => 400, 'description' => ''], + ['code' => 'OfficePreviewNotEnabled', 'message' => 'OfficePreviewNotEnabled', 'http_code' => 400, 'description' => ''], + ['code' => 'OperationDenied', 'message' => 'OperationDenied', 'http_code' => 400, 'description' => ''], + ['code' => 'OperationNotSupport', 'message' => 'OperationNotSupport', 'http_code' => 400, 'description' => ''], + ['code' => 'ParentPathMappingExist', 'message' => 'ParentPathMappingExist', 'http_code' => 400, 'description' => ''], + ['code' => 'PasswordTooSimple', 'message' => 'PasswordTooSimple', 'http_code' => 400, 'description' => ''], + ['code' => 'QuotaExceeded', 'message' => 'QuotaExceeded', 'http_code' => 400, 'description' => ''], + ['code' => 'RapidProofNeed', 'message' => 'RapidProofNeed', 'http_code' => 400, 'description' => ''], + ['code' => 'ResourceExpired', 'message' => 'ResourceExpired', 'http_code' => 403, 'description' => ''], + ['code' => 'ShareLinkCancelled', 'message' => 'ShareLinkCancelled', 'http_code' => 400, 'description' => ''], + ['code' => 'ShareLinkContentInvalid', 'message' => 'ShareLinkContentInvalid', 'http_code' => 400, 'description' => ''], + ['code' => 'ShareLinkExpired', 'message' => 'ShareLinkExpired', 'http_code' => 400, 'description' => ''], + ['code' => 'ShareLinkGlobalDisabled', 'message' => 'ShareLinkGlobalDisabled', 'http_code' => 400, 'description' => ''], + ['code' => 'ShareLinkTokenInvalid', 'message' => 'ShareLinkTokenInvalid', 'http_code' => 401, 'description' => ''], + ['code' => 'SignatureDoesNotMatch', 'message' => 'SignatureDoesNotMatch', 'http_code' => 403, 'description' => ''], + ['code' => 'StateConflict', 'message' => 'StateConflict', 'http_code' => 409, 'description' => ''], + ['code' => 'SubdomainNameExists', 'message' => 'SubdomainNameExists', 'http_code' => 400, 'description' => ''], + ['code' => 'SubPathMappingExist', 'message' => 'SubPathMappingExist', 'http_code' => 400, 'description' => ''], + ['code' => 'Timeout', 'message' => 'Timeout', 'http_code' => 408, 'description' => 'Timed out.'], + ['code' => 'TooManyRequests', 'message' => 'TooManyRequests', 'http_code' => 429, 'description' => ''], + ['code' => 'UserForbidShare', 'message' => 'UserForbidShare', 'http_code' => 401, 'description' => ''], + ['code' => 'UserNotVerified', 'message' => 'UserNotVerified', 'http_code' => 401, 'description' => ''], + ['code' => 'UserRightsForbidden', 'message' => 'UserRightsForbidden', 'http_code' => 403, 'description' => ''], + ['code' => 'VideoPreviewWaitAndRetry', 'message' => 'video is transcoding, please wait and retry. $detail_info', 'http_code' => 202, 'description' => ''], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], ]; |