diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/pds/2022-03-01/api-docs.php | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/pds/2022-03-01/api-docs.php')
| -rw-r--r-- | data/en_us/pds/2022-03-01/api-docs.php | 17372 |
1 files changed, 17372 insertions, 0 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 new file mode 100644 index 0000000..3f6be60 --- /dev/null +++ b/data/en_us/pds/2022-03-01/api-docs.php @@ -0,0 +1,17372 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'PDS', + 'product' => 'pds', + 'version' => '2022-03-01', + ], + 'directories' => [ + [ + 'id' => 181654, + 'title' => 'Domain Management', + 'type' => 'directory', + 'children' => [ + 'CreateDomain', + 'GetDomain', + 'UpdateDomain', + 'ListDomains', + 'SearchDomains', + 'DeleteDomain', + ], + ], + [ + 'id' => 165270, + 'title' => 'Authentication and Authorization', + 'type' => 'directory', + 'children' => [ + 'Authorize', + 'Token', + ], + ], + [ + 'id' => 163808, + 'title' => 'Account Management', + 'type' => 'directory', + 'children' => [ + 'GetLinkInfoByUserId', + 'LinkAccount', + 'GetLinkInfo', + 'UnLinkAccount', + ], + ], + [ + 'id' => 165207, + 'title' => 'Group Management', + 'type' => 'directory', + 'children' => [ + 'CreateGroup', + 'UpdateGroup', + 'GetGroup', + 'ListGroup', + 'DeleteGroup', + 'AddGroupMember', + 'RemoveGroupMember', + 'ListGroupMember', + ], + ], + [ + 'id' => 163812, + 'title' => 'User Management', + 'type' => 'directory', + 'children' => [ + 'CreateUser', + 'ImportUser', + 'UpdateUser', + 'GetUser', + 'ListUser', + 'SearchUser', + 'DeleteUser', + ], + ], + [ + 'id' => 163815, + 'title' => 'Space Management', + 'type' => 'directory', + 'children' => [ + 'CreateDrive', + 'UpdateDrive', + 'GetDrive', + 'ListDrive', + 'GetDefaultDrive', + 'ListMyDrives', + 'SearchDrive', + 'DeleteDrive', + ], + ], + [ + 'id' => 163817, + 'title' => 'File Management', + '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', + ], + ], + [ + 'id' => 164951, + 'title' => 'Permission Management', + 'type' => 'directory', + 'children' => [ + 'ListReceivedFile', + 'ListMyGroupDrive', + 'FileRemovePermission', + 'FileAddPermission', + 'FileListPermission', + 'ListAssignment', + 'AssignRole', + 'CancelAssignRole', + ], + ], + [ + 'id' => 164958, + 'title' => 'ShareLink Management', + 'type' => 'directory', + 'children' => [ + 'CreateShareLink', + 'UpdateShareLink', + 'SearchShareLink', + 'CancelShareLink', + 'ListShareLink', + 'GetShareLink', + 'GetShareLinkByAnonymous', + 'GetShareLinkToken', + ], + ], + [ + 'id' => 164964, + 'title' => 'Recycle Bin Management', + 'type' => 'directory', + 'children' => [ + 'TrashFile', + 'ClearRecyclebin', + 'ListRecyclebin', + 'RestoreFile', + ], + ], + [ + 'id' => 163810, + 'title' => 'Image AI Management', + 'type' => 'directory', + 'children' => [ + 'UpdateFacegroup', + 'ListTags', + 'ListAddressGroups', + 'ListFacegroups', + 'SearchAddressGroups', + 'RemoveFaceGroupFile', + 'CreateStory', + 'CreateCustomizedStory', + 'SearchStories', + 'GetStory', + 'UpdateStory', + 'DeleteStory', + 'AddStoryFiles', + 'RemoveStoryFiles', + 'CreateSimilarImageClusterTask', + 'GetTaskStatus', + 'SearchSimilarImageClusters', + ], + ], + [ + 'id' => 165162, + 'title' => 'Job Management', + 'type' => 'directory', + 'children' => [ + 'GetAsyncTask', + ], + ], + [ + 'id' => 166916, + 'title' => 'Online Video Preview', + 'type' => 'directory', + 'children' => [ + 'GetVideoPreviewPlayMeta', + 'GetVideoPreviewPlayInfo', + ], + ], + [ + 'id' => 182149, + 'title' => 'Benefit Management', + 'type' => 'directory', + 'children' => [ + 'CreateIdentityToBenefitPkgMapping', + 'UpdateIdentityToBenefitPkgMapping', + 'GetIdentityToBenefitPkgMapping', + 'ListIdentityToBenefitPkgMapping', + ], + ], + [ + 'id' => 182158, + 'title' => 'Content Security Management', + 'type' => 'directory', + 'children' => [ + 'InvestigateFile', + 'CsiGetFileInfo', + ], + ], + [ + 'id' => 172104, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'Batch', + 'AuditLogExport', + 'GetDomainQuota', + 'GroupUpdateName', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'PunishFile', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AccountLinkInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the associated account.'."\n", + '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', + ], + ], + ], + 'Address' => [ + '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", + ], + ], + 'nullable' => true, + ], + 'AddressGroup' => [ + 'title' => '', + 'description' => 'The information about the site group.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + 'AddStoryFile' => [ + 'title' => '', + 'description' => 'Returns the files added to the story and their success or failure'."\n", + 'visibility' => 'Private', + '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', + ], + ], + ], + 'AppAccessStrategy' => [ + 'title' => '', + 'description' => 'The information about the access policy of the application.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'effect' => [ + 'title' => '', + 'description' => 'The global access policy of the application. Valid values:'."\n" + ."\n" + .'* allow: The domain allows access from all applications.'."\n" + .'* deny: The domain denies access from all apps. This is the default value.'."\n" + ."\n" + .'Recommended settings:'."\n" + ."\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', + 'type' => 'string', + 'enumValueTitles' => [ + 'allow' => '', + 'deny' => '', + ], + 'example' => 'deny', + ], + 'except_app_id_list' => [ + 'title' => '', + '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', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the application.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '8ovxCTRUDdbpVWBP', + 'extendType' => 'true', + ], + ], + ], + 'parseType' => 'struct', + ], + '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', + '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', + ], + ], + ], + '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', + ], + ], + ], + 'FaceGroup' => [ + 'title' => '', + 'description' => 'The information about the face-based group.'."\n", + 'visibility' => 'public', + '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_cover_face_boundary' => [ + 'title' => '', + 'description' => 'The border of the image used as the cover the face-based group.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + ], + 'FaceThumbnail' => [ + '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', + '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, + ], + ], + ], + 'File' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the file.'."\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', + ], + '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', + ], + 'type' => [ + 'title' => '', + 'description' => 'The file type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* file'."\n" + .'* folder'."\n", + 'visibility' => 'public', + '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', + ], + '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', + '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', + ], + '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', + ], + 'content_hash_name' => [ + 'title' => '', + 'description' => 'The name of the hash algorithm. Set the value to sha1.'."\n", + 'visibility' => 'public', + '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', + ], + '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', + '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', + ], + ], + ], + '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', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '', + 'visibility' => 'public', + '$ref' => '#/components/schemas/SimpleStreamInfo', + ], + ], + 'user_tags' => [ + 'title' => '', + 'description' => 'The custom tags.'."\n", + 'visibility' => 'public', + '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', + ], + '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', + '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', + ], + ], + ], + 'trashed' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'boolean', + ], + 'action_list' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'visibility' => 'Public', + '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', + ], + ], + ], + 'FilePermissionMember' => [ + 'title' => 'A short description of struct', + 'description' => 'The permission information.'."\n", + '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', + ], + 'action_list' => [ + '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', + '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', + ], + 'required' => false, + ], + ], + ], + 'Group' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the group.'."\n", + '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', + ], + ], + ], + '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', + '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', + ], + ], + ], + 'IdentityToBenefitPkgMapping' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the benefit package that is associated with the entity.'."\n", + 'visibility' => 'public', + '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', + ], + 'delivery_info_list' => [ + 'title' => '', + 'description' => 'The information about the benefit packages that are associated with an entity.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + 'ImageMediaMetadata' => [ + 'title' => 'A short description of struct', + 'description' => 'The image metadata. This parameter is valid only if the value-added image processing feature is enabled.'."\n", + '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', + ], + 'country' => [ + 'title' => '', + 'description' => 'The country or region in which the image was taken.'."\n", + '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", + ], + 'image_tags' => [ + 'title' => '', + 'description' => 'The details of the image tags.'."\n", + '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}}}]', + ], + 'faces_thumbnail' => [ + 'title' => '', + 'description' => 'The thumbnails of the faces.'."\n", + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + 'ImageTag' => [ + 'title' => '', + 'description' => 'The information about the image tag.'."\n", + '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', + ], + ], + ], + 'InvestigationInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '', + 'description' => 'The status of the review.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0: The review is not performed.'."\n" + .'* 1: The review is not supported.'."\n" + .'* 2: The review fails.'."\n" + .'* 3: The review is in progress.'."\n" + .'* 4: The review is complete.'."\n" + .'* 5: Penalty methods are applied.'."\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: The review is passed..'."\n" + .'* block: The review is not passed. It is recommended to limit the use of the image.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'pass' => '', + 'block' => '', + ], + 'example' => 'block', + ], + 'video_detail' => [ + 'title' => '', + 'description' => 'Video review information'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'block_frames' => [ + 'title' => '', + 'description' => 'Violation frame information'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + ], + ], + ], + ], + 'Permission' => [ + 'title' => 'A short description of struct', + 'description' => 'Permissions'."\n", + '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***', + ], + 'action_list' => [ + 'title' => '', + 'description' => 'Action list.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '', + 'description' => 'Specific action, such as FILE.ALL'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'FILE.ALL', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + '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', + ], + 'user_tags' => [ + 'title' => '', + 'description' => 'Custom tag.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Custom tag string.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'user1', + 'extendType' => 'true', + ], + ], + ], + ], + 'PermissionCondition' => [ + 'title' => 'permission condition', + 'description' => 'Condition'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ip_equals' => [ + 'title' => '', + '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', + ], + ], + ], + ], + 'ip_not_equals' => [ + 'title' => '', + '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', + ], + ], + ], + ], + 'string_like' => [ + 'title' => '', + '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', + ], + ], + ], + ], + 'string_not_like' => [ + 'title' => '', + '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', + ], + ], + ], + ], + ], + ], + 'Revision' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the version.'."\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', + ], + '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', + ], + ], + ], + 'Role' => [ + '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', + ], + 'permissions' => [ + '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', + ], + ], + 'parseType' => 'struct', + ], + 'ShareLink' => [ + 'title' => '', + 'description' => 'The information about a share.'."\n", + 'visibility' => 'public', + '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', + ], + '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' => '', + ], + 'example' => '["520b217f13adf4fc24f2191991b1664ce045b393"]', + ], + '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', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the share. Valid values:'."\n" + ."\n" + .'* disabled: The share is canceled.'."\n" + .'* enabled: The share is effective.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '', + 'enabled' => '', + ], + 'example' => 'enabled', + ], + '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', + ], + ], + ], + 'Story' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the story.'."\n", + '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', + ], + 'face_group_ids' => [ + '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', + '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', + ], + 'story_file_list' => [ + 'title' => '', + 'description' => 'The story files.'."\n", + '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', + ], + 'custom_labels' => [ + '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', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The custom tag.'."\n", + 'visibility' => 'public', + 'type' => 'any', + 'example' => '{'."\n" + .' "key": "value"'."\n" + .'}', + ], + ], + ], + ], + 'SystemTag' => [ + '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', + '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', + ], + ], + ], + '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', + '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', + ], + 'token_type' => [ + 'title' => '', + 'description' => 'The type of the token.'."\n" + ."\n" + .'* Only Bearer is supported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Bearer' => 'Bearer', + ], + 'example' => 'Bearer', + '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', + ], + 'domain_id' => [ + 'title' => '', + 'description' => 'The domain ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'bj1', + 'backendName' => 'domain_id', + ], + ], + ], + 'UncompressedFileInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The extracted file.'."\n", + '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', + ], + 'is_folder' => [ + 'title' => '', + 'description' => 'Whether it is a folder.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + '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', + ], + 'items' => [ + 'title' => '', + 'description' => 'Subfiles'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The extracted file.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/UncompressedFileInfo', + ], + ], + ], + ], + 'UploadPartInfo' => [ + 'title' => '', + 'description' => 'The information about the file part.'."\n", + 'visibility' => 'public', + '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"', + ], + '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', + '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', + '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', + ], + ], + ], + 'parallel_sha256_ctx' => [ + 'title' => '', + 'description' => 'The SHA-256 context of the previous part.'."\n", + 'visibility' => 'public', + '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', + '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', + ], + ], + ], + ], + ], + 'User' => [ + 'title' => '', + 'description' => 'The information about the user.'."\n", + 'visibility' => 'public', + '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' => '[email protected]', + ], + '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', + ], + 'role' => [ + 'title' => '', + 'description' => 'The role of the user. Valid values:'."\n" + ."\n" + .'* superadmin'."\n" + .'* admin'."\n" + .'* user'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'superadmin' => '', + 'admin' => '', + 'user' => '', + ], + 'example' => 'user', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the user. Valid values:'."\n" + ."\n" + .'* disabled: The user is prohibited from logon.'."\n" + .'* enabled: The user is in a normal state.'."\n", + 'visibility' => 'public', + '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_data' => [ + 'title' => '', + 'description' => 'The custom data of the user.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'additionalProperties' => [ + 'visibility' => 'public', + 'type' => 'string', + 'description' => '', + ], + ], + 'creator' => [ + 'title' => '', + 'description' => 'The user who created the user.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'user1', + ], + 'punishments' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + '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', + ], + ], + 'is_sync' => [ + 'title' => '是否为同步账号', + 'description' => '是否为同步账号', + 'visibility' => 'Private', + 'type' => 'boolean', + ], + ], + ], + 'UserTag' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the user tag.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + 'VideoMediaAudioStream' => [ + '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', + ], + ], + ], + 'VideoMediaMetadata' => [ + 'title' => 'A short description of struct', + 'description' => 'The video metadata.'."\n", + 'visibility' => 'public', + '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', + ], + 'video_media_video_stream' => [ + 'title' => '', + 'description' => 'The information about the video stream.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoMediaVideoStream', + 'description' => '', + ], + ], + 'video_media_audio_stream' => [ + 'title' => '', + 'description' => 'The information about the audio stream.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoMediaAudioStream', + 'description' => '', + ], + ], + ], + ], + '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", + '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', + ], + ], + ], + 'VideoPreviewPlayInfo' => [ + 'title' => '', + 'description' => 'The information about video playback.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'title' => '', + 'description' => 'Category'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'live_transcoding', + ], + 'meta' => [ + 'title' => '', + 'description' => 'Video meta information.'."\n", + 'visibility' => 'public', + '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', + ], + ], + ], + 'live_transcoding_task_list' => [ + 'title' => '', + 'description' => 'The information about video playback.'."\n", + 'visibility' => 'public', + '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', + ], + 'keep_original_resolution' => [ + 'title' => '', + 'description' => 'Whether the original resolution is maintained.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + 'quick_video_list' => [ + 'title' => '', + 'description' => 'The information about video playback.'."\n", + 'visibility' => 'Public', + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + 'offline_video_transcoding_list' => [ + 'title' => '', + 'description' => 'Offline transcoding playback information.'."\n", + 'visibility' => 'Public', + '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', + ], + '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', + '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", + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + 'live_transcoding_subtitle_task_list' => [ + 'title' => '', + 'description' => 'Live transcoding subtitle information.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + 'description' => '', + ], + ], + 'quick_video_subtitle_list' => [ + 'title' => '', + 'description' => 'Quick transcoding subtitle information.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + 'description' => '', + ], + ], + 'offline_video_transcoding_subtitle_list' => [ + 'title' => '', + 'description' => 'Offline transcoding subtitle information.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/VideoPreviewSubtitleInfo', + 'description' => '', + ], + ], + 'master_url' => [ + 'title' => '', + 'description' => 'Playback URL of master m3u8.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8', + ], + ], + ], + 'VideoPreviewPlayMeta' => [ + 'title' => '', + 'description' => 'The preview metadata of the video.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'meta' => [ + 'title' => '', + 'description' => 'Video meta information.'."\n", + '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', + ], + ], + ], + 'live_transcoding_task_list' => [ + 'title' => '', + 'description' => 'Status of the live transcoding job.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '', + 'description' => 'Template ID'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '264_720p', + ], + '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', + 'enumValueTitles' => [ + 'running' => 'running', + 'finished' => 'finished', + 'failed' => 'failed', + ], + 'example' => 'finished', + ], + 'keep_original_resolution' => [ + 'title' => '', + 'description' => 'Whether the original resolution is maintained.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + 'category' => [ + 'title' => '', + 'description' => 'Category'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'live_transcoding', + ], + 'quick_video_list' => [ + 'title' => '', + 'description' => 'The state of the transcoding job.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + 'offline_video_transcoding_list' => [ + 'title' => '', + 'description' => 'The status of the offline transcoding job.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + ], + ], + ], + 'VideoPreviewSubtitleInfo' => [ + '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', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the subtitle task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* finished'."\n" + .'* failed'."\n", + 'visibility' => 'Public', + 'type' => 'string', + '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', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateDomain' => [ + 'summary' => 'Creates a domain.', + 'path' => '/v2/domain/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body parameters.'."\n", + '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' => [], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The name of 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' => 'CreateDomain', + 'description' => 'The description of the domain.'."\n", + ], + 'GetDomain' => [ + 'summary' => 'Get domain information.', + 'path' => '/v2/domain/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + '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", + '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, + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the updated domain.'."\n", + '$ref' => '#/components/schemas/Domain', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n}","type":"json"}]', + 'title' => 'UpdateDomain', + ], + 'ListDomains' => [ + 'summary' => '列举 domain', + 'path' => '/v2/domain/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned domains.'."\n", + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'ListDomains', + ], + 'SearchDomains' => [ + 'summary' => 'Searches for domains', + 'path' => '/v2/domain/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"parent_domain_id\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"domain_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"init_drive_enable\\": true,\\n \\"init_drive_size\\": 0,\\n \\"updated_at\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"size_quota\\": 0,\\n \\"size_quota_used\\": 0,\\n \\"user_count_quota\\": 0,\\n \\"status\\": 0,\\n \\"used_size\\": 0,\\n \\"published_app_access_strategy\\": {\\n \\"effect\\": \\"\\",\\n \\"except_app_id_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"watermark_config\\": {\\n \\"enable_doc_preview\\": true,\\n \\"display_access_user_name\\": true,\\n \\"display_shareLink_creator_name\\": true,\\n \\"display_custom_text\\": \\"\\"\\n },\\n \\"auth_config\\": {\\n \\"key\\": {\\n \\"enable\\": true,\\n \\"app_id\\": \\"\\",\\n \\"app_secret\\": \\"\\",\\n \\"endpoint\\": \\"\\",\\n \\"enterprise_id\\": \\"\\",\\n \\"white_list_enable\\": true,\\n \\"ldap_config\\": {\\n \\"version\\": \\"\\",\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"uid\\": \\"\\",\\n \\"admin_dn\\": \\"\\",\\n \\"global_uid\\": \\"\\",\\n \\"admin_password\\": \\"\\",\\n \\"base_dn\\": \\"\\",\\n \\"display_name_key\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"sync_config\\": {\\n \\"enabled\\": true,\\n \\"group_object_class\\": \\"\\",\\n \\"group_filter\\": \\"\\",\\n \\"user_object_class\\": \\"\\",\\n \\"user_filter\\": \\"\\",\\n \\"cron\\": \\"\\"\\n }\\n },\\n \\"ding_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n },\\n \\"we_chat_sync_config\\": {\\n \\"enabled\\": true,\\n \\"tag_id\\": \\"\\",\\n \\"cron\\": \\"\\"\\n },\\n \\"lark_sync_config\\": {\\n \\"enabled\\": true,\\n \\"cron\\": \\"\\",\\n \\"sync_mobile_enabled\\": true,\\n \\"sync_email_enabled\\": true\\n }\\n }\\n },\\n \\"sharable\\": true,\\n \\"ali_owner_id\\": \\"\\",\\n \\"archive_files_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"uncompress_config\\": {\\n \\"enabled\\": true,\\n \\"version\\": \\"\\"\\n },\\n \\"multi_revision_config\\": {\\n \\"revision_merge_enabled\\": true,\\n \\"revision_count\\": 0,\\n \\"revision_recycle_period\\": 0\\n },\\n \\"app_config\\": {\\n \\"same_name_file_upload_mode\\": \\"\\",\\n \\"web_client_download_mode\\": \\"\\",\\n \\"single_file_upload_size_limit\\": 0,\\n \\"allow_upload_file_category_list\\": [\\n \\"\\"\\n ],\\n \\"allow_upload_custom_file_ext_list\\": [\\n \\"\\"\\n ]\\n },\\n \\"recycle_bin_config\\": {\\n \\"auto_delete_enabled\\": true,\\n \\"auto_delete_keep_second\\": 0,\\n \\"delete_trash_normal_file_disabled\\": true\\n },\\n \\"office_preview_config\\": {\\n \\"enabled\\": true\\n },\\n \\"office_edit_config\\": {\\n \\"enabled\\": true\\n },\\n \\"share_link_detail\\": {\\n \\"enable_office_editable\\": true\\n },\\n \\"endpoints\\": {\\n \\"api_endpoint\\": \\"\\",\\n \\"api_vpc_endpoint\\": \\"\\",\\n \\"app_endpoint\\": \\"\\",\\n \\"auth_endpoint\\": \\"\\",\\n \\"mgmt_endpoint\\": \\"\\",\\n \\"web_office_endpoint_list\\": \\"\\",\\n \\"store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ],\\n \\"va_store_list\\": [\\n {\\n \\"store_id\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"bucket\\": \\"\\",\\n \\"base_path\\": \\"\\",\\n \\"role_arn\\": \\"\\",\\n \\"ownership\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"public_endpoint\\": \\"\\",\\n \\"vpc_endpoint\\": \\"\\",\\n \\"acc_endpoint\\": \\"\\",\\n \\"acc_oversea_endpoint\\": \\"\\",\\n \\"cdn_endpoint\\": \\"\\",\\n \\"endpoint\\": \\"\\"\\n }\\n ]\\n },\\n \\"data_hash_name\\": \\"\\",\\n \\"store_redundancy_type\\": \\"LRS\\",\\n \\"system_drive_config\\": {\\n \\"enable\\": true,\\n \\"drive_id\\": \\"\\",\\n \\"resource_parent_file_id_map\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"endpoint_version\\": 0\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'SearchDomains', + ], + 'DeleteDomain' => [ + 'summary' => 'Delete the domain', + 'path' => '/v2/domain/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'domain_id' => [ + 'description' => 'The domain ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bj1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteDomain', + ], + 'Authorize' => [ + 'summary' => 'Requests permissions by using OAuth 2.0.', + 'path' => '/v2/oauth/authorize', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'client_id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID returned when the application was created.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '47eUHhrzgWBvlLWj', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The requested permissions. By default, all permissions are requested.'."\n", + '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', + ], + 'required' => false, + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'hide_consent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to hide the consent page.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 302 => [ + 'headers' => [ + 'location' => [ + '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', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'grant_type', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + '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', + 'required' => false, + 'example' => '0045157fa8e24f4f9a0d9e3ff158c1e0', + ], + ], + [ + 'name' => 'redirect_uri', + 'in' => 'formData', + '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", + ], + ], + [ + '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', + ], + ], + [ + '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", + ], + ], + [ + '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' => 'assertion', + 'in' => 'formData', + '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', + 'required' => false, + 'example' => 'ey***asd'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The information about the access token.'."\n", + '$ref' => '#/components/schemas/Token', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"expires_in\\": 0,\\n \\"token_type\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"expire_time\\": \\"\\",\\n \\"is_first_login\\": true,\\n \\"device_id\\": \\"\\",\\n \\"device_name\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"default_sbox_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"pin_setup\\": true,\\n \\"need_rp_verify\\": true,\\n \\"state\\": \\"\\",\\n \\"exist_link\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\"\\n }\\n ],\\n \\"need_link\\": true,\\n \\"device_info\\": \\"\\",\\n \\"device_signature\\": \\"\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"authentication_type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"display_name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"last_login_time\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetLinkInfoByUserId', + ], + 'LinkAccount' => [ + 'summary' => 'Associates an account with a user.', + 'path' => '/v2/account/link', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The information about the access token of the user.'."\n", + '$ref' => '#/components/schemas/Token', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"access_token\\": \\"\\",\\n \\"refresh_token\\": \\"\\",\\n \\"expires_in\\": 0,\\n \\"token_type\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"expire_time\\": \\"\\",\\n \\"is_first_login\\": true,\\n \\"device_id\\": \\"\\",\\n \\"device_name\\": \\"\\",\\n \\"domain_id\\": \\"\\",\\n \\"default_sbox_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"pin_setup\\": true,\\n \\"need_rp_verify\\": true,\\n \\"state\\": \\"\\",\\n \\"exist_link\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\"\\n }\\n ],\\n \\"need_link\\": true,\\n \\"device_info\\": \\"\\",\\n \\"device_signature\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'LinkAccount', + ], + 'GetLinkInfo' => [ + 'summary' => 'Queries the information about an account.', + 'path' => '/v2/account/get_link_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The information about the account.'."\n", + '$ref' => '#/components/schemas/AccountLinkInfo', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"authentication_type\\": \\"\\",\\n \\"identity\\": \\"\\",\\n \\"extra\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"display_name\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"last_login_time\\": 0\\n}","type":"json"}]', + 'title' => 'GetLinkInfo', + ], + 'UnLinkAccount' => [ + 'summary' => 'Unlink Account Binding', + 'path' => '/v2/account/unlink', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of the struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Unlink Account', + 'translator' => 'machine', + ], + 'CreateGroup' => [ + 'summary' => 'Creates a group.', + 'path' => '/v2/group/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'group_name' => [ + 'description' => 'The name of the group. The name must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + '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', + ], + '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', + ], + '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', + 'required' => false, + 'example' => '2e43ec8427dd45f19431b7504649a1b3', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the created group.'."\n", + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => 'CreateGroup', + ], + 'UpdateGroup' => [ + 'summary' => 'Modifies the information about a group.', + 'path' => '/v2/group/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'test group description', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the group after modification.'."\n", + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => 'UpdateGroup', + ], + 'GetGroup' => [ + 'summary' => 'Queries the information about a group.', + 'path' => '/v2/group/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2e43ec8427dd45f19431b7504649a1b1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the group.'."\n", + '$ref' => '#/components/schemas/Group', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n}","type":"json"}]', + 'title' => 'GetGroup', + ], + 'ListGroup' => [ + 'summary' => 'Queries groups.', + 'path' => '/v2/group/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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 left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + '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' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'g123', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteGroup', + ], + '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' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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" + ."\n" + .'Note: A group can be added to only one group. A user can be added to multiple groups.', + 'type' => 'string', + 'required' => true, + 'example' => 'user', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'AddGroupMember', + ], + 'RemoveGroupMember' => [ + 'summary' => 'Removes a member from a group.', + 'path' => '/v2/group/remove_member', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => 'The ID of the group of which you want to query members.'."\n", + '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', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"user_items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n }\\n ],\\n \\"group_items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"group_id\\": \\"\\",\\n \\"group_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"creator\\": \\"\\",\\n \\"is_sync\\": true\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1\\"\\n}","type":"json"}]', + 'title' => 'ListGroupMember', + ], + 'CreateUser' => [ + 'summary' => 'Creates a user.', + 'path' => '/v2/user/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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, + ], + 'status' => [ + 'title' => '用户状态', + 'description' => 'The state of the user. Default value: enabled. Valid values:'."\n" + ."\n" + .'* enabled: The user is in a normal state.'."\n" + .'* disabled: The user is prohibited from logon.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + 'default' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + '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" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* admin'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* user'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + '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', + 'required' => false, + 'example' => '[email protected]', + ], + 'user_data' => [ + 'description' => 'The custom data. The data can be up to 1,024 characters in length.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => 'md', + 'title' => '', + ], + 'group_info_list' => [ + 'description' => 'The information about the group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'g123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 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' => '[email protected]', + ], + 'role' => [ + 'title' => '角色', + 'description' => 'The role of the user. Valid values:'."\n" + ."\n" + .'* superadmin'."\n" + .'* admin'."\n" + .'* user'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'superadmin' => '', + 'admin' => '', + 'user' => '', + ], + 'example' => 'admin', + ], + 'status' => [ + 'title' => '状态', + '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', + 'enumValueTitles' => [ + 'disabled' => '', + 'enabled' => '', + ], + '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', + ], + 'user_data' => [ + 'description' => 'The custom data.'."\n", + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"user_id\\": \\"dingding_abc001\\",\\n \\"avatar\\": \\"http://aa.com/1.jpg\\",\\n \\"created_at\\": 1639762579768,\\n \\"updated_at\\": 1639762579768,\\n \\"nick_name\\": \\"001\\",\\n \\"user_name\\": \\"pds\\",\\n \\"phone\\": \\"13900001111\\",\\n \\"email\\": \\"[email protected]\\",\\n \\"role\\": \\"admin\\",\\n \\"status\\": \\"enabled\\",\\n \\"description\\": \\"vipuser\\",\\n \\"default_drive_id\\": \\"1\\",\\n \\"user_data\\": {\\n \\"key\\": \\"dog\\"\\n },\\n \\"creator\\": \\"user1\\"\\n}","type":"json"}]', + 'title' => 'CreateUser', + ], + 'ImportUser' => [ + 'summary' => 'Imports a user.', + 'path' => '/v2/user/import', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'ImportUser', + ], + 'UpdateUser' => [ + 'summary' => 'Modifies the information about a user.', + 'path' => '/v2/user/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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' => '[email protected]', + ], + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'GetUser', + ], + 'ListUser' => [ + 'summary' => 'Queries users.', + 'path' => '/v2/user/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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' => '[email protected]', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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 a user.'."\n", + '$ref' => '#/components/schemas/User', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"user_id\\": \\"\\",\\n \\"avatar\\": \\"\\",\\n \\"created_at\\": 0,\\n \\"updated_at\\": 0,\\n \\"email\\": \\"\\",\\n \\"nick_name\\": \\"\\",\\n \\"phone\\": \\"\\",\\n \\"role\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"user_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"default_drive_id\\": \\"\\",\\n \\"user_data\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"creator\\": \\"\\",\\n \\"punishments\\": [\\n {\\n \\"punish_flag\\": 0,\\n \\"starts_at\\": \\"\\",\\n \\"ends_at\\": \\"\\",\\n \\"impermanent\\": true\\n }\\n ],\\n \\"is_sync\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SearchUser', + ], + 'DeleteUser' => [ + 'summary' => 'Deletes a user.', + 'path' => '/v2/user/delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'user_id' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'c9b7a5aa04d14ae3867fdc886fa01da4', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteUser', + ], + 'CreateDrive' => [ + 'summary' => 'Creates a drive.', + 'path' => '/v2/drive/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'UpdateDrive', + ], + 'GetDrive' => [ + 'summary' => 'Queries the information about a drive.', + 'path' => '/v2/drive/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => 'The drive ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetDrive', + ], + 'ListDrive' => [ + 'summary' => 'Queries a list of drives.', + 'path' => '/v2/drive/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '$ref' => '#/components/schemas/Drive', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetDefaultDrive', + ], + 'ListMyDrives' => [ + 'summary' => 'Queries the drives of the current user.', + 'path' => '/v2/drive/list_my_drives', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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", + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_name' => [ + 'description' => 'The drive name.'."\n", + 'type' => 'string', + 'required' => false, + '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, + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => 'The drive ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteDrive', + ], + 'CreateFile' => [ + 'summary' => 'Creates a file or folder.', + 'path' => '/v2/file/create', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + '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', + ], + ], + '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' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + ], + 'required' => false, + ], + ], + ], + '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", + '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" + ."\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" + ."\n" + .'The order in which you want to sort the returned entries. Valid values:'."\n" + ."\n" + .'* ASC: ascending order'."\n" + .'* DESC: descending order'."\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" + ."\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" + ."\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" + ."\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", + 'type' => 'string', + 'required' => false, + 'example' => 'url,thumbnail', + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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", + '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", + ], + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\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' => 'GetFile', + ], + 'DownloadFile' => [ + 'summary' => 'Downloads a file.', + 'path' => '/v2/file/download', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'share_id', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + ], + 'responses' => [ + 302 => [ + 'headers' => [ + 'location' => [ + 'schema' => [ + 'title' => '下载地址', + 'type' => 'string', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => 'CompleteFile', + ], + 'MoveFile' => [ + 'summary' => 'Moves files or folders.', + 'path' => '/v2/file/move', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + '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', + ], + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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', + 'required' => true, + 'example' => '9520943DC264', + ], + ], + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '""', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + 'revision_id' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the version.'."\n", + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + 'revision_id' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '40CB7794C929', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the version.'."\n", + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'RestoreRevision', + ], + 'ListRevision' => [ + 'summary' => 'Queries the versions of a file.', + 'path' => '/v2/file/revision/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + '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' => '*', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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", + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\"\\n}","type":"json"}]', + 'title' => 'ListRevision', + ], + 'GetRevision' => [ + 'summary' => 'Queries the information about a version.', + 'path' => '/v2/file/revision/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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', + ], + 'revision_id' => [ + 'description' => 'The version ID.'."\n", + 'type' => 'string', + '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' => '*', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the version.'."\n", + '$ref' => '#/components/schemas/Revision', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"revision_name\\": \\"\\",\\n \\"revision_version\\": 0,\\n \\"size\\": 0,\\n \\"file_extension\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"keep_forever\\": true,\\n \\"revision_description\\": \\"\\",\\n \\"is_latest_version\\": true,\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetRevision', + ], + 'ScanFile' => [ + 'summary' => 'Scans files.', + 'path' => '/v2/file/scan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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' => '*', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'title' => '云端Drive id'."\n", + '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', + ], + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'cursor' => [ + 'title' => '当前增量变化的最新游标', + 'description' => 'The latest cursor of incremental information in the specified drive or synced folder.'."\n", + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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***', + ], + ], + 'required' => false, + ], + ], + ], + '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***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"eym***\\"\\n}","type":"json"}]', + 'title' => 'ListReceivedFile', + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => '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 left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'drive_name' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg\\",\\n \\"root_group_drive\\": {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"drive_name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"owner\\": \\"\\",\\n \\"owner_type\\": \\"\\",\\n \\"drive_type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"used_size\\": 0,\\n \\"total_size\\": 0,\\n \\"created_at\\": \\"\\",\\n \\"creator\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'ListMyGroupDrive', + ], + 'FileRemovePermission' => [ + 'summary' => 'Cancels the permissions on a shared file.', + 'path' => '/v2/file/remove_permission', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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' => '4221bf6e6ab43c255edc4463bf3a6f5f5d317406', + ], + 'member_list' => [ + 'description' => 'The identities with whom the file is shared.'."\n", + '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', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'headers' => [], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"identity\\": {\\n \\"identity_type\\": \\"IT_User\\",\\n \\"identity_id\\": \\"\\"\\n },\\n \\"role_id\\": \\"\\",\\n \\"expire_time\\": 0,\\n \\"disinherit_sub_group\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ]\\n }\\n]","type":"json"}]', + 'title' => 'FileListPermission', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'assignment_list' => [ + 'description' => 'The assigned roles.'."\n", + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'description' => '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', + ], + ], + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'AssignRole', + 'description' => 'You can call this operation to assign a group administrator role to a user.'."\n", + ], + 'CancelAssignRole' => [ + 'summary' => 'Cancels a role.', + 'path' => '/v2/role/cancel_assign', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'identity' => [ + 'description' => '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", + 'type' => 'string', + 'required' => true, + 'example' => '105***b82', + ], + ], + 'required' => false, + 'description' => '', + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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", + 'type' => 'string', + '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', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'UpdateShareLink', + ], + 'SearchShareLink' => [ + 'summary' => 'Queries share URLs.', + 'path' => '/v2/share_link/search', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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" + ."\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', + ], + 'return_total_count' => [ + 'description' => 'Specifies whether to return the total number of returned results.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + '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' => 'created_at', + ], + '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', + ], + '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', + ], + 'required' => false, + ], + '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' => 'string', + 'required' => false, + 'example' => 'created_at>=\'2022-01-18T02:50:00\' and created_at<\'2022-01-19T09:45:28\' and share_name_for_fuzzy match \'HD.mp4\' and status in [\'enabled\', \'disabled\'] and expired_time=\'1970-01-01T00:00:00\'', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The share URLs.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => 'The share ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + '_' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'CancelShareLink', + ], + 'ListShareLink' => [ + 'summary' => 'Queries shares.', + 'path' => '/v2/share_link/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The information about the shares.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a share.'."\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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => 'The share ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + '$ref' => '#/components/schemas/ShareLink', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"share_id\\": \\"\\",\\n \\"share_pwd\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id_list\\": [\\n \\"\\"\\n ],\\n \\"expiration\\": \\"\\",\\n \\"expired\\": true,\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"share_name\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"preview_count\\": 0,\\n \\"save_count\\": 0,\\n \\"download_count\\": 0,\\n \\"report_count\\": 0,\\n \\"video_preview_count\\": 0,\\n \\"access_count\\": 0,\\n \\"disable_preview\\": true,\\n \\"disable_save\\": true,\\n \\"disable_download\\": true,\\n \\"preview_limit\\": 0,\\n \\"save_limit\\": 0,\\n \\"download_limit\\": 0,\\n \\"require_login\\": true,\\n \\"share_all_files\\": true,\\n \\"share_msg\\": \\"\\",\\n \\"save_download_limit\\": 0,\\n \\"office_editable\\": true,\\n \\"comments\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetShareLink', + ], + 'GetShareLinkByAnonymous' => [ + 'summary' => 'Queries the information about a share link anonymously.', + 'path' => '/v2/share_link/get_by_anonymous', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'share_id' => [ + 'description' => 'The share ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7JQX1FswpQ8', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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 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', + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => 'The drive ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"drive_id\\": \\"1\\",\\n \\"async_task_id\\": \\"13ebd3a24dba4166b1527add676ef2866051b4d5dele16\\"\\n}","type":"json"}]', + 'title' => 'ClearRecyclebin', + ], + 'ListRecyclebin' => [ + 'summary' => 'Queries the information about files and folders in the recycle bin.', + 'path' => '/v2/recyclebin/list', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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", + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The information about the files and folders in the recycle bin.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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' => '4221bf6e6ab43a255edc4463bffa6f5f5d317401', + ], + ], + 'required' => false, + ], + ], + ], + '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 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', + ], + ], + ], + ], + 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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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, + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'tags' => [ + 'description' => 'The information about the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a tag.'."\n", + '$ref' => '#/components/schemas/ImageTag', + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The information about the location-based groups.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '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", + 'type' => 'string', + 'required' => false, + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg', + ], + 'return_total_count' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => 'The drive ID.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => 'The location-based groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The location-based group.'."\n", + '$ref' => '#/components/schemas/AddressGroup', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"location\\": \\"\\",\\n \\"count\\": 0,\\n \\"cover_url\\": \\"\\",\\n \\"cover_file_id\\": \\"\\",\\n \\"address_detail\\": {\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"余杭区\\",\\n \\"township\\": \\"文一西路\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SearchAddressGroups', + ], + 'RemoveFaceGroupFile' => [ + 'summary' => '从人脸分组中的移除指定的文件', + 'path' => '/v2/albums/unassign_facegroup_item', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 204 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'RemoveFaceGroupFile', + ], + 'CreateStory' => [ + 'summary' => '创建推荐故事', + 'path' => '/v2/image/create_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'CreateStory', + ], + 'CreateCustomizedStory' => [ + 'summary' => '创建自定义故事', + 'path' => '/v2/image/create_customized_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'file_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '63e5e4340f76cb3ead5f40f68163f0f967c1a7bf', + ], + 'revision_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '642a88d4aff041ee68fd4fc89beb80e1119da343', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + 'custom_labels' => [ + 'description' => '', + 'type' => 'object', + 'deprecated' => true, + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"key":"value"}', + 'description' => '', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => 'CreateCustomizedStory', + ], + 'SearchStories' => [ + 'summary' => '查询故事列表', + 'path' => '/v2/image/find_stories', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/Story', + ], + ], + 'next_marker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"story_id\\": \\"\\",\\n \\"story_type\\": \\"\\",\\n \\"story_sub_type\\": \\"\\",\\n \\"story_name\\": \\"\\",\\n \\"story_start_time\\": \\"\\",\\n \\"story_end_time\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"face_group_ids\\": [\\n \\"\\"\\n ],\\n \\"cover_file_id\\": \\"\\",\\n \\"cover_file_thumbnail_url\\": \\"\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"custom_id\\": \\"\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ],\\n \\"next_marker\\": \\"Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJ***\\"\\n}","type":"json"}]', + 'title' => 'SearchStories', + ], + 'GetStory' => [ + 'summary' => '获取故事详情', + 'path' => '/v2/image/get_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '$ref' => '#/components/schemas/Story', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"story_id\\": \\"\\",\\n \\"story_type\\": \\"\\",\\n \\"story_sub_type\\": \\"\\",\\n \\"story_name\\": \\"\\",\\n \\"story_start_time\\": \\"\\",\\n \\"story_end_time\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"face_group_ids\\": [\\n \\"\\"\\n ],\\n \\"cover_file_id\\": \\"\\",\\n \\"cover_file_thumbnail_url\\": \\"\\",\\n \\"story_file_list\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ],\\n \\"custom_id\\": \\"\\",\\n \\"custom_labels\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetStory', + ], + 'UpdateStory' => [ + 'summary' => '更新故事', + 'path' => '/v2/image/update_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => 'UpdateStory', + ], + 'DeleteStory' => [ + 'summary' => '删除故事', + 'path' => '/v2/image/delete_story', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'story_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'DeleteStory', + ], + 'AddStoryFiles' => [ + 'summary' => '故事添加文件', + 'path' => '/v2/image/add_story_files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + 'files' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/AddStoryFile', + ], + ], + 'request_id' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\",\\n \\"files\\": [\\n {\\n \\"file_id\\": \\"63e5e4340f76cb3ead5f40f68163f0f967c1a7bf\\",\\n \\"revision_id\\": \\"642a88dd06e49d9c0a14411ebae606f70edd9a59\\",\\n \\"error_code\\": \\"\\",\\n \\"error_message\\": \\"\\"\\n }\\n ],\\n \\"request_id\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'AddStoryFiles', + ], + 'RemoveStoryFiles' => [ + 'summary' => '故事移除文件', + 'path' => '/v2/image/remove_story_files', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'story_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9132e0d8-fe92-4e56-86c3-f5f112308003', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"drive_id\\": \\"1\\",\\n \\"story_id\\": \\"9132e0d8-fe92-4e56-86c3-f5f112308003\\"\\n}","type":"json"}]', + 'title' => 'RemoveStoryFiles', + ], + 'CreateSimilarImageClusterTask' => [ + 'summary' => '创建相似图片聚类任务', + 'path' => '/v2/image/create_similar_image_cluster_task', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"task_id\\": \\"i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb\\"\\n}","type":"json"}]', + 'title' => 'CreateSimilarImageClusterTask', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => 'The drive ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'task_id' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'SearchSimilarImageClusters' => [ + 'summary' => '获取相似图片聚类结果', + 'path' => '/v2/image/query_similar_image_clusters', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + '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', + ], + 'order' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '', + 'desc' => '', + ], + 'example' => 'desc', + 'default' => 'desc', + 'enum' => [ + 'desc', + 'asc', + ], + ], + 'image_thumbnail_process' => [ + 'description' => '', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'image/resize,m_fill,h_128,w_128,limit_0/format,jpg', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'similar_image_clusters' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'files' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/File', + ], + ], + ], + ], + ], + 'next_marker' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"similar_image_clusters\\": [\\n {\\n \\"files\\": [\\n {\\n \\"domain_id\\": \\"\\",\\n \\"drive_id\\": \\"\\",\\n \\"file_id\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"content_type\\": \\"\\",\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"trashed_at\\": \\"\\",\\n \\"file_extension\\": \\"\\",\\n \\"mime_type\\": \\"\\",\\n \\"mime_extension\\": \\"\\",\\n \\"hidden\\": true,\\n \\"size\\": 0,\\n \\"starred\\": true,\\n \\"status\\": \\"\\",\\n \\"user_meta\\": \\"\\",\\n \\"labels\\": [\\n \\"\\"\\n ],\\n \\"upload_id\\": \\"\\",\\n \\"parent_file_id\\": \\"\\",\\n \\"crc64_hash\\": \\"\\",\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"thumbnail\\": \\"\\",\\n \\"category\\": \\"\\",\\n \\"local_created_at\\": \\"\\",\\n \\"local_modified_at\\": \\"\\",\\n \\"revision_id\\": \\"\\",\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\"\\n },\\n \\"thumbnail_urls\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"image_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"image_tags\\": [\\n {\\n \\"confidence\\": 0.98,\\n \\"parent_name\\": \\"运动\\",\\n \\"name\\": \\"篮球\\",\\n \\"tag_level\\": 3,\\n \\"source\\": \\"一起打篮球\\",\\n \\"centric_score\\": 0.877\\n }\\n ],\\n \\"faces\\": \\"[{\\\\\\"FaceId\\\\\\":\\\\\\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\\\\\",\\\\\\"GroupId\\\\\\":\\\\\\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\\\\\",\\\\\\"FaceConfidence\\\\\\":0.999,\\\\\\"Age\\\\\\":13,\\\\\\"AgeConfidence\\\\\\":4,\\\\\\"Gender\\\\\\":\\\\\\"female\\\\\\",\\\\\\"GenderConfidence\\\\\\":1,\\\\\\"Emotion\\\\\\":\\\\\\"none\\\\\\",\\\\\\"EmotionConfidence\\\\\\":0.672,\\\\\\"FaceAttributes\\\\\\":{\\\\\\"Mask\\\\\\":\\\\\\"none\\\\\\",\\\\\\"MaskConfidence\\\\\\":0.894,\\\\\\"Beard\\\\\\":\\\\\\"none\\\\\\",\\\\\\"BeardConfidence\\\\\\":0.997,\\\\\\"Glasses\\\\\\":\\\\\\"none\\\\\\",\\\\\\"GlassesConfidence\\\\\\":0.999,\\\\\\"Mouth\\\\\\":\\\\\\"close\\\\\\",\\\\\\"MouthConfidence\\\\\\":0.937,\\\\\\"Hat\\\\\\":\\\\\\"none\\\\\\",\\\\\\"HatConfidence\\\\\\":0.998,\\\\\\"HeadPose\\\\\\":{\\\\\\"Pitch\\\\\\":10.684,\\\\\\"Roll\\\\\\":-10.707,\\\\\\"Yaw\\\\\\":-20.094},\\\\\\"FaceBoundary\\\\\\":{\\\\\\"Width\\\\\\":457,\\\\\\"Height\\\\\\":687,\\\\\\"Top\\\\\\":1324,\\\\\\"Left\\\\\\":1356}}}]\\",\\n \\"faces_thumbnail\\": [\\n {\\n \\"face_id\\": \\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\\",\\n \\"face_group_id\\": \\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\\",\\n \\"face_thumbnail\\": \\"https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2\\"\\n }\\n ],\\n \\"exif\\": \\"{\\\\\\"Compression\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"6\\\\\\"},\\\\\\"DateTime\\\\\\":{\\\\\\"value\\\\\\":\\\\\\"2020:08:19 17:11:11\\\\\\"}}\\",\\n \\"image_quality\\": {\\n \\"overall_score\\": 0.736\\n }\\n },\\n \\"ex_fields_info\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"content_uri\\": \\"\\",\\n \\"streams_info\\": {\\n \\"key\\": {\\n \\"crc64_hash\\": \\"\\",\\n \\"size\\": 0,\\n \\"content_hash\\": \\"\\",\\n \\"content_hash_name\\": \\"\\",\\n \\"download_url\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"thumbnail\\": \\"\\"\\n }\\n },\\n \\"user_tags\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"revision_version\\": 0,\\n \\"video_media_metadata\\": {\\n \\"time\\": \\"2006-01-02T15:04:05.000Z07:00\\",\\n \\"width\\": 1920,\\n \\"height\\": 1080,\\n \\"location\\": \\"30.185453,120.218522\\",\\n \\"country\\": \\"中国\\",\\n \\"province\\": \\"浙江省\\",\\n \\"city\\": \\"杭州市\\",\\n \\"district\\": \\"滨江区\\",\\n \\"township\\": \\"西兴街道\\",\\n \\"address_line\\": \\"浙江省杭州市滨江区西兴街道江陵路\\",\\n \\"video_media_video_stream\\": [\\n {\\n \\"duration\\": \\"22.88\\",\\n \\"bitrate\\": \\"108420\\",\\n \\"code_name\\": \\"h264\\",\\n \\"frame_count\\": \\"90\\"\\n }\\n ],\\n \\"video_media_audio_stream\\": [\\n {\\n \\"duration\\": \\"7704.573000\\",\\n \\"bit_rate\\": \\"129280\\",\\n \\"code_name\\": \\"aac\\"\\n }\\n ]\\n },\\n \\"punish_flag\\": 0,\\n \\"id_path\\": \\"\\",\\n \\"name_path\\": \\"\\",\\n \\"creator_type\\": \\"\\",\\n \\"creator_id\\": \\"\\",\\n \\"creator_name\\": \\"\\",\\n \\"last_modifier_type\\": \\"\\",\\n \\"last_modifier_id\\": \\"\\",\\n \\"last_modifier_name\\": \\"\\",\\n \\"dir_size_info\\": {\\n \\"dir_count\\": 0,\\n \\"file_count\\": 0\\n },\\n \\"trashed\\": true,\\n \\"action_list\\": [\\n \\"\\"\\n ],\\n \\"location\\": \\"\\",\\n \\"semantic_result\\": {\\n \\"semantic_similarity\\": 0.879,\\n \\"document_contents\\": [\\n {\\n \\"element_contents\\": [\\n {\\n \\"type\\": \\"text\\",\\n \\"content\\": \\"文本片段\\",\\n \\"url\\": \\"http://aliyun.com\\",\\n \\"time_range\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n ],\\n \\"scene_contents\\": [\\n {\\n \\"time_range\\": [\\n 0\\n ],\\n \\"key_frames\\": [\\n {\\n \\"frame_time\\": 1000,\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ],\\n \\"thumbnail_url\\": \\"http://aliyun.com\\"\\n }\\n ]\\n },\\n \\"sync_flag\\": true,\\n \\"sync_device_flag\\": true,\\n \\"origin_parent_file_id\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"custom_field_1\\": \\"\\",\\n \\"custom_field_2\\": \\"\\",\\n \\"auto_delete_left_sec\\": 0,\\n \\"ai_processed\\": \\"\\",\\n \\"modified_at\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"next_marker\\": \\"NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0***\\"\\n}","type":"json"}]', + 'title' => 'SearchSimilarImageClusters', + ], + 'GetAsyncTask' => [ + 'summary' => 'Queries the information about an asynchronous task.', + 'path' => '/v2/async_task/get', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'async_task_id' => [ + 'description' => 'The ID of the asynchronous task.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '000e89fb-cf8f-11e9-8ab4-b6e980803a3b', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + 'category' => [ + 'description' => 'The preview type. You must enable the corresponding video transcoding feature. Valid values:'."\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", + 'type' => 'string', + 'required' => true, + 'example' => 'live_transcoding', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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", + ], + 'GetVideoPreviewPlayInfo' => [ + 'summary' => 'Queries the information about video playback.', + 'path' => '/v2/file/get_video_preview_play_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domain_id\\": \\"bj1\\",\\n \\"share_id\\": \\"7JQX1FswpQ8\\",\\n \\"drive_id\\": \\"1\\",\\n \\"file_id\\": \\"fileid1\\",\\n \\"video_preview_play_info\\": {\\n \\"category\\": \\"live_transcoding\\",\\n \\"meta\\": {\\n \\"duration\\": 0,\\n \\"width\\": 0,\\n \\"height\\": 0\\n },\\n \\"live_transcoding_task_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"keep_original_resolution\\": true,\\n \\"preview_url\\": \\"\\"\\n }\\n ],\\n \\"quick_video_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"preview_url\\": \\"\\"\\n }\\n ],\\n \\"offline_video_transcoding_list\\": [\\n {\\n \\"template_id\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"keep_original_resolution\\": true,\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"live_transcoding_subtitle_task_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"quick_video_subtitle_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"offline_video_transcoding_subtitle_list\\": [\\n {\\n \\"language\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"url\\": \\"\\"\\n }\\n ],\\n \\"master_url\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '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", + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + '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', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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" + ."\n" + .'If you call this operation to manage the benefits of a user, set this parameter to the ID of the user.'."\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 specifies the number of benefit packages of the resource type. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + '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', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information about the benefit package that is associated with the entity.'."\n", + '$ref' => '#/components/schemas/IdentityToBenefitPkgMapping', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"identity_type\\": \\"\\",\\n \\"identity_id\\": \\"\\",\\n \\"benefit_pkg_owner_id\\": \\"\\",\\n \\"benefit_pkg_id\\": \\"\\",\\n \\"benefit_pkg_type\\": \\"\\",\\n \\"benefit_pkg_name\\": \\"\\",\\n \\"benefit_pkg_priority\\": 0,\\n \\"benefit_pkg_computation_rule\\": \\"\\",\\n \\"delivery_info_list\\": [\\n {\\n \\"amount\\": 0,\\n \\"is_permanent\\": true,\\n \\"expire_time\\": \\"\\",\\n \\"created_at\\": \\"\\"\\n }\\n ],\\n \\"created_at\\": \\"\\",\\n \\"updated_at\\": \\"\\"\\n}","type":"json"}]', + 'title' => '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + '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" + ."\n" + .'If you call this operation to manage the benefits of a user, set this parameter to the ID of the user.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user123', + ], + 'include_expired' => [ + 'description' => 'Specifies whether to return the benefit packages that expire. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'drive_file_ids' => [ + 'description' => '', + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 202 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'InvestigateFile', + ], + 'CsiGetFileInfo' => [ + 'summary' => '获取文件内容安全信息', + 'path' => '/v2/csi/get_file_info', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'drive_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'file_id' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '9520943DC264', + ], + 'url_expire_sec' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '14400', + 'minimum' => '10', + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'investigation_info' => [ + 'description' => '', + '$ref' => '#/components/schemas/InvestigationInfo', + ], + 'url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"investigation_info\\": {\\n \\"status\\": 0,\\n \\"suggestion\\": \\"\\",\\n \\"video_detail\\": {\\n \\"block_frames\\": [\\n {\\n \\"rate\\": 0,\\n \\"offset\\": 0,\\n \\"label\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\"\\n}","type":"json"}]', + 'title' => 'CsiGetFileInfo', + ], + 'Batch' => [ + 'summary' => 'Calls multiple operations at a time to improve call efficiency.', + 'path' => '/v2/batch', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'BearerToken' => [], + ], + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'resource' => [ + 'description' => 'The type of the resource that you want to manage. 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" + ."\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, + ], + ], + 'required' => false, + ], + ], + ], + '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"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + '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', + 'required' => false, + 'example' => '2024-01-log.csv', + ], + 'language' => [ + 'description' => 'The export language. Default value: zh-CN. Valid values:'."\n" + ."\n" + .'* zh-CN: Chinese'."\n" + .'* en_US: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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).', + ], + 'GetDomainQuota' => [ + 'summary' => '获取domain限额', + 'path' => '/v2/domain/get_quota', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'admin', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'size_quota' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'size_used' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'user_count_quota' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'user_count_used' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => 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', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'group_id' => [ + 'type' => 'string', + 'required' => true, + ], + 'name' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + '$ref' => '#/components/schemas/BaseGroupResponse', + ], + ], + ], + 'responseDemo' => null, + ], + 'PunishFile' => [ + 'summary' => 'Penalizes files.', + 'path' => '/v2/csi/business/punish_file', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'tags' => [ + 'api', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'domain_id', + 'in' => 'host', + 'schema' => [ + 'title' => '域id', + 'type' => 'string', + 'example' => 'bj2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'pds_file_remove_punish' => 'pds_file_remove_punish', + 'pds_fileshare_forbidden' => 'pds_fileshare_forbidden', + 'pds_file_frozen' => 'pds_file_frozen', + 'pds_file_meta_frozen' => 'pds_file_meta_frozen', + 'pds_file_meta_remove_punish' => 'pds_file_meta_remove_punish', + 'pds_file_meta_share_forbidden' => 'pds_file_meta_share_forbidden', + ], + 'example' => 'pds_file_meta_frozen', + ], + 'punish_reason' => [ + 'title' => '处罚原因', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'illegal', + ], + ], + 'required' => false, + 'title' => '请求体', + ], + ], + ], + 'responses' => [ + 204 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PunishFile', + ], + ], + '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', + ], + ], +]; |