diff options
Diffstat (limited to 'data/en_us/oss')
| -rw-r--r-- | data/en_us/oss/2019-05-17/api-docs.php | 23552 |
1 files changed, 23552 insertions, 0 deletions
diff --git a/data/en_us/oss/2019-05-17/api-docs.php b/data/en_us/oss/2019-05-17/api-docs.php new file mode 100644 index 0000000..28ed7da --- /dev/null +++ b/data/en_us/oss/2019-05-17/api-docs.php @@ -0,0 +1,23552 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'OSS', + 'product' => 'Oss', + 'version' => '2019-05-17', + ], + 'directories' => [ + [ + 'id' => 146111, + 'title' => 'Service operations', + 'type' => 'directory', + 'children' => [ + 'ListBuckets', + ], + ], + [ + 'id' => 146109, + 'title' => 'Region operations', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 146114, + 'title' => 'Bucket operations', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 146115, + 'title' => 'Basic operations', + 'type' => 'directory', + 'children' => [ + 'GetBucketStat', + 'PutBucket', + 'DeleteBucket', + 'ListObjects', + 'ListObjectsV2', + 'GetBucketInfo', + 'GetBucketLocation', + ], + ], + [ + 'id' => 184274, + 'title' => 'Access Point', + 'type' => 'directory', + 'children' => [ + 'ListAccessPoints', + 'GetAccessPoint', + 'GetAccessPointPolicy', + 'DeleteAccessPointPolicy', + 'PutAccessPointPolicy', + 'DeleteAccessPoint', + 'CreateAccessPoint', + ], + ], + [ + 'id' => 146122, + 'title' => 'Retention policy', + 'type' => 'directory', + 'children' => [ + 'InitiateBucketWorm', + 'AbortBucketWorm', + 'CompleteBucketWorm', + 'ExtendBucketWorm', + 'GetBucketWorm', + ], + ], + [ + 'id' => 146128, + 'title' => 'ACL', + 'type' => 'directory', + 'children' => [ + 'PutBucketAcl', + 'GetBucketAcl', + ], + ], + [ + 'id' => 146131, + 'title' => 'Lifecycle', + 'type' => 'directory', + 'children' => [ + 'PutBucketLifecycle', + 'GetBucketLifecycle', + 'DeleteBucketLifecycle', + ], + ], + [ + 'id' => 146135, + 'title' => 'Transfer acceleration', + 'type' => 'directory', + 'children' => [ + 'PutBucketTransferAcceleration', + 'GetBucketTransferAcceleration', + ], + ], + [ + 'id' => 146138, + 'title' => 'Versioning', + 'type' => 'directory', + 'children' => [ + 'PutBucketVersioning', + 'GetBucketVersioning', + 'ListObjectVersions', + ], + ], + [ + 'id' => 146148, + 'title' => 'Authorization Policy', + 'type' => 'directory', + 'children' => [ + 'PutBucketPolicy', + 'GetBucketPolicy', + 'DeleteBucketPolicy', + 'GetBucketPolicyStatus', + ], + ], + [ + 'id' => 146142, + 'title' => 'Replication', + 'type' => 'directory', + 'children' => [ + 'PutBucketRtc', + 'PutBucketReplication', + 'GetBucketReplication', + 'GetBucketReplicationLocation', + 'GetBucketReplicationProgress', + 'DeleteBucketReplication', + ], + ], + [ + 'id' => 146152, + 'title' => 'Inventory', + 'type' => 'directory', + 'children' => [ + 'PutBucketInventory', + 'GetBucketInventory', + 'ListBucketInventory', + 'DeleteBucketInventory', + ], + ], + [ + 'id' => 146157, + 'title' => 'Logging', + 'type' => 'directory', + 'children' => [ + 'PutBucketLogging', + 'GetBucketLogging', + 'DeleteBucketLogging', + 'PutUserDefinedLogFieldsConfig', + 'GetUserDefinedLogFieldsConfig', + 'DeleteUserDefinedLogFieldsConfig', + ], + ], + [ + 'id' => 146161, + 'title' => 'Static websites', + 'type' => 'directory', + 'children' => [ + 'GetBucketWebsite', + 'PutBucketWebsite', + 'DeleteBucketWebsite', + ], + ], + [ + 'id' => 146165, + 'title' => 'Hotlink protection', + 'type' => 'directory', + 'children' => [ + 'PutBucketReferer', + 'GetBucketReferer', + ], + ], + [ + 'id' => 146168, + 'title' => 'Tagging', + 'type' => 'directory', + 'children' => [ + 'PutBucketTags', + 'GetBucketTags', + 'DeleteBucketTags', + ], + ], + [ + 'id' => 191780, + 'title' => 'Redundancy type transition', + 'type' => 'directory', + 'children' => [ + 'ListUserDataRedundancyTransition', + 'ListBucketDataRedundancyTransition', + 'GetBucketDataRedundancyTransition', + 'CreateBucketDataRedundancyTransition', + 'DeleteBucketDataRedundancyTransition', + ], + ], + [ + 'id' => 146172, + 'title' => 'Encryption', + 'type' => 'directory', + 'children' => [ + 'PutBucketEncryption', + 'GetBucketEncryption', + 'DeleteBucketEncryption', + ], + ], + [ + 'id' => 146176, + 'title' => 'Pay-by-requester', + 'type' => 'directory', + 'children' => [ + 'PutBucketRequestPayment', + 'GetBucketRequestPayment', + ], + ], + [ + 'id' => 146179, + 'title' => 'CORS', + 'type' => 'directory', + 'children' => [ + 'PutBucketCors', + 'GetBucketCors', + 'DeleteBucketCors', + 'OptionObject', + ], + ], + [ + 'id' => 184334, + 'title' => 'AccessMonitor', + 'type' => 'directory', + 'children' => [ + 'PutBucketAccessMonitor', + 'GetBucketAccessMonitor', + ], + ], + [ + 'id' => 184337, + 'title' => 'MetaQuery', + 'type' => 'directory', + 'children' => [ + 'GetMetaQueryStatus', + 'CloseMetaQuery', + 'DoMetaQuery', + 'OpenMetaQuery', + ], + ], + [ + 'id' => 184342, + 'title' => 'AntiDDos', + 'type' => 'directory', + 'children' => [ + 'UpdateUserAntiDDosInfo', + 'UpdateBucketAntiDDosInfo', + 'ListBucketAntiDDosInfo', + 'InitUserAntiDDosInfo', + 'InitBucketAntiDDosInfo', + 'GetUserAntiDDosInfo', + ], + ], + [ + 'id' => 184349, + 'title' => 'Resource Group', + 'type' => 'directory', + 'children' => [ + 'GetBucketResourceGroup', + 'PutBucketResourceGroup', + ], + ], + [ + 'id' => 184352, + 'title' => 'Cname', + 'type' => 'directory', + 'children' => [ + 'PutCname', + 'ListCname', + 'DeleteCname', + 'GetCnameToken', + 'CreateCnameToken', + ], + ], + [ + 'id' => 184358, + 'title' => 'Image Style', + 'type' => 'directory', + 'children' => [ + 'PutStyle', + 'ListStyle', + 'GetStyle', + 'DeleteStyle', + ], + ], + [ + 'id' => 186871, + 'title' => 'Transport Layer Security (TLS)', + 'type' => 'directory', + 'children' => [ + 'GetBucketHttpsConfig', + 'PutBucketHttpsConfig', + ], + ], + [ + 'id' => 191785, + 'title' => 'Object FC Access Points', + 'type' => 'directory', + 'children' => [ + 'CreateAccessPointForObjectProcess', + 'GetAccessPointForObjectProcess', + 'ListAccessPointsForObjectProcess', + 'DeleteAccessPointForObjectProcess', + 'GetAccessPointConfigForObjectProcess', + 'PutAccessPointConfigForObjectProcess', + 'PutAccessPointPolicyForObjectProcess', + 'GetAccessPointPolicyForObjectProcess', + 'DeleteAccessPointPolicyForObjectProcess', + ], + ], + [ + 'id' => 191709, + 'title' => 'Block public access', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 191710, + 'title' => 'Manage Block Public Access for OSS resources', + 'type' => 'directory', + 'children' => [ + 'GetPublicAccessBlock', + 'PutPublicAccessBlock', + 'DeletePublicAccessBlock', + ], + ], + [ + 'id' => 191714, + 'title' => 'Manage Block Public Access for a bucket', + 'type' => 'directory', + 'children' => [ + 'GetBucketPublicAccessBlock', + 'PutBucketPublicAccessBlock', + 'DeleteBucketPublicAccessBlock', + ], + ], + [ + 'id' => 191718, + 'title' => 'Manage Block Public Access for an access point', + 'type' => 'directory', + 'children' => [ + 'GetAccessPointPublicAccessBlock', + 'PutAccessPointPublicAccessBlock', + 'DeleteAccessPointPublicAccessBlock', + ], + ], + ], + ], + [ + 'id' => 191795, + 'title' => 'Real-time access of Archive objects', + 'type' => 'directory', + 'children' => [ + 'GetBucketArchiveDirectRead', + 'PutBucketArchiveDirectRead', + ], + ], + [ + 'id' => 348763, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'PutBucketOverwriteConfig', + 'GetBucketOverwriteConfig', + 'DeleteBucketOverwriteConfig', + ], + ], + ], + ], + [ + 'id' => 146184, + 'title' => 'Object operations', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 146185, + 'title' => 'Basic operations', + 'type' => 'directory', + 'children' => [ + 'PutObject', + 'CopyObject', + 'GetObject', + 'AppendObject', + 'SealAppendObject', + 'DeleteObject', + 'HeadObject', + 'GetObjectMeta', + 'RestoreObject', + 'CleanRestoredObject', + 'SelectObject', + 'CreateSelectObjectMeta', + ], + ], + [ + 'id' => 146198, + 'title' => 'Multipart upload', + 'type' => 'directory', + 'children' => [ + 'InitiateMultipartUpload', + 'UploadPart', + 'CompleteMultipartUpload', + 'UploadPartCopy', + 'AbortMultipartUpload', + 'ListMultipartUploads', + 'ListParts', + ], + ], + [ + 'id' => 146206, + 'title' => 'ACL', + 'type' => 'directory', + 'children' => [ + 'PutObjectAcl', + 'GetObjectAcl', + ], + ], + [ + 'id' => 146209, + 'title' => 'Symbolic link', + 'type' => 'directory', + 'children' => [ + 'PutSymlink', + 'GetSymlink', + ], + ], + [ + 'id' => 146212, + 'title' => 'Tagging', + 'type' => 'directory', + 'children' => [ + 'PutObjectTagging', + 'GetObjectTagging', + 'DeleteObjectTagging', + ], + ], + ], + ], + [ + 'id' => 146216, + 'title' => 'LiveChannel-related operations', + 'type' => 'directory', + 'children' => [ + 'PutLiveChannel', + 'ListLiveChannel', + 'DeleteLiveChannel', + 'PutLiveChannelStatus', + 'GetLiveChannelInfo', + 'GetLiveChannelHistory', + 'GetLiveChannelStat', + 'GetVodPlaylist', + 'PostVodPlaylist', + ], + ], + [ + 'id' => 203693, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'PutChannel', + 'PutBucketHash', + 'PutBucketCommonHeader', + 'DeleteBucketCommonHeader', + 'PutProcessConfiguration', + 'GetBucketEventNotification', + 'PutDataLakeCachePrefetchJob', + 'StartDataLakeCachePrefetchJob', + 'ListDataLakeStorageTransferJob', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AccessControlList' => [ + 'title' => 'A list of grants that control access to the staged results', + 'description' => 'The container that stores the access control list (ACL) information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Grant' => [ + 'description' => 'The ACL of the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* private'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* public-read'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* public-read-write'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [ + 'private' => 'private', + 'public-read' => 'public-read', + 'public-read-write' => 'public-read-write', + ], + 'example' => 'public-read', + '$ref' => '#/components/schemas/Grant', + ], + ], + ], + 'AccessControlPolicy' => [ + 'title' => 'Contains the elements that set the ACL permissions for an object', + 'description' => 'The container that stores the results of the GetObjectACL request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The container that stores information about the bucket owner.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Owner', + ], + 'AccessControlList' => [ + 'description' => 'The container that stores the access control list (ACL) information.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessControlList', + ], + ], + ], + 'AccessMonitorConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The access tracking configurations of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The access tracking status of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessMonitorStatus', + ], + ], + ], + 'AccessMonitorStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'The access tracking status of the bucket. Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + .'* Disabled'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Disabled', + ], + ], + 'AccessPoint' => [ + 'title' => '', + 'description' => 'The container that stores the information about an access point.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => 'The name of the bucket for which the access point is configured.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-example', + ], + 'AccessPointName' => [ + 'title' => '', + 'description' => 'The name of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointName', + ], + 'Alias' => [ + 'title' => '', + 'description' => 'The alias of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointAlias', + ], + 'NetworkOrigin' => [ + 'description' => 'The network origin of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointNetworkOrigin', + ], + 'VpcConfiguration' => [ + 'description' => 'The container that stores the information about the VPC.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointVpcConfiguration', + ], + 'Status' => [ + 'description' => 'The status of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointStatus', + ], + ], + ], + 'AccessPointAlias' => [ + 'title' => '', + 'description' => 'The alias of the access point.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ap-01-45ee7945007a2f0bcb595f63e2215c****-ossalias', + ], + 'AccessPointArn' => [ + 'title' => '', + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access point.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'arn:acs:oss:ap-southeast-2:111933544165****:accesspoint/ap-01', + ], + 'AccessPointName' => [ + 'title' => '', + 'description' => 'The name of the access point.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ap-01', + ], + 'AccessPointNetworkOrigin' => [ + 'title' => '', + 'description' => 'The network origin of the access point. Valid values: vpc and internet. vpc: You can only use the specified VPC ID to access the access point. internet: You can use public endpoints and internal endpoints to access the access point.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vpc', + ], + 'AccessPointStatus' => [ + 'title' => '', + 'description' => 'The status of the access point.'."\n" + ."\n" + .'* enable: The access point is created.'."\n" + .'* disable: The access point is disabled.'."\n" + .'* creating: The access point is being created.'."\n" + .'* deleting: The access point is deleted.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'enable', + ], + 'AccessPointVpcConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the information about the VPC.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => '', + 'description' => 'The ID of the VPC that is required only when the NetworkOrigin parameter is set to vpc.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vpc-t4nlw426y44rd3iq4****', + ], + ], + 'parseType' => 'struct', + ], + 'ApplyServerSideEncryptionByDefault' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the default server-side encryption method.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SSEAlgorithm' => [ + 'title' => 'description', + 'description' => 'The default server-side encryption method. Valid values: KMS, AES256, and SM4. You are charged when you call API operations to encrypt or decrypt data by using CMKs managed by KMS. For more information, see [Billing of KMS](~~52608~~). If the default server-side encryption method is configured for the destination bucket and ReplicaCMKID is configured in the CRR rule:'."\n" + ."\n" + .'* If objects in the source bucket are not encrypted, they are encrypted by using the default encryption method of the destination bucket after they are replicated.'."\n" + .'* If objects in the source bucket are encrypted by using SSE-KMS or SSE-OSS, they are encrypted by using the same method after they are replicated.'."\n" + ."\n" + .'For more information, see [Use data replication with server-side encryption](~~177216~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AES256', + ], + 'KMSMasterKeyID' => [ + 'title' => 'description', + 'description' => 'The CMK ID that is specified when SSEAlgorithm is set to KMS and a specified CMK is used for encryption. In other cases, leave this parameter empty.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + ], + 'KMSDataEncryption' => [ + 'title' => 'description', + 'description' => 'The algorithm that is used to encrypt objects. If this parameter is not specified, objects are encrypted by using AES256. This parameter is valid only when SSEAlgorithm is set to KMS. Valid value: SM4.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'SM4', + ], + ], + ], + 'ArchiveDirectReadConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the configurations for real-time access of Archive objects.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '', + 'description' => 'Specifies whether to enable real-time access of Archive objects for a bucket. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Bucket' => [ + 'title' => 'The container used to store objects in OSS', + 'description' => 'The container that stores the information about the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CreationDate' => [ + 'title' => 'The time when the bucket is created.', + 'description' => 'The time when the bucket was created. Format: `yyyy-mm-ddThh:mm:ss.timezone`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2014-05-15T11:18:32.000Z', + ], + 'ExtranetEndpoint' => [ + 'title' => 'The public endpoint used to access the bucket over the Internet.', + 'description' => 'The public endpoint of the region in which the bucket resides.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + 'IntranetEndpoint' => [ + 'title' => 'The internal endpoint used to access the bucket from ECS instances in the same region.', + 'description' => 'The internal endpoint of the region in which the bucket you access from ECS instances resides. The bucket and ECS instances are in the same region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'Location' => [ + 'title' => 'The data center in which the bucket is located.', + 'description' => 'The data center in which the bucket is located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Name' => [ + 'title' => 'The name of the bucket.', + 'description' => 'The name of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'mybucket01', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class of the bucket. Valid values: Standard, IA, Archive, and ColdArchive.'."\n", + 'visibility' => 'public', + 'example' => 'Standard', + '$ref' => '#/components/schemas/StorageClass', + ], + 'Region' => [ + 'title' => 'The physical location of the bucket.', + 'description' => 'The region in which the bucket is located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'example' => 'examplebucket', + ], + 'BucketACL' => [ + 'title' => 'The access control list (ACL) for a bucket.', + 'description' => 'The access control list (ACL) of the bucket. Valid values:'."\n" + ."\n" + .'* public-read-write'."\n" + .'* public-read'."\n" + .'* private (default)'."\n" + ."\n" + .'For more information, see [Bucket ACLs](https://help.aliyun.com/zh/oss/user-guide/bucket-acl-1).', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'private', + 'default' => 'private', + 'enum' => [ + 'private', + 'public-read', + 'public-read-write', + ], + ], + 'BucketAntiDDOSConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the configurations of the Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Cnames' => [ + 'title' => '', + 'description' => 'The container that stores the list of domain names.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '', + 'description' => 'The custom domain names that you want to protect.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom domain name that you want to protect. You can add up to five custom domain names for each bucket to the protection list of an Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc1.example.cn', + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'BucketAntiDDOSInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores information about the Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '', + 'description' => 'The ID of the Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', + ], + 'Owner' => [ + 'title' => '', + 'description' => 'The ID of the bucket owner.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '114893010724****', + ], + 'Bucket' => [ + 'title' => '', + 'description' => 'The name of the bucket for which the Anti-DDoS instance is created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'examplebucket', + ], + 'Ctime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was created. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769503', + ], + 'Mtime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was last updated. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769840', + ], + 'ActiveTime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was activated. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769845', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the Anti-DDoS instance. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Defending'."\n" + .'* HaltDefending'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Defending', + ], + 'Type' => [ + 'title' => '', + 'description' => 'The type of the Anti-DDoS instance. Valid value: AntiDDosPremimum.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AntiDDosPremimum', + ], + 'Cnames' => [ + 'title' => '', + 'description' => 'The container that stores the custom domain names.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '', + 'description' => 'The custom domain names.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom domain name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc1.example.cn', + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'BucketChannelConfig' => [ + 'title' => '', + 'description' => 'Bucket image process channel configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'version' => [ + 'title' => '', + 'description' => 'Channel version.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DebugInfo' => [ + 'title' => '', + 'description' => 'Debug information for the channel.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'testinfo', + ], + 'RuleList' => [ + 'title' => '', + 'description' => 'Process rule list.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => '', + 'description' => 'The content of the process rule.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'title' => '', + 'description' => 'Channel rule name.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rule1', + ], + 'RuleRegex' => [ + 'title' => '', + 'description' => 'Channel rule regex.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '\\\\.webp$', + ], + 'FrontContent' => [ + 'title' => '', + 'description' => 'Channel rule front content.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a', + ], + ], + 'extendType' => 'true', + 'description' => 'The description for a channel rule.', + ], + ], + ], + ], + ], + ], + 'BucketCnameConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the CNAME record.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Cname' => [ + 'title' => '', + 'description' => 'The container that stores the CNAME information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '', + 'description' => 'The custom domain name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example.com', + ], + 'CertificateConfiguration' => [ + 'title' => '保存证书配置信息的容器', + 'description' => 'The container for which the certificate is configured.', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/CertificateConfiguration', + ], + ], + ], + ], + ], + 'BucketDataRedundancyTransition' => [ + 'title' => '', + 'description' => 'Details of the redundancy type conversion task.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => 'Name of the bucket.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'TaskId' => [ + 'title' => '', + 'description' => 'ID of the redundancy type conversion task.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '751f5243f8ac4ae89f34726534d1****', + ], + 'Status' => [ + 'title' => '', + 'description' => 'Status of the redundancy type conversion task. Valid values:'."\n" + ."\n" + .'* Queueing'."\n" + .'* Processing'."\n" + .'* Finished'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Queueing', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'Time when the redundancy type conversion task was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-11-17T09:14:39.000Z', + ], + 'StartTime' => [ + 'title' => '', + 'description' => 'Time when the redundancy type conversion task started.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-11-17T09:14:39.000Z', + ], + 'EndTime' => [ + 'title' => '', + 'description' => 'Time when the redundancy type conversion task was complete.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-11-17T09:14:39.000Z', + ], + 'ProcessPercentage' => [ + 'title' => '', + 'description' => 'Progress of the redundancy type conversion task in percentage. Value values: 0 to 100.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '88', + ], + 'EstimatedRemainingTime' => [ + 'title' => '', + 'description' => 'Estimated remaining time of the redundancy type conversion task. Unit: hour.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'BucketInfo' => [ + 'title' => '', + 'description' => 'The container that stores the information about the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => 'The container that stores the bucket information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AccessMonitor' => [ + 'title' => '', + 'description' => 'Indicates whether access tracking is enabled for the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Disabled', + ], + 'CreationDate' => [ + 'title' => '', + 'description' => 'The time when the bucket is created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-01-06T08:20:09.000Z', + ], + 'CrossRegionReplication' => [ + 'title' => '', + 'description' => 'Indicates whether cross-region replication (CRR) is enabled for the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Disabled', + ], + 'DataRedundancyType' => [ + 'description' => 'The redundancy type of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/DataRedundancyType', + ], + 'ExtranetEndpoint' => [ + 'title' => '', + 'description' => 'The public endpoint of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Endpoint', + ], + 'IntranetEndpoint' => [ + 'title' => '', + 'description' => 'The internal endpoint of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Endpoint', + ], + 'Location' => [ + 'title' => '', + 'description' => 'The region in which the bucket is located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'Name' => [ + 'title' => '', + 'description' => 'The name of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'ResourceGroupId' => [ + 'title' => '', + 'description' => 'The ID of the resource group to which the bucket belongs.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ResourceGroupId', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/StorageClass', + ], + 'TransferAcceleration' => [ + 'title' => '', + 'description' => 'Indicates whether transfer acceleration is enabled for the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Disabled', + ], + 'Versioning' => [ + 'title' => '', + 'description' => 'The versioning status of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/BucketVersioningStatus', + ], + 'Owner' => [ + 'title' => '', + 'description' => 'The owner of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Owner', + ], + 'AccessControlList' => [ + 'title' => '', + 'description' => 'The ACL of the bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessControlList', + ], + 'ServerSideEncryptionRule' => [ + 'title' => '', + 'description' => 'The server-side encryption configurations of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SSEAlgorithm' => [ + 'title' => '', + 'description' => 'The default server-side encryption method.'."\n" + ."\n" + .'Valid values: KMS, AES-256, and SM4.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'None', + ], + 'KMSMasterKeyID' => [ + 'title' => '', + 'description' => 'The key that is managed by Key Management Service (KMS).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '****', + ], + 'KMSDataEncryption' => [ + 'title' => '', + 'description' => 'The algorithm that is used to encrypt objects. If you do not configure this parameter, objects are encrypted by using AES-256. This parameter is valid only when SSEAlgorithm is set to KMS.'."\n" + ."\n" + .'Valid value: SM4.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SM4', + ], + ], + ], + 'BucketPolicy' => [ + 'title' => '', + 'description' => 'The log configurations of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'LogBucket' => [ + 'title' => '存储日志记录的Bucket名称。', + 'description' => 'The name of the bucket used to store access logs.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'LogPrefix' => [ + 'title' => '存储日志文件的目录。', + 'description' => 'The directory used to store access logs.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'log/', + ], + ], + ], + 'Comment' => [ + 'title' => 'Bucket描述信息。', + 'description' => 'Bucket description.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'An example bucket.', + ], + 'BlockPublicAccess' => [ + 'title' => 'Bucket是否开启阻止公共访问', + 'description' => 'Whether the bucket has been configured to block public access.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'parseType' => 'struct', + ], + 'BucketLoggingStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the logging status information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'LoggingEnabled' => [ + 'description' => 'The container that stores the access log information.'."\n", + 'visibility' => 'public', + 'required' => true, + '$ref' => '#/components/schemas/LoggingEnabled', + ], + ], + ], + 'BucketProcessConfiguration' => [ + 'title' => '', + 'description' => 'Bucket image processing configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CompliedHost' => [ + 'title' => '', + 'description' => 'Access host used for image processing.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Img', + ], + 'OssDomainSupportAtProcess' => [ + 'title' => '', + 'description' => 'Whether to support access image processing with OSS domain.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'disabled', + ], + 'SourceFileProtect' => [ + 'title' => '', + 'description' => 'Whether to protect images from being used by unauthorized anonymous requesters.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'disabled', + ], + 'SourceFileProtectSuffix' => [ + 'title' => '', + 'description' => 'Suffix of the source file to be protected.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'gif', + ], + 'BucketChannelConfig' => [ + 'title' => '', + 'description' => 'Image processing channel configuration.', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/BucketChannelConfig', + ], + 'StyleDelimiters' => [ + 'title' => '', + 'description' => 'Delimiters used for image styles.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '-,|', + ], + ], + ], + 'BucketQoSConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TotalUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IntranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExtranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IntranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ExtranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'IntranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ExtranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'Exclusive' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'BucketResourceGroupConfiguration' => [ + 'title' => '', + 'description' => 'The configurations of the resource group to which the bucket belongs.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'title' => '', + 'description' => 'The ID of the resource group to which the bucket belongs.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ResourceGroupId', + ], + ], + ], + 'BucketStat' => [ + 'title' => '', + 'description' => 'The container that stores all information returned for the GetBucketStat request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Storage' => [ + 'title' => '', + 'description' => 'The storage usage of the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '39182324', + ], + 'ObjectCount' => [ + 'title' => '', + 'description' => 'The total number of objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2034903', + ], + 'MultipartUploadCount' => [ + 'title' => '', + 'description' => 'The number of multipart upload tasks that have been initiated but are not completed or canceled.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223', + ], + 'LiveChannelCount' => [ + 'title' => '', + 'description' => 'The number of LiveChannels in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'MultipartPartCount' => [ + 'title' => 'Bucket中上传的Multipart分片的数量。', + 'description' => 'The number of mulitpart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'DeleteMarkerCount' => [ + 'title' => 'Bucket中删除标记的数量。', + 'description' => 'The number of deletemarker in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'LastModifiedTime' => [ + 'title' => '', + 'description' => 'The time when the obtained information was last modified. The value of this parameter is a UNIX timestamp. Unit: seconds.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1643341269', + ], + 'StandardStorage' => [ + 'title' => '', + 'description' => 'The storage usage of Standard objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600', + ], + 'StandardObjectCount' => [ + 'title' => '', + 'description' => 'The number of Standard objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12323', + ], + 'InfrequentAccessStorage' => [ + 'title' => '', + 'description' => 'The billed storage usage of IA objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1250', + ], + 'InfrequentAccessRealStorage' => [ + 'title' => '', + 'description' => 'The actual storage usage of IA objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65754', + ], + 'InfrequentAccessObjectCount' => [ + 'title' => '', + 'description' => 'The number of IA objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '23', + ], + 'ArchiveStorage' => [ + 'title' => '', + 'description' => 'The billed storage usage of Archive objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30423', + ], + 'ArchiveRealStorage' => [ + 'title' => '', + 'description' => 'The actual storage usage of Archive objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5990', + ], + 'ArchiveObjectCount' => [ + 'title' => '', + 'description' => 'The number of Archive objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'ColdArchiveStorage' => [ + 'title' => '', + 'description' => 'The billed storage usage of Cold Archive objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '342', + ], + 'ColdArchiveRealStorage' => [ + 'title' => '', + 'description' => 'The actual storage usage of Cold Archive objects in the bucket. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2312', + ], + 'ColdArchiveObjectCount' => [ + 'title' => '', + 'description' => 'The number of Cold Archive objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '230', + ], + 'DeepColdArchiveStorage' => [ + 'title' => '深度冷归档存储类型的计费存储量，单位字节。', + 'description' => 'The billed storage usage of Deep Cold Archive objects in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'DeepColdArchiveRealStorage' => [ + 'title' => '深度冷归档存储类型的实际存储量，单位字节。', + 'description' => 'The actual storage usage of Deep Cold Archive objects in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'DeepColdArchiveObjectCount' => [ + 'title' => '深度冷归档存储类型的Object数量。', + 'description' => 'The number of Deep Cold Archive objects in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MultipartPartStorage' => [ + 'title' => 'Bucket中Multipart分片的存储量', + 'description' => 'The storage usage of Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + 'StandardMultipartPartCount' => [ + 'title' => 'Bucket中标准类型的Multipart分片的数量', + 'description' => 'The number of Standard Multipart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'StandardMultipartPartStorage' => [ + 'title' => 'Bucket中标准类型的Multipart分片的存储量', + 'description' => 'The storage usage of Standard Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + 'InfrequentMultipartPartCount' => [ + 'title' => 'Bucket中低频类型的Multipart分片的数量', + 'description' => 'The number of IA Multipart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'InfrequentMultipartPartStorage' => [ + 'title' => 'Bucket中低频类型的Multipart分片的存储量', + 'description' => 'The storage usage of IA Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + 'ArchiveMultipartPartCount' => [ + 'title' => 'Bucket中归档类型的Multipart分片的数量', + 'description' => 'The number of Archive Multipart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '56', + ], + 'ArchiveMultipartPartStorage' => [ + 'title' => 'Bucket中归档类型的Multipart分片的存储量', + 'description' => 'The storage usage of Archive Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + 'ColdArchiveMultipartPartCount' => [ + 'title' => 'Bucket中冷归档类型的Multipart分片的数量', + 'description' => 'The number of Cold Archive Multipart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '110', + ], + 'ColdArchiveMultipartPartStorage' => [ + 'title' => 'Bucket中冷归档类型的Multipart分片的存储量', + 'description' => 'The storage usage of Cold Archive Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + 'DeepColdArchiveMultipartPartCount' => [ + 'title' => 'Bucket中深度冷归档类型的Multipart分片的数量', + 'description' => 'The number of Deep Cold Archive Multipart parts in the bucket.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '110', + ], + 'DeepColdArchiveMultipartPartStorage' => [ + 'title' => 'Bucket中深度冷归档类型的Multipart分片的存储量', + 'description' => 'The storage usage of Deep Cold Archive Multipart parts in the bucket. Unit: bytes.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '481200', + ], + ], + ], + 'BucketVersioningStatus' => [ + 'description' => 'The versioning status of the bucket. Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + .'* Suspended'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Enabled', + 'enum' => [ + 'Enabled', + 'Suspended', + ], + ], + 'BucketWormState' => [ + 'title' => 'The status of the retention policy', + 'description' => 'The state of the retention policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* InProgress: indicates that the retention policy is in the InProgress state. By default, a retention policy is in the InProgress state after it is created. The policy remains in this state for 24 hours.'."\n" + .'* Locked: indicates that the retention policy is in the Locked state.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Locked', + 'enum' => [ + 'InProgress', + 'Locked', + ], + ], + 'CallbackPolicy' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'PolicyItem' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'first', + ], + 'Callback' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'e1wiY2Fsb...9keVwiOlwiYnVja2V0PSR7YnU=', + ], + 'CallbackVar' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Q2Fs...FcIiwgXCJ4OmJcIjpcImJcIn0=', + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + 'CertificateConfiguration' => [ + 'title' => '', + 'description' => 'The container for which the certificate is configured.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CertId' => [ + 'title' => '', + 'description' => 'The ID of the certificate.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '493****-cn-hangzhou', + ], + 'Certificate' => [ + 'title' => '', + 'description' => 'The public key of the certificate.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----', + ], + 'PrivateKey' => [ + 'title' => '', + 'description' => 'The private key of the certificate.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----', + ], + 'PreviousCertId' => [ + 'title' => '', + 'description' => 'The ID of the certificate. If the Force parameter is not set to true, the OSS server checks whether the value of the Force parameter matches the current certificate ID. If the value does not match the certificate ID, an error is returned.'."\n" + .'<notice>If you do not specify the PreviousCertId parameter when you bind a certificate, you must set the Force parameter to true.</notice>', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '493****-cn-hangzhou', + ], + 'Force' => [ + 'title' => '', + 'description' => 'Specifies whether to overwrite the certificate. Valid values:'."\n" + .'- true: overwrites the certificate.'."\n" + .'- false: does not overwrite the certificate.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeleteCertificate' => [ + 'title' => '', + 'description' => 'Specifies whether to delete the certificate. Valid values:'."\n" + .'- true: deletes the certificate.'."\n" + .'- false: does not delete the certificate.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Channel' => [ + 'title' => '', + 'description' => 'Image process channel configuration', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => 'Status of the image process channel', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'enable', + ], + 'OrigPicForbidden' => [ + 'title' => '', + 'description' => 'Whether to prohibit access to the original image.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UseStyleOnly' => [ + 'title' => '', + 'description' => 'Can only process images with styles.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoSetContentType' => [ + 'title' => '', + 'description' => 'Whether to automatically set content-type.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UseSrcFormat' => [ + 'title' => '', + 'description' => 'Whether to use source file format.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SetAttachName' => [ + 'title' => '', + 'description' => 'Whether to set attach name.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Default404Pic' => [ + 'title' => '', + 'description' => 'Default picture file for 404 status code.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '404.jpg', + ], + 'StyleDelimiters' => [ + 'title' => '', + 'description' => 'Delimiters used for image style.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '-,|', + ], + ], + ], + 'CnameCertificate' => [ + 'title' => '', + 'description' => 'The information about the certificate.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The source of the certificate.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CAS'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Upload'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'CAS' => '', + 'Upload' => '', + ], + 'example' => 'CAS', + ], + 'CertId' => [ + 'title' => '', + 'description' => 'The ID of the certificate.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '493****-cn-hangzhou', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the certificate.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '', + 'Disabled' => '', + ], + 'example' => 'Enabled', + ], + 'CreationDate' => [ + 'title' => '', + 'description' => 'The time when the certificate was bound.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Wed, 15 Sep 2021 02:35:06 GMT', + ], + 'Fingerprint' => [ + 'title' => '', + 'description' => 'The signature of the certificate.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'DE:01:CF:EC:7C:A7:98:CB:D8:6E:FB:1D:97:EB:A9:64:1D:4E:**:**', + ], + 'ValidStartDate' => [ + 'title' => '', + 'description' => 'The time when the certificate takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Wed, 12 Apr 2023 10:14:51 GMT', + ], + 'ValidEndDate' => [ + 'title' => '', + 'description' => 'The time when the certificate expires.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Mon, 4 May 2048 10:14:51 GMT', + ], + ], + ], + 'CnameInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the CNAME records.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '', + 'description' => 'The custom domain name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example.com', + ], + 'LastModified' => [ + 'title' => '', + 'description' => 'The time when the custom domain name was mapped.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-09-15T02:35:07.000Z', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the domain name. Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + .'* Disabled'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'Certificate' => [ + 'description' => 'The container in which the certificate information is stored.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/CnameCertificate', + ], + ], + ], + 'CnameSummary' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information about all CNAME records.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'title' => '', + 'description' => 'The custom domain name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example.com', + ], + 'LastModified' => [ + 'title' => '', + 'description' => 'The time when the custom domain name was mapped.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-09-15T02:35:07.000Z', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the domain name.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Enabled' => '', + 'Disabled' => '', + ], + 'example' => 'Enabled', + ], + 'Certificate' => [ + 'description' => 'The container that stores the certificate information.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/CnameCertificate', + ], + ], + ], + 'CnameToken' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the CNAME token.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => 'The name of the bucket to which the CNAME record is mapped.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'examplebucket', + ], + 'Cname' => [ + 'title' => '', + 'description' => 'The name of the CNAME record that is mapped to the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Token' => [ + 'title' => '', + 'description' => 'The CNAME token that is returned by OSS.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'be1d49d863dea9ffeff3df7d6455****', + ], + 'ExpireTime' => [ + 'title' => '', + 'description' => 'The time when the CNAME token expires.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Wed, 23 Feb 2022 21:16:37 GMT', + ], + ], + ], + 'CommonHeaders' => [ + 'title' => '', + 'description' => 'The response headers configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Header' => [ + 'title' => '', + 'description' => 'The response header list.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'A key-value pair for a response header configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '', + 'description' => 'Response header name.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'X-Content-Type-Options', + ], + 'Value' => [ + 'title' => '', + 'description' => 'Response header value.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'nosniff', + ], + ], + 'extendType' => 'true', + ], + ], + ], + 'parseType' => 'struct', + ], + 'CommonPrefix' => [ + 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result', + 'description' => 'If the delimiter parameter is specified in the request, the response contains CommonPrefixes. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'title' => 'The prefix that the names of returned objects contain', + 'description' => 'The prefix contained in the names of returned objects.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fun/', + ], + ], + 'parseType' => 'struct', + ], + 'CompleteMultipartUpload' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the content of the CompleteMultipartUpload request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Part' => [ + 'title' => 'description', + 'description' => 'The container that stores the uploaded parts.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the uploaded parts. '."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'PartNumber' => [ + 'title' => 'Part number of the part', + 'description' => 'The number of parts.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'ETag' => [ + 'title' => 'The ETag of the part.', + 'description' => 'The ETag that is generated when the object is created. ETags are used to identify the content of objects.'."\n" + ."\n" + .'If an object is created by calling the CompleteMultipartUpload operation, the ETag is not the MD5 hash of the object content but a unique value calculated based on a specific rule.'."\n" + ."\n" + .'> The ETag of an object can be used to check whether the object content changes. We recommend that you use the MD5 hash of an object rather than the ETag of the object to verify data integrity.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '3349DC700140D7F86A0784842780****', + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + 'CompressionType' => [ + 'title' => 'A short description of struct', + 'description' => 'The compression type of the object. This parameter is optional.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'None', + 'enum' => [ + 'None', + 'GZIP', + ], + ], + 'CopyObjectResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The result of the CopyObject operation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ETag' => [ + 'title' => 'description', + 'description' => 'The ETag that is generated when the object is created. ETags are used to identify the content of objects.'."\n" + ."\n" + .'* If an object is created by calling the PutObject operation, the ETag of the object is the MD5 hash of the object content.'."\n" + .'* If an object is created by using another method, the ETag is not the MD5 hash of the object content but a unique value that is calculated based on a specific rule.'."\n" + ."\n" + .'> The ETag of an object can be used to check whether the object content changes. We recommend that you use the MD5 hash of an object rather than the ETag of the object to verify data integrity. This parameter is empty by default.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => ' '."\n" + .'5B3C1A2E053D763E1B002CC607C5****', + ], + 'LastModified' => [ + 'title' => 'description', + 'description' => 'The time when the object was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT', + ], + ], + ], + 'CopyPartResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The result of the CopyObject operation.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ETag' => [ + 'title' => 'A short description of ETag', + 'description' => 'The ETag that is generated when the object is created. ETags are used to identify the content of objects. If an object is created by calling the CompleteMultipartUpload operation, the ETag is not the MD5 hash of the object content but a unique value calculated based on a specific rule.'."\n" + ."\n" + .'> The ETag of an object can be used to check whether the object content changes. We recommend that you use the MD5 hash of an object rather than the ETag of the object to verify data integrity.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '3349DC700140D7F86A0784842780****', + ], + 'LastModified' => [ + 'title' => 'A short description of LastModified', + 'description' => 'The time when the part was uploaded.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2012-02-23T07:01:34.000Z', + ], + ], + ], + 'CORSConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the cross-origin resource sharing (CORS) rules of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CORSRule' => [ + 'title' => 'description', + 'description' => 'The container that stores the CORS rules.'."\n" + ."\n" + .'Up to 10 CORS rules can be configured for a bucket. The XML message body in a request can be up to 16 KB in size.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the CORS rule.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/CORSRule', + ], + ], + 'ResponseVary' => [ + 'title' => 'description', + 'description' => 'Indicates whether the Vary: Origin header is returned. Valid values:'."\n" + ."\n" + .'* true: The Vary: Origin header is returned regardless of whether the request is a cross-origin request or whether the cross-origin request succeeds.'."\n" + .'* false (default): The Vary: Origin header is not returned.'."\n" + ."\n" + .'> This parameter is valid only when at least one CORS rule is configured.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + 'xml' => [ + 'name' => 'CORSConfiguration', + ], + ], + 'CORSRule' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the CORS rules.'."\n" + ."\n" + .'Up to 10 CORS rules can be configured for a bucket. The XML message body in a request can be up to 16 KB in size.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AllowedOrigin' => [ + 'title' => 'description', + 'description' => 'The origins from which cross-origin requests are allowed.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The origin from which cross-origin requests are allowed.'."\n" + ."\n" + .'You can use multiple elements to specify multiple allowed origins. Separate multiple elements with commas (,).'."\n" + ."\n" + .'Each rule can contain up to one asterisk (\\*) as the wildcard character. If AllowedOrigin is set to an asterisk (\\*), all cross-origin requests are allowed.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '*', + 'extendType' => 'true', + ], + ], + 'AllowedMethod' => [ + 'title' => 'description', + 'description' => 'The methods that you can use in cross-origin requests.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The method that you can use in cross-origin requests.'."\n" + ."\n" + .'Valid values: GET, PUT, DELETE, POST, and HEAD.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'GET', + 'extendType' => 'true', + ], + ], + 'AllowedHeader' => [ + 'title' => 'description', + 'description' => 'Specifies whether the headers specified by Access-Control-Request-Headers in the OPTIONS preflight request are allowed. Each header specified by Access-Control-Request-Headers must match the value of an AllowedHeader element.'."\n" + ."\n" + .'> You can use only one asterisk (\\*) as the wildcard character.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Authorization', + ], + 'ExposeHeader' => [ + 'title' => 'description', + 'description' => 'The response headers for allowed access requests from applications, such as an XMLHttpRequest object in JavaScript.'."\n" + ."\n" + .'> The asterisk (\\*) wildcard character is not supported.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The response header for allowed access requests from applications, such as an XMLHttpRequest object in JavaScript.'."\n" + ."\n" + .'> The asterisk (\\*) wildcard character is not supported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'x-oss-test', + 'extendType' => 'true', + ], + ], + 'MaxAgeSeconds' => [ + 'title' => 'description', + 'description' => 'The period of time within which the browser can cache the response to an OPTIONS preflight request for the specified resource. Unit: seconds.'."\n" + ."\n" + .'You can specify only one MaxAgeSeconds element in a CORS rule.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + 'xml' => [ + 'name' => 'CORSRule', + ], + ], + 'CreateAccessPointConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the information about an access point.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AccessPointName' => [ + 'title' => '', + 'description' => 'The name of the access point. The name of the access point must meet the following naming rules:'."\n" + ."\n" + .'* The name must be unique in a region of your Alibaba Cloud account.'."\n" + .'* The name cannot end with -ossalias.'."\n" + .'* The name can contain only lowercase letters, digits, and hyphens (-). It cannot start or end with a hyphen (-).'."\n" + .'* The name must be 3 to 19 characters in length.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ap-01', + ], + 'NetworkOrigin' => [ + 'title' => '', + 'description' => 'The network origin of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointNetworkOrigin', + ], + 'VpcConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the information about the VPC.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointVpcConfiguration', + ], + ], + ], + 'CreateAccessPointResult' => [ + 'title' => '', + 'description' => 'The container that stores the information about an access point.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AccessPointArn' => [ + 'title' => '', + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointArn', + ], + 'Alias' => [ + 'title' => '', + 'description' => 'The alias of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointAlias', + ], + ], + ], + 'CreateBucketConfiguration' => [ + 'title' => 'The configuration of a bucket.', + 'description' => 'The configurations of the bucket storage class and redundancy type.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'StorageClass' => [ + 'description' => 'The storage class of the bucket. Valid values:'."\n" + ."\n" + .'* Standard (default)'."\n" + .'* IA'."\n" + .'* Archive'."\n" + .'* ColdArchive'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/StorageClass', + ], + 'DataRedundancyType' => [ + 'description' => 'The redundancy type of the bucket.'."\n" + ."\n" + .'* LRS (default)\\'."\n" + .' LRS stores multiple copies of your data on multiple devices in the same zone. LRS ensures data durability and availability even if hardware failures occur on two devices.'."\n" + .'* ZRS\\'."\n" + .' ZRS stores multiple copies of your data across three zones in the same region. Even if a zone becomes unavailable due to unexpected events, such as power outages and fires, data can still be accessed.'."\n" + ."\n" + .'> You cannot set the redundancy type of Archive buckets to ZRS.'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/DataRedundancyType', + ], + ], + 'xml' => [ + 'name' => 'CreateBucketConfiguration', + ], + ], + 'CreateSelectMetaProcess' => [ + 'description' => 'The optional parameter that specifies the type of the object. The optional parameter contains the x-oss-process prefix.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'csv/meta', + ], + 'CSVInput' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'FileHeaderInfo' => [ + 'description' => 'The header information of the CSV object. Valid values:'."\n" + ."\n" + .'* Use: The CSV object contains header information. You can use the column names in the CSV object as the column names in the SelectObject operation.'."\n" + .'* Ignore: The CSV object contains header information. The column names in the CSV object cannot be used as the column names in the SelectObject operation.'."\n" + .'* None: The CSV object does not contain header information. This is the default value.'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [ + 'Ignore' => 'Ignore', + 'Use' => 'Use', + 'None' => 'None', + ], + 'example' => 'Use', + '$ref' => '#/components/schemas/FileHeaderInfo', + ], + 'RecordDelimiter' => [ + 'title' => 'description', + 'description' => 'Optional. A Base64-encoded line feed. Default value: \\n. The value of this parameter is up to two ANSI characters in length before encoding. For example, \\n is used to represent a line feed in Java.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '\\n', + ], + 'FieldDelimiter' => [ + 'title' => 'description', + 'description' => 'Optional. The delimiter that you want to use to separate values in the CSV object. The value of this parameter must be Base64-encoded. Default value: `,`. Before the value of this parameter is encoded, the value must be an ANSI character. For example, `,` is used to indicate a comma in Java.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => ',', + ], + 'QuoteCharacter' => [ + 'title' => 'description', + 'description' => 'Optional. A Base64-encoded quote character that you want to use in the CSV object. Default value: `\\"`. In a CSV object, line feeds and column delimiters enclosed in quotation marks are processed as normal characters. Before the value of this parameter is encoded, the value must be an ANSI character. For example, `\\"` is used to indicate a quote character in Java.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '\\”', + ], + 'CommentCharacter' => [ + 'title' => 'description', + 'description' => 'The comment character that you want to use in the CSV object. The value of this parameter must be Base64-encoded. This parameter is empty by default.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '#', + ], + 'Range' => [ + 'title' => 'description', + 'description' => 'Optional. The query range. The following formats are supported:'."\n" + ."\n" + .'> SelectMeta must be created for objects that are queried based on Range. For more information about SelectMeta, see [CreateSelectObjectMeta](~~74054~~).'."\n" + ."\n" + .'* Query by row: line-range=start-end. For example, line-range=10-20 indicates that data from row 10 to row 20 is scanned.'."\n" + .'* Query by split: split-range=start-end. For example, split-range=10-20 indicates that data from split 10 to split 20 is scanned.'."\n" + ."\n" + .'\\'."\n" + .'The start and end of the range are both inclusive. The start and end of the range use the same format as that of the range parameter in range get.\\'."\n" + .'This parameter can be used only if the object is in the CSV format or if the JSON type is LINES.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'line-range=start-end' => 'line-range=start-end', + 'split-range=start-end' => 'split-range=start-end', + ], + 'example' => 'line-range=start-end', + ], + 'AllowQuotedRecordDelimiter' => [ + 'title' => 'description', + 'description' => 'Specifies whether the CSV object can contain line feeds in quotation marks (").\\'."\n" + .'For example, if the value of a column is `"abc\\ndef"` and `\\n` is a line feed, set this parameter to true. If this parameter is set to false, you can call the SelectObject operation to specify a range in the request header to perform more efficient multipart queries.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'CSVOutput' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RecordDelimiter' => [ + 'title' => 'description', + 'description' => 'A Base64-encoded line feed. The value of this parameter is up to two ANSI characters in length before encoding. For example, `\\n` is used to represent a line feed in Java.\\'."\n" + .'Default value: `\\n`'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '\\n', + ], + 'FieldDelimiter' => [ + 'title' => 'description', + 'description' => 'The delimiter that you want to use to separate values in the CSV object. The value of this parameter must be Base64-encoded. The value of this parameter is an ANSI character before encoding. For example, a comma (`,`) is used to indicate a comma in Java.\\'."\n" + .'Default value: `,`'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => ',', + ], + ], + ], + 'DataRedundancyType' => [ + 'title' => 'The type of disaster recovery for a bucket.', + 'description' => 'The redundancy type of the bucket. Valid values:'."\n" + ."\n" + .'* LRS (default): stores multiple copies of your data on multiple devices in the same zone. LRS ensures data durability and availability even if hardware failures occur on two devices.'."\n" + .'* ZRS: stores multiple copies of your data across three zones in the same region. Even if a zone becomes unavailable due to unexpected events, such as power outages and fires, data can still be accessed.'."\n" + ."\n" + .'> You cannot set the redundancy type of Archive buckets to ZRS.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'LRS', + 'default' => 'LRS', + 'enum' => [ + 'LRS', + 'ZRS', + ], + ], + 'Delete' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the DeleteMultipleObjects request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Quiet' => [ + 'title' => 'description', + 'description' => 'Specifies whether to enable the Quiet return mode. The DeleteMultipleObjects operation provides the following return modes:'."\n" + ."\n" + .'* quiet: The response does not include a message body.'."\n" + .'* verbose (default): The response includes a message body that contains the information about all deleted objects.'."\n" + ."\n" + .'Valid values: **true** and **false** Default value: **false**'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Object' => [ + 'sdkPropertyName' => 'objects', + 'title' => 'description', + 'description' => 'The container that stores the information about an object.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The identifier of the object.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ObjectIdentifier', + ], + ], + ], + ], + 'DeletedObject' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the deleted objects.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'description', + 'description' => 'The name of the deleted object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'multipart.data', + ], + 'DeleteMarker' => [ + 'title' => 'description', + 'description' => 'Indicates whether the specified version is a delete marker. Valid values: true and false.'."\n" + ."\n" + .'> This parameter is returned only if a delete marker is created or permanently deleted. In this case, the value of this parameter is true.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'DeleteMarkerVersionId' => [ + 'title' => 'description', + 'description' => 'The version ID of the delete marker.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQMhiBgIDB3aWB0BYiIGUzYTA3YzliMzVmNzRkZGM5NjllYTVlMjYyYWEy****', + ], + 'VersionId' => [ + 'title' => 'description', + 'description' => 'The version ID of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQNRiBgIDyz.6C0BYiIGQ2NWEwNmVhNTA3ZTQ3MzM5ODliYjM1ZTdjYjA4****', + ], + ], + ], + 'DeleteMarkerEntry' => [ + 'title' => 'Information about the delete marker', + 'description' => 'The container that stores delete markers.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'The name of the object', + 'description' => 'The name of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example', + ], + 'VersionId' => [ + 'title' => 'The version ID of the object', + 'description' => 'The version ID of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****', + ], + 'IsLatest' => [ + 'title' => 'Indicates whether the version is the current version', + 'description' => 'Indicates whether the version is the current version. Valid values:'."\n" + ."\n" + .'* true: The version is the current version.'."\n" + .'* false: The version is a previous version.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'false', + ], + 'LastModified' => [ + 'title' => 'The last modified time of the object', + 'description' => 'The time when the object was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2019-04-09T07:27:28.000Z', + ], + 'Owner' => [ + 'description' => 'The container that stores the information about the bucket owner.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Owner', + ], + ], + ], + 'EncodeType' => [ + 'title' => 'specifies the encoding method to use', + 'description' => 'The encoding type of the content in the response. If the encoding-type parameter is specified in the request, the object name in the response is encoded.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'URL', + 'enum' => [ + 'url', + ], + ], + 'Endpoint' => [ + 'title' => '', + 'description' => 'The endpoint of the region in which the bucket is located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + 'Error' => [ + 'title' => 'Error responses', + 'description' => 'The error response.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => 'The error code that OSS returns to the user', + 'description' => 'The error code returned.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AccessDenied', + ], + 'Message' => [ + 'title' => 'The detailed error message provided by OSS', + 'description' => 'The error message returned.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Anonymous user has no right to access this bucket.', + ], + 'RequestId' => [ + 'title' => 'The ID that uniquely identifies a request', + 'description' => 'The request ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '654D97A16F8C26383287EAAF', + ], + 'HostId' => [ + 'title' => 'The ID of the host in the accessed OSS cluster', + 'description' => 'The domain name that is used to access OSS.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example-bucket.oss-cn-hangzhou.aliyuncs.com', + ], + ], + 'xml' => [ + 'name' => 'Error', + ], + ], + 'ErrorDocument' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the default 404 page.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'description', + 'description' => 'The error page.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'error.html', + ], + 'HttpStatus' => [ + 'title' => 'description', + 'description' => 'The HTTP status code returned with the error page.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'int64', + 'example' => '404', + ], + ], + ], + 'EventNotificationConfiguration' => [ + 'title' => '', + 'description' => 'The event notification configuration for a bucket.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FunctionComputeConfiguration' => [ + 'title' => '', + 'description' => 'The container for Function compute configuration.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The function compute configuration for event notification.', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/FunctionComputeConfiguration', + ], + ], + ], + ], + 'ExtendWormConfiguration' => [ + 'title' => 'The configuration of extending the retention period of objects in a bucket', + 'description' => 'The container that stores the root node.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RetentionPeriodInDays' => [ + 'title' => 'The number of days for which objects can be retained', + 'description' => 'The number of days for which objects can be retained.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '366', + ], + ], + 'xml' => [ + 'name' => 'ExtendWormConfiguration', + ], + ], + 'FileHeaderInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The header information of the CSV object. This parameter is optional. Valid values:'."\n" + ."\n" + .'* Use: The CSV object contains header information. You can use the column names in the CSV object as the column names in the SelectObject operation.'."\n" + .'* Ignore: The CSV object contains header information. The column names in the CSV object cannot be used as the column names in the SelectObject operation.'."\n" + .'* None (default): The CSV object does not contain header information.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Use', + 'enum' => [ + 'USE', + 'IGNORE', + 'NONE', + ], + ], + 'FunctionComputeConfiguration' => [ + 'title' => '', + 'description' => 'The function compute configuration for event notification.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '', + 'description' => 'Function compute configuration id.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1', + ], + 'Event' => [ + 'title' => '', + 'description' => 'Events to listen.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Name of the event.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ObjectCreated:PutObject', + 'extendType' => 'true', + ], + ], + 'Filter' => [ + 'title' => '', + 'description' => 'Filter for event.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '', + 'description' => 'Filter for object names.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'title' => '', + 'description' => 'The prefix of an object name.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'prod', + ], + 'Suffix' => [ + 'title' => '', + 'description' => 'The suffix of an object name.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '.jpb', + ], + ], + ], + ], + ], + 'Function' => [ + 'title' => '', + 'description' => 'The Function used for the event.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'title' => '', + 'description' => 'Function ARN.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'acs:fc:oss-ap-southeast-1:1993989758795198:services/qianwang-fc-test.LATEST/functions/fc-test', + ], + 'AssumeRole' => [ + 'title' => '', + 'description' => 'Role used to execute the function.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'acs:ram::1993989758795198:role/AliyunOSSObjectFcForOSSDefaultRole', + ], + ], + ], + ], + ], + 'GetAccessPointResult' => [ + 'title' => '', + 'description' => 'The container that stores the information about an access point.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AccessPointName' => [ + 'description' => 'The name of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointName', + ], + 'Bucket' => [ + 'title' => '', + 'description' => 'The name of the bucket for which the access point is configured.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'AccountId' => [ + 'title' => '', + 'description' => 'The ID of the Alibaba Cloud account for which the access point is configured.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '10378****8768', + ], + 'NetworkOrigin' => [ + 'title' => '', + 'description' => 'The network origin of the access point. Valid values: vpc and internet. vpc: You can only use the specified VPC ID to access the access point. internet: You can use public endpoints and internal endpoints to access the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointNetworkOrigin', + ], + 'VpcConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the information about the VPC.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointVpcConfiguration', + ], + 'AccessPointArn' => [ + 'description' => 'The ARN of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointArn', + ], + 'Alias' => [ + 'description' => 'The alias of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointAlias', + ], + 'Status' => [ + 'description' => 'The status of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/AccessPointStatus', + ], + 'Endpoints' => [ + 'title' => '', + 'description' => 'The container that stores the network origin information about the access point.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'PublicEndpoint' => [ + 'title' => '', + 'description' => 'The public endpoint of the access point.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Endpoint', + ], + 'InternalEndpoint' => [ + 'title' => '接入点的内网Endpoint。', + 'description' => '接入点的内网Endpoint。', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/Endpoint', + ], + ], + ], + 'PublicAccessBlockConfiguration' => [ + 'title' => '保存接入点阻止公共访问的配置', + 'description' => '保存接入点阻止公共访问的配置', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + 'CreationDate' => [ + 'title' => '接入点创建时间。', + 'description' => '接入点创建时间。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Sat, 27 Apr 2024 15:04:14 GMT', + ], + ], + ], + 'GetResourcePoolInfoResponse' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rp-for-ai', + ], + 'Owner' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1234567890987', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2024-07-24T08:42:32.000Z', + ], + 'QosConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/QoSConfiguration', + ], + ], + ], + 'Grant' => [ + 'description' => 'The access control list (ACL) of the bucket.'."\n", + 'visibility' => 'public', + 'parseType' => 'struct', + '$ref' => '#/components/schemas/ObjectACL', + ], + 'HttpsConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores Transport Layer Security (TLS) version configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TLS' => [ + 'title' => '', + 'description' => 'The container that stores TLS version configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '', + 'description' => 'Specifies whether to enable TLS version management for the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'TLSVersion' => [ + 'title' => '', + 'description' => 'The TLS versions.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The TLS version of the bucket.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TLSv1.3'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* TLSv1.2'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* TLSv1.1'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* TLSv1.0'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'TLSv1.3' => 'TLSv1.3', + 'TLSv1.2' => 'TLSv1.2', + 'TLSv1.1' => 'TLSv1.1', + 'TLSv1.0' => 'TLSv1.0', + ], + 'example' => 'TLSv1.2', + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'IndexDocument' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the default homepage.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Suffix' => [ + 'title' => 'description', + 'description' => 'The default homepage.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'index.html', + ], + 'SupportSubDir' => [ + 'title' => 'description', + 'description' => 'Specifies whether to redirect the access to the default homepage of the subdirectory when the subdirectory is accessed. Valid values:'."\n" + ."\n" + .'* **true**: The access is redirected to the default homepage of the subdirectory.'."\n" + .'* **false** (default): The access is redirected to the default homepage of the root directory.'."\n" + ."\n" + .'For example, the default homepage is set to index.html, and `bucket.oss-cn-hangzhou.aliyuncs.com/subdir/` is the site that you want to access. If **SupportSubDir** is set to false, the access is redirected to `bucket.oss-cn-hangzhou.aliyuncs.com/index.html`. If **SupportSubDir** is set to true, the access is redirected to `bucket.oss-cn-hangzhou.aliyuncs.com/subdir/index.html`.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'Type' => [ + 'title' => 'description', + 'description' => 'The operation to perform when the default homepage is set, the name of the accessed object does not end with a forward slash (/), and the object does not exist. This parameter takes effect only when **SupportSubDir** is set to true. It takes effect after RoutingRule but before ErrorFile. For example, the default homepage is set to index.html, `bucket.oss-cn-hangzhou.aliyuncs.com/abc` is the site that you want to access, and the abc object does not exist. In this case, different operations are performed based on the value of **Type**.'."\n" + ."\n" + .'* **0** (default): OSS checks whether the object named abc/index.html, which is in the `Object + Forward slash (/) + Homepage` format, exists. If the object exists, OSS returns HTTP status code 302 and the Location header value that contains URL-encoded `/abc/`. The URL-encoded /abc/ is in the `Forward slash (/) + Object + Forward slash (/)` format. If the object does not exist, OSS returns HTTP status code 404 and continues to check ErrorFile.'."\n" + .'* **1**: OSS returns HTTP status code 404 and the NoSuchKey error code and continues to check ErrorFile.'."\n" + .'* **2**: OSS checks whether abc/index.html exists. If abc/index.html exists, the content of the object is returned. If abc/index.html does not exist, OSS returns HTTP status code 404 and continues to check ErrorFile.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'InitiateWormConfiguration' => [ + 'title' => 'The confiiguration of a retention policy', + 'description' => 'The container that stores the root node.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RetentionPeriodInDays' => [ + 'title' => 'The number of days for which objects can be retained', + 'description' => 'The number of days for which objects can be retained.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '365', + ], + ], + 'xml' => [ + 'name' => 'InitiateWormConfiguration', + ], + ], + 'InputSerialization' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CompressionType' => [ + 'description' => 'The compression type of the object. This parameter is optional. Valid value: None.'."\n", + 'visibility' => 'public', + 'example' => 'None', + '$ref' => '#/components/schemas/CompressionType', + ], + 'CSV' => [ + 'sdkPropertyName' => 'csv', + 'description' => 'The format of the input CSV object.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/CSVInput', + ], + 'JSON' => [ + 'sdkPropertyName' => 'json', + 'description' => 'The format of the input JSON object.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/JSONInput', + ], + ], + ], + 'InventoryConfiguration' => [ + 'title' => 'The configuration of a inventory task', + 'description' => 'The container that stores the configurations of the inventory.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'The specified inventory list name, which must be globally unique in the bucket', + 'description' => 'The name of the inventory. The name must be unique in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'report1', + ], + 'IsEnabled' => [ + 'title' => 'Indicates whether the inventory function is enabled', + 'description' => 'Specifies whether to enable the bucket inventory feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Destination' => [ + 'title' => '', + 'description' => 'The container that stores the exported inventory lists.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryDestination', + ], + 'Schedule' => [ + 'title' => '', + 'description' => 'The container that stores information about the frequency at which inventory lists are exported.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventorySchedule', + ], + 'Filter' => [ + 'title' => '', + 'description' => 'The container that stores the prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryFilter', + ], + 'IncludedObjectVersions' => [ + 'title' => '', + 'description' => 'Specifies whether to include the version information about the objects in inventory lists. Valid values:'."\n" + ."\n" + .'* All: The information about all versions of the objects is exported.'."\n" + .'* Current: Only the information about the current versions of the objects is exported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'Current' => 'Current', + ], + 'example' => 'All', + ], + 'OptionalFields' => [ + 'title' => 'The container that stores the configuration fields included in the inventory list', + 'description' => 'The container that stores the configuration fields in inventory lists.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'sdkPropertyName' => 'Fields', + 'title' => 'field list', + 'description' => 'The configuration fields that are included in inventory lists. Available configuration fields:'."\n" + ."\n" + .'* Size: the size of the object.'."\n" + .'* LastModifiedDate: the time when the object was last modified.'."\n" + .'* ETag: the ETag of the object. It is used to identify the content of the object.'."\n" + .'* StorageClass: the storage class of the object.'."\n" + .'* IsMultipartUploaded: specifies whether the object is uploaded by using multipart upload.'."\n" + .'* EncryptionStatus: the encryption status of the object.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration fields that are included in inventory lists.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/InventoryOptionalField', + ], + ], + ], + ], + ], + ], + 'InventoryDestination' => [ + 'title' => 'The information about the bucket that stores the exported inventory list', + 'description' => 'The container that stores information about exported inventory lists.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'OSSBucketDestination' => [ + 'title' => 'The information about the bucket that stores the exported inventory list', + 'description' => 'The container that stores information about the bucket in which exported inventory lists are stored.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryOSSBucketDestination', + ], + ], + ], + 'InventoryEncryption' => [ + 'title' => 'The container that stores the encryption method of the inventory list', + 'description' => 'The container that stores the encryption method of exported inventory lists.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SSE-OSS' => [ + 'sdkPropertyName' => 'SSEOSS', + 'title' => 'The container that stores the information about the SSE-OSS encryption method', + 'description' => 'The container that stores information about the SSE-OSS encryption method.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/SSEOSS', + ], + 'SSE-KMS' => [ + 'sdkPropertyName' => 'SSEKMS', + 'title' => 'The container that stores the CMK used in the SSE-KMS encryption method', + 'description' => 'The container that stores the customer master key (CMK) used for SSE-KMS encryption.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/SSEKMS', + ], + ], + ], + 'InventoryFilter' => [ + 'title' => 'Contains the prefix used to filter the objects in the inventory list', + 'description' => 'The container that stores the prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'title' => 'The prefix specified in the inventory rule', + 'description' => 'The prefix that is specified in the inventory.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Pics/', + ], + 'LastModifyBeginTimeStamp' => [ + 'title' => '筛选文件最后修改时间的起始时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', + 'description' => 'The beginning of the time range during which the object was last modified. Unit: seconds.'."\n" + .'Valid values: [1262275200, 253402271999]', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637883649', + ], + 'LastModifyEndTimeStamp' => [ + 'title' => '筛选文件最后修改时间的终止时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', + 'description' => 'The end of the time range during which the object was last modified. Unit: seconds.'."\n" + .'Valid values: [1262275200, 253402271999]', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638347592', + ], + 'LowerSizeBound' => [ + 'title' => '筛选文件的最小大小，单位为B。 取值范围：大于等于0 B，小于等于48.8 TB。', + 'description' => 'The minimum size of the specified object.Unit: B.'."\n" + .'Valid values: [0 B, 48.8 TB]', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'UpperSizeBound' => [ + 'title' => '筛选文件的最大大小，单位为B。 取值范围：大于0 B，小于等于48.8 TB。', + 'description' => 'The maximum size of the specified object.Unit: B.'."\n" + .'Valid values: [0B, 48.8TB]', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1048576', + ], + 'StorageClass' => [ + 'title' => '筛选文件的存储类型，支持指定多种存储类型。 可选值： Standard：标准存储 IA：低频访问 Archive：归档存储 ColdArchive：冷归档存储 All（默认值）：所有存储类型', + 'description' => 'The storage class of the object. You can specify multiple storage classes.'."\n" + .'Valid values:'."\n" + .'- Standard'."\n" + .'- IA'."\n" + .' - Archive'."\n" + .' - ColdArchive'."\n" + .' - All', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'All', + ], + 'TagsCondition' => [ + 'title' => '标签筛选运算符，合法值：OR_FILTER，AND_FILTER', + 'description' => 'Tag filter operator, Valid values：OR_FILTER，AND_FILTER', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'OR_FILTER', + ], + 'Tags' => [ + 'title' => '标签列表。标签键值对之间用分号（;）分割，标签键值之间用#分割。', + 'description' => 'Tag list. Key-value pairs are separated by semicolons (;), with the key and value separated by a hash (#).', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'tag1#val1;tag2#val2', + ], + ], + ], + 'InventoryFormat' => [ + 'title' => 'The format of the exported inventory list', + 'description' => 'Set the value to CSV.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CSV', + 'enum' => [ + 'CSV', + ], + ], + 'InventoryFrequency' => [ + 'title' => 'The frequency that inventory lists are exported', + 'description' => 'The frequency at which inventory lists are exported.'."\n" + ."\n" + .'Values:'."\n" + ."\n" + .'* Daily: Inventory lists are exported on a daily basis.'."\n" + .'* Weekly: Inventory lists are exported on a weekly basis.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Daily' => 'Daily', + 'Weekly' => 'Weekly', + ], + 'example' => 'Daily', + 'enum' => [ + 'Daily', + 'Weekly', + ], + ], + 'InventoryIncludedObjectVersions' => [ + 'title' => 'Specifies whether versioning information about the objects is included in the inventory list', + 'description' => 'Specifies whether to include the version information about the objects in inventory lists. Valid values:'."\n" + ."\n" + .'* All: The information about all versions of the objects is exported.'."\n" + .'* Current: Only the information about the current versions of the objects is exported.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'All' => 'All', + 'Current' => 'Current', + ], + 'example' => 'All', + 'enum' => [ + 'All', + 'Current', + ], + ], + 'InventoryOptionalField' => [ + 'title' => 'The configuration fields included in the inventory list', + 'description' => 'The configuration fields that are included in inventory lists.'."\n" + ."\n" + .'* Size: the size of the object.'."\n" + .'* LastModifiedDate: the time when the object was last modified.'."\n" + .'* ETag: the ETag of the object. It is used to identify the content of the object.'."\n" + .'* StorageClass: the storage class of the object.'."\n" + .'* IsMultipartUploaded: specifies whether the object is uploaded by using multipart upload.'."\n" + .'* EncryptionStatus: the encryption status of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Size', + 'enum' => [ + 'Size', + 'LastModifiedDate', + 'ETag', + 'StorageClass', + 'IsMultipartUploaded', + 'EncryptionStatus', + ], + ], + 'InventoryOSSBucketDestination' => [ + 'title' => 'The information about the bucket that stores the exported inventory list', + 'description' => 'The container that stores information about the bucket in which exported inventory lists are stored.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '', + 'description' => 'The format of exported inventory lists. The exported inventory lists are CSV objects compressed by using GZIP.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryFormat', + ], + 'AccountId' => [ + 'title' => 'The account ID granted by the bucket owner', + 'description' => 'The ID of the account to which permissions are granted by the bucket owner.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '100000000000000', + ], + 'RoleArn' => [ + 'title' => 'The name of the role to which the bucket owner grants permissions', + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role that has the permissions to read all objects from the source bucket and write objects to the destination bucket. Format: `acs:ram::uid:role/rolename`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'acs:ram::100000000000000:role/AliyunOSSRole', + ], + 'Bucket' => [ + 'title' => 'The bucket that stores the exported inventory list', + 'description' => 'The name of the bucket in which exported inventory lists are stored.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'acs:oss:::bucket_0001', + ], + 'Prefix' => [ + 'title' => 'The path of the exported inventory list', + 'description' => 'The prefix of the path in which the exported inventory lists are stored.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'prefix1/', + ], + 'Encryption' => [ + 'title' => '', + 'description' => 'The container that stores the encryption method of the exported inventory lists.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryEncryption', + ], + ], + 'xml' => [ + 'name' => 'OSSBucketDestination', + ], + ], + 'InventorySchedule' => [ + 'title' => 'Contains the frequency that inventory lists are exported', + 'description' => 'Contains the frequency that inventory lists are exported'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Frequency' => [ + 'description' => 'The frequency at which the inventory list is exported. '."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Daily: The inventory list is exported on a daily basis. '."\n" + ."\n" + .'- Weekly: The inventory list is exported on a weekly basis. '."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InventoryFrequency', + 'example' => 'Daily', + ], + ], + ], + 'JSONInput' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of JSON input.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* LINES'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* DOCUMENT'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [ + ' LINES' => ' LINES', + 'DOCUMENT' => 'DOCUMENT', + ], + 'example' => 'DOCUMENT', + '$ref' => '#/components/schemas/JSONType', + ], + 'Range' => [ + 'title' => 'description', + 'description' => 'The query range. This parameter is optional. The following formats are supported:'."\n" + ."\n" + .'> SelectMeta must be created for objects that are queried based on Range. For more information about SelectMeta, see [CreateSelectObjectMeta](~~74054~~).'."\n" + ."\n" + .'* Query by row: line-range=start-end. For example, line-range=10-20 indicates that data from row 10 to row 20 is scanned.'."\n" + .'* Query by split: split-range=start-end. For example, split-range=10-20 indicates that data from split 10 to split 20 is scanned.'."\n" + ."\n" + .'\\'."\n" + .'The start and end of the range are both inclusive. The start and end of the range use the same format as that of the range parameter in range get.\\'."\n" + .'This parameter can be used only if the object is in the CSV format or if the JSON type is LINES.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'line-range=start-end' => 'line-range=start-end', + 'split-range=start-end' => 'split-range=start-end', + ], + 'example' => 'line-range=start-end', + ], + 'ParseJsonNumberAsString' => [ + 'title' => 'description', + 'description' => 'Specifies whether to parse integer and floating-point numbers in the JSON object into strings. The precision of floating-point numbers in a JSON object decreases when the numbers are parsed. If you want to retain the raw data, we recommend that you set this parameter to true. To use the parsed numbers in calculations, you can use the CAST function in SQL to convert the parsed data into the required type such as INT, DOUBLE, or DECIMAL.\\'."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'JSONOutput' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RecordDelimiter' => [ + 'title' => 'description', + 'description' => 'Optional. A Base64-encoded line feed. The value of this parameter is up to two ANSI characters in length before encoding. For example, `\\n` is used to represent a line feed in Java.\\'."\n" + .'Default value: `\\n`'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '\\n', + ], + ], + ], + 'JSONType' => [ + 'title' => 'A short description of struct', + 'description' => 'The type of JSON input. Valid values:'."\n" + ."\n" + .'* DOCUMENT: A single JSON object in the input data can span lines.'."\n" + .'* LINES: Each line of the input data contains a JSON object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'DOCUMENT' => 'DOCUMENT', + 'LINES' => 'LINES', + ], + 'example' => 'DOCUMENT', + 'enum' => [ + 'DOCUMENT', + 'LINES', + ], + ], + 'LifecycleConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores lifecycle configurations. The container can contain up to 1,000 lifecycle rules.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => 'description', + 'description' => 'The container that stores the lifecycle rules. The period of time after which objects expire must be longer than the period of time after which the storage class of the same objects is converted to Infrequent Access (IA) or Archive.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the lifecycle rules. The period of time after which objects expire must be longer than the period of time after which the storage class of the same objects is converted to IA or Archive.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LifecycleRule', + ], + ], + ], + ], + 'LifecycleRule' => [ + 'title' => '', + 'description' => 'The container that stores lifecycle rules.'."\n" + ."\n" + .'* A lifecycle rule cannot be configured to convert the storage class of objects in an Archive bucket.'."\n" + .'* The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA or Archive.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '', + 'description' => 'The ID of the lifecycle rule. The ID can contain up to 255 characters. If you do not specify the ID, OSS automatically generates a unique ID for the lifecycle rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'rule1', + ], + 'Prefix' => [ + 'title' => '', + 'description' => 'The prefix in the names of the objects to which the rule applies. The prefixes specified by different rules cannot overlap.'."\n" + ."\n" + .'* If Prefix is specified, this rule applies only to objects whose names contain the specified prefix in the bucket.'."\n" + .'* If Prefix is not specified, this rule applies to all objects in the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => false, + 'example' => 'tmp/', + ], + 'Status' => [ + 'title' => '', + 'description' => 'Specifies whether to enable the rule. Valid values:'."\n" + ."\n" + .'* Enabled: enables the rule. OSS periodically executes the rule.'."\n" + .'* Disabled: does not enable the rule. OSS ignores the rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Disabled' => 'Disabled', + ], + 'example' => 'Enabled', + ], + 'Expiration' => [ + 'sdkPropertyName' => 'LifecycleExpiration', + 'title' => '', + 'description' => 'The delete operation to perform on objects based on the lifecycle rule. For an object in a versioning-enabled bucket, the delete operation specified by this parameter is performed only on the current version of the object.\\'."\n" + .'The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA or Archive.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CreatedBeforeDate' => [ + 'title' => '', + 'description' => 'The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. The value of this parameter is in the yyyy-MM-ddT00:00:00.000Z format.\\'."\n" + .'Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2002-10-11T00:00:00.000Z', + ], + 'Days' => [ + 'title' => '', + 'description' => 'The number of days from when the objects were last modified to when the lifecycle rule takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExpiredObjectDeleteMarker' => [ + 'title' => '', + 'description' => 'Specifies whether to automatically remove expired delete markers.'."\n" + ."\n" + .'* true: Expired delete markers are automatically removed. If you set this parameter to true, you cannot specify the Days or CreatedBeforeDate parameter.'."\n" + .'* false: Expired delete markers are not automatically removed. If you set this parameter to false, you must specify the Days or CreatedBeforeDate parameter.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Date' => [ + 'title' => '指定一个日期，达到该日期之后该规则会生效。如果指定的时间早于当前时刻，则直接生效。（不推荐使用，请使用Days或CreateDateBefore）', + 'description' => 'The date after which the lifecycle rule takes effect. If the specified time is earlier than the current moment, it\'ll takes effect immediately. (This fields is NOT RECOMMENDED, please use Days or CreateDateBefore)', + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2002-10-11T00:00:00.000Z', + 'parseType' => 'java.lang.String', + ], + ], + ], + 'Transition' => [ + 'sdkPropertyName' => 'LifecycleTransition', + 'title' => '', + 'description' => 'The conversion of the storage class of objects that match the lifecycle rule when the objects expire. The storage class of the objects can be converted to IA, Archive, and ColdArchive. The storage class of Standard objects in a Standard bucket can be converted to IA, Archive, or Cold Archive. The period of time from when the objects expire to when the storage class of the objects is converted to Archive must be longer than the period of time from when the objects expire to when the storage class of the objects is converted to IA. For example, if the validity period is set to 30 for objects whose storage class is converted to IA after the validity period, the validity period must be set to a value greater than 30 for objects whose storage class is converted to Archive.'."\n" + ."\n" + .'> Either Days or CreatedBeforeDate is required.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CreatedBeforeDate' => [ + 'title' => '', + 'description' => 'The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2002-10-11T00:00:00.000Z', + ], + 'Days' => [ + 'title' => '', + 'description' => 'The number of days from when the objects were last modified to when the lifecycle rule takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class to which objects are converted. Valid values:'."\n" + ."\n" + .'* IA'."\n" + .'* Archive'."\n" + .'* ColdArchive'."\n" + ."\n" + .'> You can convert the storage class of objects in an IA bucket to only Archive or Cold Archive.'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/StorageClass', + ], + 'IsAccessTime' => [ + 'title' => '', + 'description' => 'Specifies whether the lifecycle rule applies to objects based on their last access time. Valid values:'."\n" + ."\n" + .'* true: The rule applies to objects based on their last access time.'."\n" + .'* false: The rule applies to objects based on their last modified time.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReturnToStdWhenVisit' => [ + 'title' => '', + 'description' => 'Specifies whether to convert the storage class of non-Standard objects back to Standard after the objects are accessed. This parameter takes effect only when the IsAccessTime parameter is set to true. Valid values:'."\n" + ."\n" + .'* true: converts the storage class of the objects to Standard.'."\n" + .'* false: does not convert the storage class of the objects to Standard.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowSmallFile' => [ + 'title' => '', + 'description' => 'Specifies whether to convert the storage class of objects whose sizes are less than 64 KB to IA, Archive, or Cold Archive based on their last access time. Valid values:'."\n" + ."\n" + .'* true: converts the storage class of objects that are smaller than 64 KB to IA, Archive, or Cold Archive. Objects that are smaller than 64 KB are charged as 64 KB. Objects that are greater than or equal to 64 KB are charged based on their actual sizes. If you set this parameter to true, the storage fees may increase.'."\n" + .'* false: does not convert the storage class of an object that is smaller than 64 KB.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'extendType' => 'true', + ], + ], + 'AbortMultipartUpload' => [ + 'sdkPropertyName' => 'LifecycleAbortMultipartUpload', + 'title' => '', + 'description' => 'The delete operation that you want OSS to perform on the parts that are uploaded in incomplete multipart upload tasks when the parts expire.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Days' => [ + 'title' => '', + 'description' => 'The number of days from when the objects were last modified to when the lifecycle rule takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreatedBeforeDate' => [ + 'title' => '', + 'description' => 'The date based on which the lifecycle rule takes effect. OSS performs the specified operation on data whose last modified date is earlier than this date. Specify the time in the ISO 8601 standard. The time must be at 00:00:00 in UTC.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2002-10-11T00:00:00.000Z', + ], + 'Date' => [ + 'title' => '指定一个日期，达到该日期之后该规则会生效。如果指定的时间早于当前时刻，则直接生效。（不推荐使用，请使用Days或CreateDateBefore）', + 'description' => 'The date after which the lifecycle rule takes effect. If the specified time is earlier than the current moment, it\'ll takes effect immediately. (This fields is NOT RECOMMENDED, please use Days or CreateDateBefore)', + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2002-10-11T00:00:00.000Z', + 'parseType' => 'java.lang.String', + ], + ], + ], + 'Tag' => [ + 'title' => '', + 'description' => 'The tag of the objects to which the lifecycle rule applies. You can specify multiple tags.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag of the objects to which the lifecycle rule applies. You can specify multiple tags.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Tag', + ], + ], + 'NoncurrentVersionExpiration' => [ + 'title' => '', + 'description' => 'The delete operation that you want OSS to perform on the previous versions of the objects that match the lifecycle rule when the previous versions expire.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'NoncurrentDays' => [ + 'title' => '', + 'description' => 'The number of days from when the objects became previous versions to when the lifecycle rule takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'NoncurrentVersionTransition' => [ + 'title' => '', + 'description' => 'The conversion of the storage class of previous versions of the objects that match the lifecycle rule when the previous versions expire. The storage class of the previous versions can be converted to IA or Archive. The period of time from when the previous versions expire to when the storage class of the previous versions is converted to Archive must be longer than the period of time from when the previous versions expire to when the storage class of the previous versions is converted to IA.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'NoncurrentDays' => [ + 'title' => '', + 'description' => 'The number of days from when the objects became previous versions to when the lifecycle rule takes effect.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class to which objects are converted. Valid values:'."\n" + ."\n" + .'* IA'."\n" + .'* Archive'."\n" + .'* ColdArchive'."\n" + ."\n" + .'> You can convert the storage class of objects in an IA bucket to only Archive or Cold Archive.'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/StorageClass', + ], + 'IsAccessTime' => [ + 'title' => '', + 'description' => 'Specifies whether the lifecycle rule applies to objects based on their last access time. Valid values:'."\n" + ."\n" + .'* true: The rule applies to objects based on their last access time.'."\n" + .'* false: The rule applies to objects based on their last modified time.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ReturnToStdWhenVisit' => [ + 'title' => '', + 'description' => 'Specifies whether to convert the storage class of non-Standard objects back to Standard after the objects are accessed. This parameter takes effect only when the IsAccessTime parameter is set to true. Valid values:'."\n" + ."\n" + .'* true: converts the storage class of the objects to Standard.'."\n" + .'* false: does not convert the storage class of the objects to Standard.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowSmallFile' => [ + 'title' => '', + 'description' => 'Specifies whether to convert the storage class of objects whose sizes are less than 64 KB to IA, Archive, or Cold Archive based on their last access time. Valid values:'."\n" + ."\n" + .'* true: converts the storage class of objects that are smaller than 64 KB to IA, Archive, or Cold Archive. Objects that are smaller than 64 KB are charged as 64 KB. Objects that are greater than or equal to 64 KB are charged based on their actual sizes. If you set this parameter to true, the storage fees may increase.'."\n" + .'* false: does not convert the storage class of an object that is smaller than 64 KB.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'extendType' => 'true', + ], + ], + 'Filter' => [ + 'title' => '', + 'description' => 'The container that stores the Not parameter that is used to filter objects.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Not' => [ + 'title' => '', + 'description' => 'The condition that is matched by objects to which the lifecycle rule does not apply.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'title' => '', + 'description' => 'The prefix in the names of the objects to which the lifecycle rule does not apply.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'tmp/not/', + ], + 'Tag' => [ + 'title' => '', + 'description' => 'The tag of the objects to which the lifecycle rule does not apply.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Tag', + ], + ], + ], + 'ObjectSizeGreaterThan' => [ + 'title' => '本条生命周期规则只对文件大小大于该值的文件生效', + 'description' => 'This lifecycle rule only applies to files larger than this size.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + 'ObjectSizeLessThan' => [ + 'title' => '本条生命周期规则只对文件大小小于该值的文件生效', + 'description' => 'This lifecycle rule only applies to files smaller than this size.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + ], + ], + 'AtimeBase' => [ + 'title' => '存储空间开启访问追踪的时间戳', + 'description' => 'Timestamp for when access tracking was enabled.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626158525', + ], + ], + ], + 'ListAccessPointsResult' => [ + 'title' => '保存本次列举接入点信息结果的容器。', + 'description' => 'The container that stores the information about access points.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'IsTruncated' => [ + 'title' => '请求中返回的结果是否被截断。返回值如下： true：表示本次未返回全部结果。 false：表示本次已返回全部结果。', + 'description' => 'Indicates whether the returned list is truncated. '."\n" + .'Valid values: '."\n" + .'* true: indicates that not all results are returned. '."\n" + .'* false: indicates that all results are returned.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'true', + ], + 'NextContinuationToken' => [ + 'title' => '表明本次ListAccessPoints请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', + 'description' => 'Indicates that this ListAccessPoints request does not return all results that can be listed. You can use NextContinuationToken to continue obtaining list results.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'abc**', + ], + 'AccountId' => [ + 'title' => '接入点所属的阿里云账号UID。', + 'description' => 'The ID of the Alibaba Cloud account to which the access point belongs.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10107***1448150', + ], + 'AccessPoints' => [ + 'title' => '保存所有接入点信息的容器。', + 'description' => 'The container that stores the information about all access points.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'AccessPoint' => [ + 'title' => '保存接入点信息的列表。', + 'description' => 'The container that stores the information about all access point.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the information about all access point.', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/AccessPoint', + ], + ], + ], + ], + 'MaxKeys' => [ + 'title' => '本次列举操作所设置的结果最大数量。', + 'description' => 'The maximum number of results set for this enumeration operation.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'ListBucketRequesterQoSInfosResult' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'ContinuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '29387293298', + ], + 'NextContinuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '29387293298', + ], + 'IsTruncated' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequesterQoSInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RequesterQoSInfo', + ], + ], + ], + ], + 'ListResourcePoolBucketsResult' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ResourcePool' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rp-for-api', + ], + 'ContionuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'abcd', + ], + 'NextContionuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'defg', + ], + 'IsTruncated' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourcePoolBucket' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ResourcePoolBucket', + ], + ], + ], + ], + 'ListResourcePoolRequesterQoSInfosResult' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ResourcePool' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rp-for-ai', + ], + 'ContinuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '29387293298', + ], + 'NextContinuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '29387293298', + ], + 'IsTruncated' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequesterQoSInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RequesterQoSInfo', + ], + ], + ], + ], + 'ListResourcePoolsResult' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Owner' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1032307xxxx72056', + ], + 'ContionuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'abcd', + ], + 'NextContionuationToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'xyz', + ], + 'IsTruncated' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourcePool' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ResourcePoolSimpleInfo', + ], + ], + ], + ], + 'LiveChannel' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information about each returned LiveChannel.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'description', + 'description' => 'The name of the LiveChannel.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'channel-0', + ], + 'Description' => [ + 'title' => 'description', + 'description' => 'The description of the LiveChannel.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'title' => 'description', + 'description' => 'The status of the LiveChannel. Valid values:'."\n" + ."\n" + .'* disabled'."\n" + .'* enabled'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'enabled', + ], + 'LastModified' => [ + 'title' => 'description', + 'description' => 'The time when the LiveChannel configuration is last modified. Standard: ISO 8601.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => 'ISO8601', + ], + 'PublishUrls' => [ + 'description' => 'The container that stores the URL used to ingest a stream to the LiveChannel.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/LiveChannelPublishUrls', + ], + 'PlayUrls' => [ + 'description' => 'The container that stores the URL used to play a stream ingested to the LiveChannel.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/LiveChannelPlayUrls', + ], + ], + ], + 'LiveChannelAudio' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores audio stream information if Status is set to Live.'."\n" + ."\n" + .'> The containers for audio and video streams are returned only if Status is set to Live. However, the containers for audio and video streams may not necessarily be returned even if Status is set to Live. For example, the containers are not returned if the client is connected to a LiveChannel but no audio and video data has been sent.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bandwidth' => [ + 'title' => 'description', + 'description' => 'The bitrate of the current audio stream.'."\n" + ."\n" + .'> Bandwidth indicates the average bitrate of the audio stream or video stream in the recent period. When LiveChannel is switched to the Live state, the returned value of Bandwidth may be 0. Unit: B/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'SampleRate' => [ + 'title' => 'description', + 'description' => 'The sample rate of the current audio stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44100', + ], + 'Codec' => [ + 'title' => 'description', + 'description' => 'The encoding format of the current audio stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ADPCM', + ], + ], + ], + 'LiveChannelConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the configurations of the LiveChannel.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'description', + 'description' => 'The description of the LiveChannel. The description can be up to 128 bytes in length.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'title' => 'description', + 'description' => 'The status of the LiveChannel.'."\n" + ."\n" + .'Valid values: **enabled** and **disabled**. Default value: **enabled**.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'enabled', + ], + 'Target' => [ + 'description' => 'The container that stores the configurations used by the LiveChannel to store uploaded data.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/LiveChannelTarget', + ], + 'Snapshot' => [ + 'description' => 'The container that stores the options of the high-frequency snapshot operations.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/LiveChannelSnapshot', + ], + ], + ], + 'LiveChannelPlayUrls' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the playback URL.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => 'description', + 'description' => 'The playback URL.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-hangzhou.aliyuncs.com/test-channel/playlist.m3u8', + ], + ], + ], + 'LiveChannelPublishUrls' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the URL used to ingest streams to the LiveChannel.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => 'description', + 'description' => 'The URL used to ingest streams to the LiveChannel.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The URL used to ingest streams is not signed. If the ACL of the bucket is not public-read-write, you must add a signature to the URL before you use the URL to access the bucket.'."\n" + ."\n" + .'* The URL used to play streams is not signed. If the ACL of the bucket is private, you must add a signature to the URL before you use the URL to access the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/test-channel', + ], + ], + ], + 'LiveChannelSnapshot' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the options of the high-frequency snapshot operations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RoleName' => [ + 'title' => 'description', + 'description' => 'The name of the role used to perform high-frequency snapshot operations. The role must have the write permissions on DestBucket and the permissions to send messages to NotifyTopic.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'role_for_snapshot', + ], + 'DestBucket' => [ + 'title' => 'description', + 'description' => 'The bucket that stores the results of high-frequency snapshot operations. The bucket must belong to the same owner as the current bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'snapshotdest', + ], + 'NotifyTopic' => [ + 'title' => 'description', + 'description' => 'The Message Service (MNS) topic used to notify users of the results of high-frequency snapshot operations.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'snapshotnotify', + ], + 'Interval' => [ + 'title' => 'description', + 'description' => 'The interval of high-frequency snapshot operations. If no key frame (inline frame) exists within the interval, no snapshot is captured. Unit: seconds. Valid values: \\[1, 100].'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + 'LiveChannelTarget' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the configurations used by the LiveChannel to store uploaded data.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'description', + 'description' => 'The format in which the LiveChannel stores uploaded data.'."\n" + ."\n" + .'Valid value: **HLS**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* When you set the value of Type to HLS, Object Storage Service (OSS) updates the M3U8 file each time when a TS file is generated. The maximum number of the latest .ts files that can be included in the M3U8 file is specified by the FragCount parameter.'."\n" + ."\n" + .'* If you set the value of Type to HLS and the duration of the audio and video data written to the current TS file exceeds the duration specified by FragDuration, OSS switches to the next TS file when the next key frame is received. If OSS does not receive the next key frame after 60 seconds or twice the duration specified by FragDuration (whichever is greater), OSS forcibly switches to the next TS file. In this case, stuttering may occur during the playback of the stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'HLS', + ], + 'FragDuration' => [ + 'title' => 'description', + 'description' => 'The duration of each TS file when the value of Type is HLS. Unit: seconds.'."\n" + ."\n" + .'Valid values: \\[1, 100]. Default value: **5**'."\n" + ."\n" + .'> If you do not specify values for the FragDuration and FragCount parameters, the default values of the two parameters are used. If you specify one of the parameters, you must also specify the other.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'FragCount' => [ + 'title' => 'description', + 'description' => 'The number of TS files included in the M3U8 file when the value of Type is HLS.'."\n" + ."\n" + .'Valid values: \\[1, 100] Default value: **3**'."\n" + ."\n" + .'> If you do not specify values for the FragDuration and FragCount parameters, the default values of the two parameters are used. If you specify one of the parameters, you must also specify the other.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'PlaylistName' => [ + 'title' => 'description', + 'description' => 'The name of the generated M3U8 file when the value of Type is HLS. The name must be 6 to 128 bytes in length and end with .m3u8.'."\n" + ."\n" + .'Default value: **playlist.m3u8** Valid values: \\[6, 128]'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'playlist.m3u8', + ], + ], + ], + 'LiveChannelVideo' => [ + 'title' => 'A short description of struct', + 'description' => 'The containers that store video stream information if Status is set to Live.'."\n" + ."\n" + .'> ****The container that stores video data and the container that stores audio data are returned only if Status is set to Live. However, the containers are not necessarily returned when Status is set to Live. For example, the containers are not returned if the client is connected to a LiveChannel but no audio and video data has been sent.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => 'description', + 'description' => 'The width of the video stream. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1280', + ], + 'Height' => [ + 'title' => 'description', + 'description' => 'The height of the video stream. Unit: pixels.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '536', + ], + 'FrameRate' => [ + 'title' => 'description', + 'description' => 'The frame rate of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Bandwidth' => [ + 'title' => 'description', + 'description' => 'The bitrate of the video stream. Unit: bit/s.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Codec' => [ + 'title' => 'description', + 'description' => 'The encoding format of the video stream.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '64', + ], + ], + ], + 'LiveRecord' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information of a stream ingest record.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'title' => 'description', + 'description' => 'The start time of stream ingest, which is in the ISO8601 format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2016-07-30T01:53:21.000Z', + ], + 'EndTime' => [ + 'title' => 'description', + 'description' => 'The end time of stream ingest, which is in the ISO8601 format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2016-07-30T01:53:31.000Z', + ], + 'RemoteAddr' => [ + 'title' => 'description', + 'description' => 'The IP address of the stream ingest client.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '10.101.194.148:57632', + ], + ], + ], + 'LocationTransferType' => [ + 'title' => 'The container that stores regions in which the destination bucket can be located with the TransferType information', + 'description' => 'The container that stores regions in which the destination bucket can be located with the TransferType information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Location' => [ + 'title' => 'The region in which the destination bucket can be located', + 'description' => 'The regions in which the destination bucket can be located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-beijing', + ], + 'TransferTypes' => [ + 'title' => 'The container that stores the transmission type', + 'description' => 'The container that stores the transfer type.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'The link used to transfer data in Cross-region replication', + 'description' => 'The data transfer type that is used to transfer data in data replication. Valid values:'."\n" + ."\n" + .'* internal (default): the default data transfer link used in OSS.'."\n" + .'* oss_acc: the link in which data transmission is accelerated. You can set TransferType to oss_acc only when you create CRR rules.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss_acc', + ], + ], + ], + ], + ], + 'LoggingEnabled' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information about access log collection.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TargetBucket' => [ + 'title' => 'The bucket that stores access logs.', + 'description' => 'The bucket that stores access logs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + 'TargetPrefix' => [ + 'title' => 'The prefix that is contained in the names of the log objects stored in the bucket.', + 'description' => 'The prefix of the log objects. This parameter can be left empty.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'MyLog-', + ], + ], + ], + 'MetaQuery' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the query conditions.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '', + 'description' => 'The pagination token used to obtain information in the next request. The object information is returned in alphabetical order starting from the value of NextToken.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'MaxResults' => [ + 'title' => '', + 'description' => 'The maximum number of objects to return. Valid values: 0 to 100. If this parameter is not set or is set to 0, up to 100 objects are returned.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Query' => [ + 'title' => '', + 'description' => 'The query conditions. A query condition includes the following elements:'."\n" + ."\n" + .'* Operation: the operator. Valid values: eq (equal to), gt (greater than), gte (greater than or equal to), lt (less than), lte (less than or equal to), match (fuzzy query), prefix (prefix query), and (AND), or (OR), and not (NOT).'."\n" + .'* Field: the field name.'."\n" + .'* Value: the field value.'."\n" + .'* SubQueries: the subquery conditions. Options that are included in this element are the same as those of simple query. You need to set subquery conditions only when Operation is set to and, or, or not.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => '{"Field": "Size","Value": "1048576","Operation": "gt"}', + ], + 'Sort' => [ + 'title' => '', + 'description' => 'The field based on which the results are sorted.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Size', + ], + 'Order' => [ + 'description' => 'The sort order.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/MetaQueryOrder', + ], + 'Aggregations' => [ + 'title' => '', + 'description' => 'The container that stores the information about aggregate operations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Aggregation' => [ + 'title' => '', + 'description' => 'The container that stores the information about a single aggregate operation.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores period operation information.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/MetaQueryAggregation', + ], + ], + ], + ], + ], + ], + 'MetaQueryAggregation' => [ + 'title' => '', + 'description' => 'The container that stores the information about aggregate operations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '', + 'description' => 'The field name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '', + 'description' => 'The operator for aggregate operations.'."\n" + ."\n" + .'* min'."\n" + .'* max'."\n" + .'* average'."\n" + .'* sum'."\n" + .'* count'."\n" + .'* distinct'."\n" + .'* group'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'sum', + ], + ], + ], + 'MetaQueryAggregationsResult' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Size', + ], + 'Operation' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'sum', + ], + 'Value' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '200', + ], + 'Groups' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Group' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '100', + ], + 'Count' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'MetaQueryFile' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Filename' => [ + 'title' => '', + 'description' => 'The full path of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'exampleobject.txt', + ], + 'Size' => [ + 'title' => '', + 'description' => 'The object size.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'FileModifiedTime' => [ + 'title' => '', + 'description' => 'The time when the object was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-06-29T15:04:05.000000000Z07:00', + ], + 'OSSObjectType' => [ + 'title' => '', + 'description' => 'The type of the object.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Multipart'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The object is uploaded by using multipart upload'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* Symlink'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The object is a symbolic link that was created by calling the PutSymlink operation.'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Appendable'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The object is uploaded by using AppendObject'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* Normal'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The object is uploaded by using PutObject'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Multipart' => '', + 'Symlink' => '', + 'Appendable' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + 'OSSStorageClass' => [ + 'title' => '', + 'description' => 'The storage class of the object.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Archive'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' the Archive storage class'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* ColdArchive'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' the Cold Archive storage class'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* IA'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' the Infrequent Access (IA) storage class'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* Standard'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' The Standard storage class'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Archive' => '', + 'ColdArchive' => '', + 'IA' => '', + 'Standard' => '', + ], + 'example' => 'Standard', + ], + 'ObjectACL' => [ + 'title' => '', + 'description' => 'The access control list (ACL) of the object.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* default'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' the ACL of the bucket'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* private'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' private'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* public-read'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' public-read'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n" + ."\n" + .'* public-read-write'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' public-read-write'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' .'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'default' => '', + 'private' => '', + 'public-read' => '', + 'public-read-write' => '', + ], + 'example' => 'default', + ], + 'ETag' => [ + 'title' => '', + 'description' => 'The ETag of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '"fba9dede5f27731c9771645a3986****"', + ], + 'OSSCRC64' => [ + 'title' => '', + 'description' => 'The CRC-64 value of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '4858A48BD1466884', + ], + 'ServerSideEncryption' => [ + 'title' => '', + 'description' => 'The server-side encryption of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'AES256', + ], + 'ServerSideEncryptionCustomerAlgorithm' => [ + 'title' => '', + 'description' => 'The server-side encryption algorithm used when the object was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SM4', + ], + 'OSSTaggingCount' => [ + 'title' => '', + 'description' => 'The number of the tags of the object.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'OSSTagging' => [ + 'title' => '', + 'description' => 'The list of object tags.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Tagging' => [ + 'title' => '', + 'description' => 'The tags.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/MetaQueryTagging', + ], + ], + ], + ], + 'OSSUserMeta' => [ + 'title' => '', + 'description' => 'The container that stores user metadata.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'UserMeta' => [ + 'title' => '', + 'description' => 'The user metadata items.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The user metadata item.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/MetaQueryUserMeta', + ], + ], + ], + ], + ], + ], + 'MetaQueryOrder' => [ + 'title' => 'A short description of struct', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* asc: ascending order.'."\n" + .'* desc (default): descending order.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'asc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + 'MetaQueryResp' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'Files' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'File' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/MetaQueryFile', + ], + ], + ], + ], + 'Aggregations' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Aggregation' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/MetaQueryAggregationsResult', + ], + ], + ], + ], + ], + ], + 'MetaQueryRespAddress' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'AddressLine' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + ], + 'City' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + ], + 'District' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + ], + 'Language' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'zh-Hans', + ], + 'Province' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + ], + 'Township' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + ], + ], + ], + 'MetaQueryRespAudioStream' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CodecName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'aac', + ], + 'Bitrate' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '320087', + ], + 'SampleRate' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '48000', + ], + 'StartTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0235', + ], + 'Duration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '3.690667', + ], + 'Channels' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Language' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'en', + ], + ], + ], + 'MetaQueryRespSubtitle' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CodecName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'mov_text', + ], + 'Language' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'en', + ], + 'StartTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '71.378', + ], + ], + ], + 'MetaQueryRespVideoStream' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CodecName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'h264', + ], + 'Language' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'en', + ], + 'Bitrate' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5407765', + ], + 'FrameRate' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '25/1', + ], + 'StartTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '22.88', + ], + 'FrameCount' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '572', + ], + 'BitDepth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'PixelFormat' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'ColorSpace' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'bt709', + ], + 'Height' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '720', + ], + 'Width' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1280', + ], + ], + ], + 'MetaQueryTagging' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the tag information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'key', + 'description' => 'The tag key.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + ], + 'Value' => [ + 'title' => 'value', + 'description' => 'The tag value.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'MetaQueryUserMeta' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores user metadata.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'key', + 'description' => 'The key of the user metadata item.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + ], + 'Value' => [ + 'title' => 'value', + 'description' => 'The value of the user metadata item.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'ObjectACL' => [ + 'description' => 'The access control list (ACL) of the object. Valid values:'."\n" + ."\n" + .'* default: The ACL of the object is the same as the ACL of the bucket in which the object is stored.'."\n" + .'* private: The ACL of the object is private. Only the owner of the object and authorized users have read and write permissions on the object.'."\n" + .'* public-read: The ACL of the object is public-read. Only the owner of the object and authorized users have read and write permissions on the object. Other users can only read the object. Exercise caution when you set the ACL of the object to this value.'."\n" + .'* public-read-write: The ACL of the object is public-read-write. All users have read and write permissions on the object. Exercise caution when you set the ACL of the object to this value.'."\n" + ."\n" + .'For more information, see \\*\\*[ACL](~~100676~~) \\*\\*.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'public-read', + 'default' => 'default', + 'enum' => [ + 'private', + 'public-read', + 'public-read-write', + 'default', + ], + ], + 'ObjectHashConfiguration' => [ + 'title' => '', + 'description' => 'The Object hash algorithm configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ObjectHashFunction' => [ + 'title' => '', + 'description' => 'The object hash function used in the bucket.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SHA-256', + ], + 'DisplayObjectHash' => [ + 'title' => '', + 'description' => 'Whether display the hash function used in bucket information.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ObjectIdentifier' => [ + 'title' => 'A short description of struct', + 'description' => 'The identifier of the object.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'key', + 'description' => 'The key of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'object_key', + ], + 'VersionId' => [ + 'title' => 'version id', + 'description' => 'The version ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'version_20211101141621_d137', + ], + ], + ], + 'ObjectList' => [ + 'title' => 'A list of the objects.', + 'description' => 'The container that stores information about the object.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The object metadata returned.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ObjectSummary', + ], + 'enumValueTitles' => [], + 'parseType' => 'struct', + ], + 'ObjectProcessConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the processing information about the Object FC Access Point.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'AllowedFeatures' => [ + 'title' => '', + 'description' => 'The container that stores allowed features.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'AllowedFeature' => [ + 'title' => '', + 'description' => 'Specifies that Function Compute supports Range GetObject requests.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Specifies that Function Compute supports Range GetObject requests.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'GetObject-Range', + 'extendType' => 'true', + ], + ], + ], + ], + 'TransformationConfigurations' => [ + 'title' => '', + 'description' => 'The container that stores the transformation configurations.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TransformationConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores the transformation configurations.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Actions' => [ + 'title' => '', + 'description' => 'The container that stores the operations.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'title' => '', + 'description' => 'The supported OSS API operations. Only the GetObject operation is supported.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'Only the GetObject operation is supported.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'GetObject', + 'extendType' => 'true', + ], + ], + ], + ], + 'ContentTransformation' => [ + 'title' => '', + 'description' => 'The container that stores the content of the transformation configurations.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FunctionCompute' => [ + 'title' => '', + 'description' => 'The container that stores the information about Function Compute.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FunctionAssumeRoleArn' => [ + 'title' => '', + 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role that Function Compute uses to access your resources in other cloud services. The default role is AliyunFCDefaultRole.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'acs:ram::111933544165****:role/aliyunfcdefaultrole', + ], + 'FunctionArn' => [ + 'title' => '', + 'description' => 'The ARN of the function. For more information,', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'acs:fc:cn-qingdao:111933544165****:services/test-oss-fc.LATEST/functions/fc-01', + ], + ], + ], + ], + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'ObjectSummary' => [ + 'title' => 'The OSS object summary information.', + 'description' => 'The object metadata returned.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'The name of the object.', + 'description' => 'The key of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'fun/test.jpg', + ], + 'LastModified' => [ + 'title' => 'The last modification time of the object.', + 'description' => 'The time when the object was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2012-02-24T08:42:32.000Z', + ], + 'ETag' => [ + 'title' => 'The entity tag is a hash of the object.', + 'description' => 'The ETag that is generated when an object is created. ETags are used to identify the content of objects.'."\n" + ."\n" + .'* For an object that is created by calling the PutObject operation, the ETag value of the object is the MD5 hash of its content.'."\n" + .'* For an object that is created by using another method, the ETag value is not the MD5 hash of the object content but a unique value calculated based on a specific rule.'."\n" + .'* The ETag of an object can be used to check whether the object content is modified. We recommend that you use the MD5 hash of an object rather than the ETag of it to verify data integrity.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '5B3C1A2E053D763E1B002CC607C5A0FE1****', + ], + 'Type' => [ + 'title' => 'The type of the object.', + 'description' => 'The types of the returned objects.'."\n" + ."\n" + .'* Normal: Objects created by using simple upload.'."\n" + .'* Multipart: Objects created by using multipart upload.'."\n" + .'* Appendable: Objects created by using append upload. You can append content to objects only of the Appendable type.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Size' => [ + 'title' => 'The size in bytes of the object', + 'description' => 'The sizes of the returned objects. Unit: byte.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '344606', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class of the object.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/StorageClass', + ], + 'Owner' => [ + 'title' => '', + 'description' => 'The container for the information about the bucket owner.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Owner', + ], + 'RestoreInfo' => [ + 'title' => '', + 'description' => 'The restoration status of the object.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ongoing-request="true”', + ], + 'TransitionTime' => [ + 'title' => '', + 'description' => 'The time when the storage class of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2012-02-24T08:42:32.000Z', + ], + ], + ], + 'ObjectVersion' => [ + 'title' => 'The version of an object', + 'description' => 'The container that stores the versions of objects, excluding delete markers.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'The name of the object', + 'description' => 'The name of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example', + ], + 'VersionId' => [ + 'title' => 'The version ID of the object', + 'description' => 'The version ID of the object.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****', + ], + 'IsLatest' => [ + 'title' => 'Indicates whether the version is the current version', + 'description' => 'Indicates whether the version of the object is the current version. Valid values:'."\n" + ."\n" + .'* true: The version is the current version.'."\n" + .'* false: The version is a previous version.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'false', + ], + 'LastModified' => [ + 'title' => 'The last modified time of the object', + 'description' => 'The time when the object was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2019-04-09T07:27:28.000Z', + ], + 'ETag' => [ + 'title' => 'The entity tag', + 'description' => 'The ETag that is generated when an object is created. ETags are used to identify the content of objects.'."\n" + ."\n" + .'* For an object that is created by calling the PutObject operation, the ETag value of the object is the MD5 hash of its content.'."\n" + .'* For an object that is created by using another method, the ETag value is not the MD5 hash of the object content but a unique value calculated based on a specific rule.'."\n" + ."\n" + .'> The ETag value of an object can be used only to check whether the content of the object is modified. We recommend that you use the MD5 hash of an object rather than the ETag of it to verify data integrity.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '250F8A0AE989679A22926A875F0A2****', + ], + 'Size' => [ + 'title' => 'The size of the returned object', + 'description' => 'The size of the object.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '93731', + ], + 'StorageClass' => [ + 'title' => '', + 'description' => 'The storage class of the object.'."\n", + 'visibility' => 'public', + 'example' => 'Standard', + '$ref' => '#/components/schemas/StorageClass', + ], + 'Owner' => [ + 'title' => 'The information about the bucket owner', + 'description' => 'The container for the information about the bucket owner.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/Owner', + ], + 'RestoreInfo' => [ + 'title' => '', + 'description' => 'The restoration status of the object version.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ongoing-request="true"', + ], + 'TransitionTime' => [ + 'title' => '', + 'description' => 'The time when a version of the object is converted to Cold Archive or Deep Cold Archive based on lifecycle rules.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2023-04-09T07:27:28.000Z', + ], + ], + ], + 'OutputSerialization' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'CSV' => [ + 'sdkPropertyName' => 'csv', + 'description' => 'The output parameters when the CSV object is queried.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/CSVOutput', + ], + 'JSON' => [ + 'sdkPropertyName' => 'json', + 'description' => 'The output parameters when the JSON object is queried.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/JSONOutput', + ], + 'KeepAllColumns' => [ + 'title' => 'description', + 'description' => 'Optional. Specifies whether all columns in the CSV object are included in the returned result.\\'."\n" + .'Default value: false.\\'."\n" + .'This parameter has a value only for columns included in the SELECT statement. The columns in the response are sorted in ascending order of the column numbers. Example:\\'."\n" + .'`select _5, _1 from ossobject.`\\'."\n" + .'If you set KeepAllColumns to true and six columns are included in the CSV object, the following result is returned for the preceding SELECT statement:\\'."\n" + .'`Value of 1st column,,,,Value of 5th column,\\n`'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'OutputHeader' => [ + 'title' => 'description', + 'description' => 'Specifies whether the header information about the CSV object is included in the beginning of the response.\\'."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'OutputRawData' => [ + 'title' => 'description', + 'description' => 'Specifies whether to export raw data.'."\n" + ."\n" + .'* If you specify OutputRawData in the request, Object Storage Service (OSS) returns data based on the request element.'."\n" + .'* If you do not specify OutputRawData in the request, OSS automatically selects a format and returns data in the selected format in the response.'."\n" + .'* If you set OutputRawData to true and it takes a long time for the sent SQL statement to return data, the HTTP request may time out.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'EnablePayloadCrc' => [ + 'title' => 'description', + 'description' => 'The CRC-32 value for verification of each frame. The client can calculate the CRC-32 value of each payload and compare it with the included CRC-32 value to verify data integrity.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'OverwriteConfiguration' => [ + 'title' => '', + 'description' => 'The structure for the overwrite protection configuration.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => '', + 'description' => 'List of overwrite protection rules. A bucket can have a maximum of 100 rules.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '', + 'description' => 'The unique identifier of the rule. If you do not specify this element, a UUID is randomly generated. If you specify this element, the value must be unique. Different rules cannot have the same ID.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'forbid-write-rule1', + ], + 'Action' => [ + 'title' => '', + 'description' => 'The operation type. Currently, only `forbid` (prohibit overwrites) is supported.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'forbid', + ], + 'Prefix' => [ + 'title' => '', + 'description' => 'The prefix of object names to filter the objects that you want to process. The maximum length is 1,023 characters. Each rule can have at most one prefix. Prefixes and suffixes do not support regular expressions.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a/', + ], + 'Suffix' => [ + 'title' => '', + 'description' => 'The suffix of object names to filter the objects that you want to process. The maximum length is 1,023 characters. Each rule can have at most one suffix. Prefixes and suffixes do not support regular expressions.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '.txt', + ], + 'Principals' => [ + 'title' => '', + 'description' => 'A collection of authorized entities. The usage is similar to the `Principal` element in a bucket policy. You can specify an Alibaba Cloud account, a RAM user, or a RAM role. If this element is empty or not configured, overwrites are prohibited for all objects that match the prefix and suffix conditions.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Principal' => [ + 'title' => '', + 'description' => 'A collection of authorized entities. The usage is similar to the `Principal` element in a bucket policy. You can specify an Alibaba Cloud account, a RAM user, or a RAM role. If this element is empty or not configured, overwrites are prohibited for all objects that match the prefix and suffix conditions.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The authorized entity. You can specify an Alibaba Cloud account, a RAM user, or a RAM role. If this element is empty, the setting is invalid.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '27737962156157xxxx', + 'extendType' => 'true', + ], + ], + ], + ], + ], + 'extendType' => 'true', + 'description' => 'An overwrite protection rule.', + ], + ], + ], + ], + 'Owner' => [ + 'title' => 'Container for the owner\'s display name and ID', + 'description' => 'The container for the information about the bucket owner.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => 'The ID of the owner', + 'description' => 'The user ID of the bucket owner.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ut_test_put_bucket', + ], + 'DisplayName' => [ + 'title' => 'The display name of the owner', + 'description' => 'The name of the bucket owner, which is the same as the user ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ut_test_put_bucket', + ], + ], + ], + 'Part' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the uploaded parts.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ETag' => [ + 'title' => 'description', + 'description' => 'The ETag value that is returned by OSS after the part is uploaded.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '3349DC700140D7F86A0784842780****', + ], + 'PartNumber' => [ + 'title' => 'description', + 'description' => 'The part number.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => 'description', + 'description' => 'The size of the part.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6291456', + ], + 'LastModified' => [ + 'title' => 'description', + 'description' => 'The time when the part was uploaded.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2012-02-23T07:01:34.000Z', + ], + ], + ], + 'PublicAccessBlockConfiguration' => [ + 'title' => '', + 'description' => 'The container in which the Block Public Access configurations are stored.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'BlockPublicAccess' => [ + 'title' => '', + 'description' => 'Specifies whether to enable Block Public Access.'."\n" + ."\n" + .'true: enables Block Public Access.'."\n" + ."\n" + .'false (default): disables Block Public Access.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'PutReplicationRule' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'first-repl-rule', + ], + 'PrefixSet' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/ReplicationPrefixSet', + ], + 'Action' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Destination' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/ReplicationDestination', + ], + 'HistoricalObjectReplication' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'disabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'SyncRole' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'aliyunramrole', + ], + 'SourceSelectionCriteria' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', + ], + 'EncryptionConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', + ], + 'RTC' => [ + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/RTC', + ], + ], + ], + 'QoSConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TotalUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IntranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExtranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IntranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ExtranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'IntranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ExtranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + ], + ], + 'QoSConfigurationWithRemark' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TotalUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IntranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExtranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IntranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ExtranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'IntranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ExtranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'Remark' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '', + ], + ], + ], + 'RefererConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the hotlink protection configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'AllowEmptyReferer' => [ + 'title' => '', + 'description' => 'Specifies whether to allow a request whose Referer field is empty. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'default' => 'true', + ], + 'AllowTruncateQueryString' => [ + 'title' => 'description', + 'description' => 'Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'TruncatePath' => [ + 'title' => '', + 'description' => 'Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'RefererList' => [ + 'title' => '', + 'description' => 'The container that stores the Referer whitelist.'."\n" + ."\n" + .'> ****The PutBucketReferer operation overwrites the existing Referer whitelist with the Referer whitelist specified in RefererList. If RefererList is not specified in the request, which specifies that no Referer elements are included, the operation clears the existing Referer whitelist.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Referer' => [ + 'title' => '', + 'description' => 'The addresses in the Referer whitelist.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'An address in the Referer whitelist.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + 'extendType' => 'true', + ], + ], + ], + 'required' => true, + ], + 'RefererBlacklist' => [ + 'title' => '', + 'description' => 'The container that stores the Referer blacklist.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Referer' => [ + 'title' => '', + 'description' => 'The addresses in the Referer blacklist.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://www.abc.com', + 'extendType' => 'true', + ], + ], + ], + ], + ], + ], + 'RegionInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the region.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => 'region', + 'description' => 'The region ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + 'InternetEndpoint' => [ + 'title' => 'internet endpoint', + 'description' => 'The public endpoint of the region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + 'InternalEndpoint' => [ + 'title' => 'internal endpoint', + 'description' => 'The internal endpoint of the region.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', + ], + 'AccelerateEndpoint' => [ + 'title' => 'accelerate endpoint', + 'description' => 'The acceleration endpoint of the region. The value is always oss-accelerate.aliyuncs.com.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss-accelerate.aliyuncs.com', + ], + ], + ], + 'ReplicationConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The data replication configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => '', + 'description' => 'The container that stores data replication rules.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationRule', + ], + ], + ], + 'ReplicationDestination' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information about the destination bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => 'The destination bucket to which the data is replicated', + 'description' => 'The destination bucket to which data is replicated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'target-bucket', + ], + 'Location' => [ + 'title' => 'The region in which the destination bucket is located', + 'description' => 'The region in which the destination bucket is located.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'oss-cn-beijing', + ], + 'TransferType' => [ + 'title' => 'The link used to transfer data in CRR', + 'description' => 'The link that is used to transfer data during data replication. Valid values:'."\n" + ."\n" + .'* internal (default): the default data transfer link used in OSS.'."\n" + .'* oss_acc: the transfer acceleration link. You can set TransferType to oss_acc only when you create CRR rules.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'oss_acc', + ], + ], + ], + 'ReplicationEncryptionConfiguration' => [ + 'title' => '', + 'description' => 'Encryption configuration for the replication rule.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ReplicaKmsKeyID' => [ + 'title' => '', + 'description' => 'The KMS key ID used for replication.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'c4d49f85-ee30-426b-a5ed-95e9139dxxxxx', + ], + ], + ], + 'ReplicationPrefixSet' => [ + 'title' => 'The container that stores prefixes', + 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'sdkPropertyName' => 'Prefixs', + 'title' => 'Prefixs used to specify the object to replicate', + 'description' => 'The prefix that is used to specify the object that you want to replicate. Only objects whose names contain the specified prefix are replicated to the destination bucket.'."\n" + ."\n" + .'* The value of the Prefix parameter can be up to 1,023 characters in length.'."\n" + .'* If you specify the Prefix parameter in a data replication rule, OSS synchronizes new data and historical data based on the value of the Prefix parameter.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The prefix that is used to specify the object that you want to replicate. Only objects whose names contain the specified prefix are replicated to the destination bucket.'."\n" + ."\n" + .'* The value of the Prefix parameter can be up to 1,023 characters in length.'."\n" + .'* If you specify the Prefix parameter in a data replication rule, OSS synchronizes new data and historical data based on the value of the Prefix parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'video', + 'extendType' => 'true', + ], + ], + ], + ], + 'ReplicationProgressRule' => [ + 'title' => 'A short description of struct', + 'description' => 'Information about the progress of the data replication task.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => 'rule id', + 'description' => 'The ID of the data replication rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test_replication_1', + ], + 'PrefixSet' => [ + 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationPrefixSet', + ], + 'Action' => [ + 'title' => 'A short description of action', + 'description' => 'The operations that are synchronized to the destination bucket.'."\n" + ."\n" + .'* ALL: PUT, DELETE, and ABORT operations are synchronized to the destination bucket.'."\n" + .'* PUT: Write operations are synchronized to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'ALL' => 'PUT/DELETE/ABORT操作都会同步', + 'PUT' => '仅同步写入类操作', + ], + 'example' => 'ALL', + ], + 'Destination' => [ + 'description' => 'The container that stores the information about the destination bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationDestination', + ], + 'Status' => [ + 'title' => 'A short description of action', + 'description' => 'The status of the data replication task. Valid values:'."\n" + ."\n" + .'* starting: OSS creates a data replication task after a data replication rule is configured.'."\n" + .'* doing: The replication rule is effective and the replication task is in progress.'."\n" + .'* closing: OSS clears a data replication task after the corresponding data replication rule is deleted.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'doing', + ], + 'HistoricalObjectReplication' => [ + 'title' => 'A short description of HistoricalObjectReplication', + 'description' => 'Specifies whether to replicate historical data that exists before data replication is enabled from the source bucket to the destination bucket.'."\n" + ."\n" + .'* enabled (default): replicates historical data to the destination bucket.'."\n" + .'* disabled: ignores historical data and replicates only data uploaded to the source bucket after data replication is enabled for the source bucket.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '不复制历史数据', + 'enabled' => '复制历史数据', + ], + 'example' => 'enabled', + ], + 'Progress' => [ + 'title' => 'A short description of Progress', + 'description' => 'The container that stores the progress of the data replication task. This parameter is returned only when the data replication task is in the doing state.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'HistoricalObject' => [ + 'title' => 'A short description of HistoricalObject', + 'description' => 'The percentage of the replicated historical data. This parameter is valid only when HistoricalObjectReplication is set to enabled.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0.85', + ], + 'NewObject' => [ + 'title' => 'A short description of NewObject', + 'description' => 'The time used to determine whether data is replicated to the destination bucket. Data that is written to the source bucket before the time is replicated to the destination bucket. The value of this parameter is in the GMT format. Example: Thu, 24 Sep 2015 15:39:18 GMT.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Thu, 24 Sep 2015 15:39:18 GMT', + ], + ], + ], + ], + ], + 'ReplicationRule' => [ + 'title' => 'A short description of struct', + 'description' => 'The data replication rule configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => 'rule id', + 'description' => 'The ID of the rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test_replication_1', + ], + 'PrefixSet' => [ + 'title' => '', + 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationPrefixSet', + ], + 'Action' => [ + 'title' => 'A short description of action', + 'description' => 'The operations that can be synchronized to the destination bucket. If you configure Action in a data replication rule, OSS synchronizes new data and historical data based on the specified value of Action. You can set Action to one or more of the following operation types. Valid values:'."\n" + ."\n" + .'* ALL (default): PUT, DELETE, and ABORT operations are synchronized to the destination bucket.'."\n" + .'* PUT: Write operations are synchronized to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'PUT', + ], + 'Destination' => [ + 'title' => '', + 'description' => 'The container that stores the information about the destination bucket.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationDestination', + ], + 'Status' => [ + 'title' => 'A short description of action', + 'description' => 'The status of the data replication task. Valid values:'."\n" + ."\n" + .'* starting: OSS creates a data replication task after a data replication rule is configured.'."\n" + .'* doing: The replication rule is effective and the replication task is in progress.'."\n" + .'* closing: OSS clears a data replication task after the corresponding data replication rule is deleted.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'starting', + ], + 'HistoricalObjectReplication' => [ + 'title' => 'A short description of HistoricalObjectReplication', + 'description' => 'Specifies whether to replicate historical data that exists before data replication is enabled from the source bucket to the destination bucket. Valid values:'."\n" + ."\n" + .'* enabled (default): replicates historical data to the destination bucket.'."\n" + .'* disabled: does not replicate historical data to the destination bucket. Only data uploaded to the source bucket after data replication is enabled for the source bucket is replicated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'enabled', + 'enum' => [ + 'enabled', + 'disabled', + ], + ], + 'SyncRole' => [ + 'title' => 'A short description of SyncRole', + 'description' => 'The role that you want to authorize OSS to use to replicate data. If you want to use SSE-KMS to encrypt the objects that are replicated to the destination bucket, you must specify this parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'aliyunramrole', + ], + 'SourceSelectionCriteria' => [ + 'title' => '', + 'description' => 'The container that specifies other conditions used to filter the source objects that you want to replicate. Filter conditions can be specified only for source objects encrypted by using SSE-KMS.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', + ], + 'EncryptionConfiguration' => [ + 'title' => 'A short description of EncryptionConfiguration', + 'description' => 'The encryption configuration for the objects replicated to the destination bucket. If the Status parameter is set to Enabled, you must specify this parameter.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', + ], + 'RTC' => [ + 'description' => 'The container that stores the status of the RTC feature.', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/RTC', + 'title' => '保存RTC状态规则的容器。', + ], + ], + ], + 'ReplicationRuleProgress' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the progress information of data replication rule.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => 'id', + 'description' => 'The ID of the data replication rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test_replication_rule_1', + ], + 'PrefixSet' => [ + 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each data replication rule.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ReplicationPrefixSet', + ], + 'Action' => [ + 'title' => 'action', + 'description' => 'The operations that are synchronized to the destination bucket. You can set Action to one or more of the following operation types.'."\n" + ."\n" + .'* ALL: PUT, DELETE, and ABORT operations are synchronized to the destination bucket.'."\n" + .'* PUT: Write operations are synchronized to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ALL', + ], + ], + ], + 'ReplicationRules' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the data replication rule that you want to delete.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'sdkPropertyName' => 'ids', + 'title' => 'the container of id', + 'description' => 'The ID of data replication rules that you want to delete. You can call the GetBucketReplication operation to obtain the ID.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the data replication rule to delete. You can call the GetBucketReplication operation to obtain the ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test_replication_1', + 'extendType' => 'true', + ], + ], + ], + ], + 'ReplicationSourceSelectionCriteria' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that specifies other conditions used to filter the source objects that you want to replicate. Filter conditions can be specified only for source objects encrypted by using SSE-KMS.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SseKmsEncryptedObjects' => [ + 'title' => 'A short description of SseKmsEncryptedObjects', + 'description' => 'The container that is used to filter the source objects that are encrypted by using SSE-KMS. This parameter must be specified if the SourceSelectionCriteria parameter is specified in the data replication rule.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => 'A short description of Status', + 'description' => 'Specifies whether to replicate objects that are encrypted by using SSE-KMS. Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + .'* Disabled'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Enabled', + ], + ], + ], + ], + 'xml' => [ + 'name' => 'SourceSelectionCriteria', + ], + ], + 'RequesterQoSInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Requester' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '21234567890090', + ], + 'QoSConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/QoSConfiguration', + ], + ], + ], + 'RequestPaymentConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores payment configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Payer' => [ + 'title' => 'description', + 'description' => 'The payer of the request and traffic fees. Valid values:'."\n" + ."\n" + .'* BucketOwner: The bucket owner is charged request fees and traffic fees.'."\n" + .'* Requester: The requester is charged request fees and traffic fees.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Requester', + ], + ], + ], + 'ResourceGroupId' => [ + 'title' => '', + 'description' => 'The ID of the resource group.'."\n" + ."\n" + .'* If you include this header and specify the ID of the resource group in the request, Object Storage Service (OSS) returns all buckets that belong to the resource group. If the resource group ID is set to rg-default-id, OSS returns all buckets that belong to the default resource group.'."\n" + .'* If you include this header in the request but you do not specify a resource group ID in the request, OSS returns all buckets that belong to the default resource group.'."\n" + .'* If this header is not included in the request, OSS returns all buckets owned by the requester. You can obtain the ID of a resource group in the Resource Management console or by calling the ListResourceGroups operation.'."\n" + ."\n" + .'You can obtain the ID of a resource group in the Resource Management console or by calling the ListResourceGroups operation. For more information, see [View basic information of a resource group](~~151181~~) and [ListResourceGroups](~~158855~~).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'rg-aekz****', + ], + 'ResourcePoolBucket' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'JoinTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2024-07-24T08:42:32.000Z', + ], + ], + ], + 'ResourcePoolSimpleInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'rp-for-api', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2024-07-24T08:42:32.000Z', + ], + ], + ], + 'ResponseHeaderConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'hiddenHeader', + ], + 'Filters' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'GetObject', + 'extendType' => 'true', + ], + ], + ], + ], + 'HideHeaders' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Header' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'LastModifiedTime', + 'extendType' => 'true', + ], + ], + ], + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + 'RestoreRequest' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores information about the RestoreObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Days' => [ + 'title' => 'description', + 'description' => 'The duration in which the object can remain in the restored state. Unit: days. Valid values: 1 to 7.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'JobParameters' => [ + 'title' => 'description', + 'description' => 'The container that stores the restoration priority coniguration. This configuration takes effect only when the request is sent to restore Cold Archive objects. If you do not specify the JobParameters parameter, the default restoration priority Standard is used.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Tier' => [ + 'title' => 'description', + 'description' => 'The restoration priority. Valid values:'."\n" + ."\n" + .'* Expedited: The object is restored within 1 hour.'."\n" + .'* Standard: The object is restored within 2 to 5 hours.'."\n" + .'* Bulk: The object is restored within 5 to 12 hours.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + ], + 'RoutingRule' => [ + 'title' => 'A short description of struct', + 'description' => 'The container for the redirection rule or mirroring-based back-to-origin rule. You can specify up to 20 rules.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RuleNumber' => [ + 'title' => 'description', + 'description' => 'The sequence number that is used to match and run the redirection rules. OSS matches redirection rules based on this parameter. If a match succeeds, only the rule is run and the subsequent rules are not run.'."\n" + ."\n" + .'> This parameter must be specified if RoutingRule is specified.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Condition' => [ + 'title' => 'description', + 'description' => 'The matching condition. If all of the specified conditions are met, the rule is run. A rule is considered matched only when the rule meets the conditions that are specified by all nodes in Condition.'."\n" + ."\n" + .'> This parameter must be specified if RoutingRule is specified.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/RoutingRuleCondition', + ], + 'Redirect' => [ + 'title' => 'description', + 'description' => 'The operation to perform after the rule is matched.'."\n" + ."\n" + .'> This parameter must be specified if RoutingRule is specified.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/RoutingRuleRedirect', + ], + 'LuaConfig' => [ + 'title' => '该规则需要执行的Lua脚本配置。', + 'description' => 'The Lua script config of this rule.', + 'visibility' => 'Private', + '$ref' => '#/components/schemas/RoutingRuleLuaConfig', + ], + ], + ], + 'RoutingRuleCondition' => [ + 'title' => 'A short description of struct', + 'description' => 'The matching condition. If all of the specified conditions are met, the rule is run. A rule is considered matched only when the rule meets the conditions that are specified by all nodes in Condition.'."\n" + ."\n" + .'> This parameter must be specified if RoutingRule is specified.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'KeyPrefixEquals' => [ + 'title' => 'A short description of struct', + 'description' => 'The prefix of object names. Only objects whose names contain the specified prefix match the rule.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'abc', + ], + 'KeySuffixEquals' => [ + 'title' => '只有匹配此后缀的Object才能匹配此规则。', + 'description' => 'Only Objects that match this suffix can match this rule.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '.txt', + ], + 'HttpErrorCodeReturnedEquals' => [ + 'title' => 'A short description of struct', + 'description' => 'The HTTP status code. The rule is matched only when the specified object is accessed and the specified HTTP status code is returned. If the redirection rule is the mirroring-based back-to-origin rule, the value of this parameter is 404.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '404', + ], + 'IncludeHeader' => [ + 'title' => '只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。', + 'description' => 'The rule will only be matched when the request contains the specified Header with the specified value. Up to 10 of these can be specified in the container.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '只有请求中包含了此Header且值为Equals的指定值时，才能匹配此规则。', + 'description' => 'The rule will only be matched when the request contains this Header and its value is equal to the specified value.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-header', + ], + 'Equals' => [ + 'title' => '只有请求中包含了Key指定的Header且值为指定值时，才能匹配此规则。', + 'description' => 'The rule will only be matched when the request contains this Header and its value is equal to the specified value.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-value', + ], + 'StartsWith' => [ + 'title' => '只有请求中包含了Key指定的Header且值以该值为开头时，才能匹配此规则。', + 'description' => 'The rule will only be matched when the request contains this Header and its value starts with the specified value.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'test-prefix-', + ], + 'EndsWith' => [ + 'title' => '只有请求中包含了Key指定的Header且值以该值为结尾时，才能匹配此规则。', + 'description' => 'The rule will only be matched when the request contains this Header and its value ends with the specified value.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => '-test-suffix', + ], + ], + 'extendType' => 'true', + 'description' => 'The pattern of the headers.', + ], + ], + ], + ], + 'RoutingRuleLuaConfig' => [ + 'title' => '', + 'description' => 'Lua script config for the routing rule.', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'title' => '', + 'description' => 'The name of the Lua script.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test.lua', + ], + ], + ], + 'RoutingRuleRedirect' => [ + 'title' => 'A short description of struct', + 'description' => 'The operation to perform after the rule is matched.'."\n" + ."\n" + .'> This parameter must be specified if RoutingRule is specified.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RedirectType' => [ + 'title' => 'description', + 'description' => 'The redirection type. Valid values:'."\n" + ."\n" + .'* **Mirror**: mirroring-based back-to-origin.'."\n" + .'* **External**: external redirection. OSS returns an HTTP 3xx status code and returns an address for you to redirect to.'."\n" + .'* **AliCDN**: redirection based on Alibaba Cloud CDN. Compared with external redirection, OSS adds an additional header to the request. After Alibaba Cloud CDN identifies the header, Alibaba Cloud CDN redirects the access to the specified address and returns the obtained data instead of the HTTP 3xx status code that redirects the access to another address.'."\n" + ."\n" + .'> This parameter must be specified if Redirect is specified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Mirror', + ], + 'PassQueryString' => [ + 'title' => 'description', + 'description' => 'Specifies whether to include parameters of the original request in the redirection request when the system runs the redirection rule or mirroring-based back-to-origin rule. For example, if the **PassQueryString** parameter is set to true, the `?a=b&c=d` parameter string is included in a request sent to OSS, and the redirection mode is 302, this parameter is added to the Location header. For example, if the request is `Location:example.com?a=b&c=d` and the redirection type is mirroring-based back-to-origin, the ?a=b\\&c=d parameter string is also included in the back-to-origin request. Valid values: true and false (default).'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'MirrorURL' => [ + 'title' => 'description', + 'description' => 'The origin URL for mirroring-based back-to-origin. This parameter takes effect only when the value of RedirectType is Mirror. The origin URL must start with \\*\\*http://** or **https://\\*\\* and end with a forward slash (/). OSS adds an object name to the end of the URL to generate a back-to-origin URL. For example, the name of the object to access is myobject. If MirrorURL is set to `http://example.com/`, the back-to-origin URL is `http://example.com/myobject`. If MirrorURL is set to `http://example.com/dir1/`, the back-to-origin URL is `http://example.com/dir1/myobject`.'."\n" + ."\n" + .'> This parameter must be specified if RedirectType is set to Mirror.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'http://example.com', + ], + 'MirrorSNI' => [ + 'title' => '是否透传SNI', + 'description' => '是否透传SNI', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MirrorPassQueryString' => [ + 'title' => 'description', + 'description' => 'This parameter plays the same role as PassQueryString and has a higher priority than PassQueryString. This parameter takes effect only when the value of RedirectType is Mirror. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'MirrorFollowRedirect' => [ + 'title' => 'description', + 'description' => 'Specifies whether to redirect the access to the address specified by Location if the origin returns an HTTP 3xx status code. This parameter takes effect only when the value of RedirectType is Mirror. For example, when a mirroring-based back-to-origin request is initiated, the origin returns 302 and Location is specified.'."\n" + ."\n" + .'* If you set MirrorFollowRedirect to true, OSS continues requesting the resource at the address specified by Location. The access can be redirected up to 10 times. If the access is redirected more than 10 times, the mirroring-based back-to-origin request fails.'."\n" + .'* If you set MirrorFollowRedirect to false, OSS returns 302 and passes through Location.'."\n" + ."\n" + .'Default value: true.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'MirrorCheckMd5' => [ + 'title' => 'description', + 'description' => 'Specifies whether to check the MD5 hash of the body of the response returned by the origin. This parameter takes effect only when the value of RedirectType is Mirror. When **MirrorCheckMd5** is set to true and the response returned by the origin includes the Content-Md5 header, OSS checks whether the MD5 hash of the obtained data matches the header value. If the MD5 hash of the obtained data does not match the header value, the obtained data is not stored in OSS. Default value: false.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'MirrorHeaders' => [ + 'title' => 'description', + 'description' => 'The headers contained in the response that is returned when you use mirroring-based back-to-origin. This parameter takes effect only when the value of RedirectType is Mirror.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'PassAll' => [ + 'title' => 'description', + 'description' => 'Specifies whether to pass through all request headers other than the following headers to the origin. This parameter takes effect only when the value of RedirectType is Mirror.'."\n" + ."\n" + .'* Headers such as content-length, authorization2, authorization, range, and date'."\n" + .'* Headers that start with oss-, x-oss-, and x-drs-'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'Pass' => [ + 'title' => 'description', + 'description' => 'The headers to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each specified header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The header to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each specified header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'myheader-key1', + 'extendType' => 'true', + ], + ], + 'Remove' => [ + 'title' => 'description', + 'description' => 'The headers that are not allowed to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers. This parameter is used together with PassAll.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The header that are not allowed to pass through to the origin. This parameter takes effect only when the value of RedirectType is Mirror. Each header can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). You can specify up to 10 headers. This parameter is used together with PassAll.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'myheader-key3', + 'extendType' => 'true', + ], + ], + 'Set' => [ + 'title' => 'description', + 'description' => 'The headers that are sent to the origin. The specified headers are configured in the data returned by the origin regardless of whether the headers are contained in the request. This parameter takes effect only when the value of RedirectType is Mirror. You can specify up to 10 headers.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'description', + 'description' => 'The key of the header. The key can be up to 1,024 bytes in length and can contain only letters, digits, and hyphens (-). This parameter takes effect only when the value of RedirectType is Mirror.'."\n" + ."\n" + .'> This parameter must be specified if Set is specified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'myheader-key5', + ], + 'Value' => [ + 'title' => 'description', + 'description' => 'The value of the header. The value can be up to 1,024 bytes in length and cannot contain `\\r\\n`. This parameter takes effect only when the value of RedirectType is Mirror.'."\n" + ."\n" + .'> This parameter must be specified if Set is specified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'myheader-value5', + ], + ], + 'extendType' => 'true', + ], + ], + ], + ], + 'Protocol' => [ + 'title' => 'description', + 'description' => 'The protocol used for redirection. This parameter takes effect only when RedirectType is set to External or AliCDN. For example, if you access an object named test, Protocol is set to https, and Hostname is set to `example.com`, the value of the Location header is `https://example.com/test`. Valid values: **http** and **https**.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'http', + ], + 'HostName' => [ + 'title' => 'description', + 'description' => 'The domain name used for redirection. The domain name must comply with the domain naming rules. For example, if you access an object named test, Protocol is set to https, and Hostname is set to `example.com`, the value of the Location header is `https://example.com/test`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'example.com', + ], + 'ReplaceKeyPrefixWith' => [ + 'title' => 'description', + 'description' => 'The string that is used to replace the prefix of the object name during redirection. If the prefix of an object name is empty, the string precedes the object name.'."\n" + ."\n" + .'> You can specify only one of the ReplaceKeyWith and ReplaceKeyPrefixWith parameters in a rule. For example, if you access an object named abc/test.txt, KeyPrefixEquals is set to abc/, ReplaceKeyPrefixWith is set to def/, the value of the Location header is `http://example.com/def/test.txt`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'def/', + ], + 'EnableReplacePrefix' => [ + 'title' => 'description', + 'description' => 'If this parameter is set to true, the prefix of the object names is replaced with the value specified by ReplaceKeyPrefixWith. If this parameter is not specified or empty, the prefix of object names is truncated.'."\n" + ."\n" + .'> When the ReplaceKeyWith parameter is not empty, the EnableReplacePrefix parameter cannot be set to true.'."\n" + ."\n" + .'Default value: false.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'ReplaceKeyWith' => [ + 'title' => 'description', + 'description' => 'The string that is used to replace the requested object name when the request is redirected. This parameter can be set to the ${key} variable, which indicates the object name in the request. For example, if ReplaceKeyWith is set to `prefix/${key}.suffix` and the object to access is test, the value of the Location header is `http://example.com/prefix/test.suffix`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'prefix/${key}.suffix', + ], + 'HttpRedirectCode' => [ + 'title' => 'description', + 'description' => 'The HTTP redirect code in the response. This parameter takes effect only when RedirectType is set to External or AliCDN. Valid values: 301, 302, and 307.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '301', + ], + 'MirrorPassOriginalSlashes' => [ + 'title' => '是否透传/到源站', + 'description' => 'Whether to pass slashes to origin.', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorURLSlave' => [ + 'title' => '镜像回源主备回源备站URL', + 'description' => 'The slave URL for mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'https://example.com', + ], + 'MirrorURLProbe' => [ + 'title' => '镜像回源主备回源切换判定URL', + 'description' => 'The probe URL for mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'https://example.com/hartbeat', + ], + 'MirrorSaveOssMeta' => [ + 'title' => '镜像回源回源OSS是否自动保存用户元数据', + 'description' => 'Whether to store the user defined metadata in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MirrorProxyPass' => [ + 'title' => '镜像回源是否不保存数据', + 'description' => 'Not save data in web-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorAllowGetImageInfo' => [ + 'title' => '镜像回源允许获取Image信息', + 'description' => 'Whether to allow get image information in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MirrorAllowVideoSnapshot' => [ + 'title' => '镜像回源允许支持视频截帧', + 'description' => 'Whether to allow take video snapshot in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorIsExpressTunnel' => [ + 'title' => '是否是镜像回源高速通道', + 'description' => 'Mirror-based back-to-origin with express tunnel.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MirrorDstRegion' => [ + 'title' => '镜像回源高速通道VpcRegion', + 'description' => 'The VPC region for mirror-based back-to-origin express tunnel.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MirrorDstVpcId' => [ + 'title' => '镜像回源高速通道VpcId', + 'description' => 'The VPC ID for mirror-based back-to-origin express tunnel.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'vpc-test-id', + ], + 'MirrorDstSlaveVpcId' => [ + 'title' => '镜像回源高速通道备站VpcId', + 'description' => 'The slave VPC ID for mirror-based back-to-origin express tunnel.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'vpc-test-id', + ], + 'MirrorUserLastModified' => [ + 'title' => '镜像回源保存文件是否使用源站LastModifiedTime', + 'description' => 'Use LastModifiedTime of the file from origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorSwitchAllErrors' => [ + 'title' => '用于主备切换的状态判断，主备切换的判断逻辑是源站返回错误，如果MirrorSwitchAllErrors为true，则除了以下状态码外都认为是失败：200,206,301,302,303,307,404；而如果为false，则只有源站返回5xx或者超时才认为是失败。', + 'description' => 'Used for determining the state of primary-secondary switching. The logic for primary-secondary switching is based on the error code returned by the origin server. If MirrorSwitchAllErrors is set to true, all status codes except the following are considered failures: 200, 206, 301, 302, 303, 307, 404. If it is set to false, only status codes in the 5xx range or timeouts are considered failures.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorTunnelId' => [ + 'title' => '镜像回源专线回源TunnelId', + 'description' => 'The tunnel ID for mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'test-tunnel-id', + ], + 'MirrorUsingRole' => [ + 'title' => '镜像回源是否使用角色', + 'description' => 'Whether to use role for mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MirrorRole' => [ + 'title' => '镜像回源回源时使用的角色', + 'description' => 'The role name used for mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => 'aliyun-test-role', + ], + 'MirrorAllowHeadObject' => [ + 'title' => '镜像回源是否允许HeadObject', + 'description' => 'Whether to allow take HeadObject in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TransparentMirrorResponseCodes' => [ + 'title' => '镜像回源透传源站响应码列表', + 'description' => 'Specify which status codes returned by the origin server should be passed through to the client along with the body. The value should be HTTP status codes such as 4xx, 5xx, etc., separated by commas (,), for example, 400,404. This setting takes effect only when RedirectType is set to Mirror. When OSS requests content from the origin server, if the origin server returns one of the status codes specified in this parameter, OSS will pass through the status code and body returned by the origin server to the client.'."\n" + .'> If the 404 status code is specified in this parameter, the configured ErrorDocument will be ineffective.', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => '400,404', + ], + 'MirrorAsyncStatus' => [ + 'title' => '镜像回源触发异步拉取模式的状态码', + 'description' => 'The HTTP status codes that trigger the asynchronous pull mode in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '303', + ], + 'MirrorTaggings' => [ + 'title' => '镜像回源保存文件时根据参数保存标签', + 'description' => 'The rules for setting tags when saving files during mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'Taggings' => [ + 'title' => '镜像回源保存标签规则列表', + 'description' => 'The rule list for setting tags.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '当前规则对应标签键', + 'description' => 'The tag key.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-tagging', + ], + 'Value' => [ + 'title' => '保存标签值的规则', + 'description' => 'The rule for setting tag value for a specific tag key.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-value', + ], + ], + 'extendType' => 'true', + 'description' => 'A rule for setting tags when saving files during mirror-based back-to-origin.', + ], + ], + ], + ], + 'MirrorReturnHeaders' => [ + 'title' => '保存镜像回源返回响应头规则的容器', + 'description' => 'Container to store the rules for setting response headers in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'ReturnHeader' => [ + 'title' => '镜像回源返回响应头规则列表', + 'description' => 'The rule list for setting response headers in mirror-based back-to-origin.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '当前规则对应响应头', + 'description' => 'The response header.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-header', + ], + 'Value' => [ + 'title' => '返回响应头值的规则', + 'description' => 'The rule for setting response header value for a specific header.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-value', + ], + ], + 'extendType' => 'true', + 'description' => 'A rule for setting response headers in mirror-based back-to-origin.', + ], + ], + ], + ], + 'MirrorAuth' => [ + 'title' => '镜像回源源站认证信息', + 'description' => 'The authentication information for the origin server in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'AuthType' => [ + 'title' => '镜像回源源站认证类型', + 'description' => 'The authentication type.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'S3V4', + ], + 'Region' => [ + 'title' => '镜像回源源站签名Region', + 'description' => 'The sign region for signature.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'AccessKeyId' => [ + 'title' => '镜像回源源站回源AK', + 'description' => 'The access key id for signature.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TESTAK', + 'sensitive' => true, + ], + 'AccessKeySecret' => [ + 'title' => '镜像回源源站回源SK，获取配置时会自动脱敏。', + 'description' => 'The access key secret for signature.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TESTSK', + 'sensitive' => true, + ], + ], + ], + 'MirrorMultiAlternates' => [ + 'title' => '镜像回源多源站配置列表', + 'description' => 'The container to store the configuration for multiple origins in mirror-based back-to-origin.', + 'visibility' => 'Private', + 'type' => 'object', + 'properties' => [ + 'MirrorMultiAlternate' => [ + 'title' => '镜像回源多源站配置', + 'description' => 'The configuration list for multiple origins.', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MirrorMultiAlternateNumber' => [ + 'title' => '镜像回源多源站序号', + 'description' => 'The distinct number of a specific origin.', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'MirrorMultiAlternateURL' => [ + 'title' => '镜像回源多源站URL', + 'description' => 'The URL for a specific origin.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://test-multi-alter.example.com', + ], + 'MirrorMultiAlternateVpcId' => [ + 'title' => '镜像回源多源站VpcId', + 'description' => 'The VPC ID for a specific origin.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'vpc-test-id', + ], + 'MirrorMultiAlternateDstRegion' => [ + 'title' => '镜像回源多源站Region', + 'description' => 'The region for a specific origin.', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + ], + 'extendType' => 'true', + 'description' => 'The configuration for a specific origin.', + ], + ], + ], + ], + ], + ], + 'RTC' => [ + 'title' => '', + 'description' => 'The container that stores information about the Replication Time Control (RTC) status.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => 'Specifies whether to enable RTC.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* disabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* enabled'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '', + 'enabled' => '', + ], + 'example' => 'Enabled', + ], + ], + ], + 'RtcConfiguration' => [ + 'title' => '', + 'description' => 'The container that stores Replication Time Control (RTC) configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RTC' => [ + 'description' => 'The container that stores the status of RTC.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/RTC', + ], + 'ID' => [ + 'title' => '', + 'description' => 'The ID of the data replication rule for which you want to configure RTC.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test_replication_rule_1', + ], + ], + ], + 'SelectMetaRequest' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores SelectMetaRequest information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'InputSerialization' => [ + 'description' => 'Specifies input serialization. This parameter is optional.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InputSerialization', + ], + 'OverwriteIfExists' => [ + 'title' => 'description', + 'description' => 'Specifies whether to perform the operation again and overwrite the existing data.\\'."\n" + .'Default value: false. This indicates that the result is directly returned if the existing data returned from a previous CreateSelectObjectMeta operation is available.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* false'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'SelectMetaStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores CreateSelectObjectMeta information.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Offset' => [ + 'title' => 'description', + 'description' => 'An 8-bit integer, which indicates the offset when the scanning is complete.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x0000000000000065', + ], + 'TotalScannedBytes' => [ + 'title' => 'description', + 'description' => 'An 8-bit integer, which indicates the size of the data that was scanned.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x0000000000000065', + ], + 'Status' => [ + 'title' => 'description', + 'description' => 'A 4-bit integer, which indicates the final status of the operation.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x000000c8', + ], + 'SplitsCount' => [ + 'title' => 'description', + 'description' => 'A 4-bit integer, which indicates total number of splits.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x00000001', + ], + 'RowsCount' => [ + 'title' => 'description', + 'description' => 'An 8-bit integer, which indicates the total number of rows.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x0000000000000003', + ], + 'ColsCount' => [ + 'title' => 'description', + 'description' => 'A 4-digit integer, which indicates the total number of columns.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0x00000004', + ], + 'ErrorMessage' => [ + 'title' => 'description', + 'description' => 'The detailed error message. If no errors occur, the value is empty.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '#', + ], + ], + ], + 'SelectProcess' => [ + 'description' => 'The optional x-oss-process parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'csv/select', + ], + 'SelectRequest' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'title' => 'description', + 'description' => 'The Base64-encoded SQL statement.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'c2VsZWN0IGNvdW50KCopIGZyb20gb3Nzb2JqZWN0IHdoZXJlIF80ID4gNDU=', + ], + 'InputSerialization' => [ + 'description' => 'The input serialization parameters.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/InputSerialization', + ], + 'OutputSerialization' => [ + 'description' => 'The output serialization parameters.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/OutputSerialization', + ], + 'Options' => [ + 'description' => 'Other optional parameters.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/SelectRequestOptions', + ], + ], + ], + 'SelectRequestOptions' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the SelectObject request.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SkipPartialDataRecord' => [ + 'title' => 'description', + 'description' => 'Specifies whether to ignore rows in which data is missing.'."\n" + ."\n" + .'* If this parameter is set to false, OSS processes the row data as null without reporting errors.'."\n" + .'* If this parameter is set to true, rows that do not contain data are skipped. If the number of skipped rows has exceeded the maximum number of rows that can be skipped, OSS reports an error and stops processing the data.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'false', + ], + 'MaxSkippedRecordsAllowed' => [ + 'title' => 'description', + 'description' => 'The maximum number of rows that can be skipped. If a row does not match the type specified in the SQL statement, or if one or more columns in a row are missing and the value of SkipPartialDataRecord is True, the rows are skipped. If the number of skipped rows has exceeded the value of this parameter, OSS reports an error and stops processing the data.\\'."\n" + .'The default value is 0.'."\n" + ."\n" + .'> A problematic row can affect CSV file parsing. If a row is not a valid CSV row, for example, if the row contains an odd number of consecutive quotes, OSS stops processing and returns an error to prevent CSV parsing errors. This parameter can be used to adjust the tolerance for irregular data but cannot be applied to invalid CSV objects.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ServerSideEncryptionRule' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores server-side encryption rules.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ApplyServerSideEncryptionByDefault' => [ + 'description' => 'The container that stores the server-side encryption method that is used by default.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', + ], + ], + ], + 'SSEKMS' => [ + 'title' => 'The container that stores the CMK used in the SSE-KMS encryption method', + 'description' => 'The container that stores the customer master key (CMK) used for SSE-KMS encryption.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'KeyId' => [ + 'title' => 'The CMK used in the SSE-KMS encryption method', + 'description' => 'The ID of the key that is managed by Key Management Service (KMS).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'keyId', + 'nullable' => true, + ], + ], + ], + 'SSEOSS' => [ + 'title' => 'The container that stores the information about the SSE-OSS encryption method', + 'description' => 'The OSS-managed keys that are used to encrypt or decrypt objects.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'unused' => [ + 'title' => 'unused', + 'description' => 'unused', + 'visibility' => 'Private', + 'type' => 'string', + 'example' => '.', + ], + ], + 'example' => 'SSE-OSS', + 'parseType' => 'struct', + ], + 'StorageClass' => [ + 'title' => 'The storage class of a bucket.', + 'description' => 'The storage class of the bucket. Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* IA (Infrequent Access)'."\n" + .'* Archive'."\n" + .'* Cold Archive'."\n" + .'* Deep Cold Archive'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Archive' => 'Archive', + 'ColdArchive' => 'ColdArchive', + 'IA' => 'IA', + 'Standard' => 'Standard', + ], + 'example' => 'Standard', + 'default' => 'Standard', + 'enum' => [ + 'Standard', + 'IA', + 'Archive', + 'ColdArchive', + 'DeepColdArchive', + ], + ], + 'Style' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the content information about the image style.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '', + 'description' => 'The content of the image style. You can include one or more IMG actions in an image style.'."\n" + ."\n" + .'* Style with a single IMG action. For example, image/resize,p\\_50 reduces the size of an image by half.'."\n" + .'* Style with multiple IMG actions. For example, image/resize,p\\_63/quality,q\\_90 resizes an image to 63% of its original size and sets the relative quality to 90%.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image/resize,p_50', + ], + ], + ], + 'StyleInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores style infomration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '', + 'description' => 'The style name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'imagestyle', + ], + 'Content' => [ + 'title' => '', + 'description' => 'The content of the style.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'image/resize,p_50', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The time when the style was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Wed, 20 May 2020 12:07:15 GMT', + ], + 'LastModifyTime' => [ + 'title' => '', + 'description' => 'The time when the style was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Wed, 21 May 2020 12:07:15 GMT', + ], + 'Category' => [ + 'title' => '样式分类。 取值：image、document、video。', + 'description' => 'The category of this style。 Invalid value：image、document、video。', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'image', + ], + ], + ], + 'Tag' => [ + 'title' => 'A short description of struct', + 'description' => 'The container used to store the tag that you want to configure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'key', + 'description' => 'The key of a tag.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* A tag key can be up to 64 bytes in length.'."\n" + ."\n" + .'* A tag key cannot start with `http://`, `https://`, or `Aliyun`.'."\n" + ."\n" + .'* A tag key must be UTF-8 encoded.'."\n" + ."\n" + .'* A tag key cannot be left empty.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'testb', + ], + 'Value' => [ + 'title' => 'value', + 'description' => 'The value of the tag that you want to add or modify.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* A tag value can be up to 128 bytes in length.'."\n" + ."\n" + .'* A tag value must be UTF-8 encoded.'."\n" + ."\n" + .'* The tag value can be left empty.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'testv2', + ], + ], + ], + 'Tagging' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the tags.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'TagSet' => [ + 'title' => 'the container of tags', + 'description' => 'The container used to store a set of tags.'."\n", + 'visibility' => 'public', + 'required' => false, + '$ref' => '#/components/schemas/TagSet', + ], + ], + ], + 'TagSet' => [ + 'title' => 'A short description of struct', + 'description' => 'The container for tags.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'sdkPropertyName' => 'tags', + 'title' => 'A short description of struct', + 'description' => 'The tags.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Tag', + ], + ], + ], + ], + 'TransferAccelerationConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that is used to store transfer acceleration configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'title' => '', + 'description' => 'Specifies whether to enable transfer acceleration for the bucket. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'> When you enable or disable transfer acceleration, the configuration takes effect within 30 minutes.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'Upload' => [ + 'title' => 'A short description of struct', + 'description' => 'The container that stores the information about multipart upload tasks.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'description', + 'description' => 'The name of the object for which a multipart upload task was initiated.'."\n" + ."\n" + .'> The results returned by OSS are listed in ascending alphabetical order of object names. Multiple multipart upload tasks that are initiated to upload the same object are listed in ascending order of upload IDs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'multipart.data', + ], + 'UploadId' => [ + 'title' => 'description', + 'description' => 'The ID of the multipart upload task.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0004B999EF5A239BB9138C6227D6****', + ], + 'Initiated' => [ + 'title' => 'description', + 'description' => 'The time when the multipart upload task was initiated.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2012-02-23T04:18:23.000Z', + ], + ], + ], + 'UserAntiDDOSInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the specified Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '', + 'description' => 'The ID of the Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', + ], + 'Owner' => [ + 'title' => '', + 'description' => 'The ID of the owner of the Anti-DDoS instance.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '114893010724****', + ], + 'Ctime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was created. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769503', + ], + 'Mtime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was last updated. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769840', + ], + 'ActiveTime' => [ + 'title' => '', + 'description' => 'The time when the Anti-DDoS instance was activated. The value is a timestamp.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626769845', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The status of the Anti-DDoS instance. Valid values:'."\n" + ."\n" + .'* Init'."\n" + .'* Defending'."\n" + .'* HaltDefending'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Defending', + ], + ], + ], + 'UserDefinedLogFieldsConfiguration' => [ + 'title' => '', + 'description' => 'The specified field configurations of real-time logs in a bucket.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'HeaderSet' => [ + 'title' => '', + 'description' => 'The container that stores the configurations of custom request headers.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'header' => [ + 'title' => '', + 'description' => 'The list of the custom request headers.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the custom request headers.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'header1', + 'extendType' => 'true', + ], + ], + ], + ], + 'ParamSet' => [ + 'title' => '', + 'description' => 'The container that stores the configurations of custom URL parameters.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'parameter' => [ + 'title' => '', + 'description' => 'The list of the custom URL parameters.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the custom URL parameters.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'param1', + 'extendType' => 'true', + ], + 'example' => 'my-param', + ], + ], + ], + ], + ], + 'UserQosConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TotalUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IntranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExtranetUploadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IntranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ExtranetDownloadBandwidth' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'IntranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ExtranetQps' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'Remark' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '', + ], + 'Region' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'DefaultQoSConfiguration' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + '$ref' => '#/components/schemas/QoSConfigurationWithRemark', + ], + ], + ], + 'VersioningConfiguration' => [ + 'title' => 'Describes the versioning state of a OSS bucket', + 'description' => 'The container that stores the versioning status of the bucket.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The versioning state. Valid values:'."\n" + ."\n" + .'* Enabled'."\n" + .'* Suspended'."\n", + 'visibility' => 'public', + 'enumValueTitles' => [ + 'Enabled' => 'Enabled', + 'Suspended' => 'Suspended', + ], + 'example' => 'Enabled', + '$ref' => '#/components/schemas/BucketVersioningStatus', + ], + ], + ], + 'VpcId' => [ + 'title' => 'VPC ID', + 'description' => 'VPC ID'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vpc-t4nlw426y44rd3iq4****', + ], + 'WebsiteConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'The root node for website configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'IndexDocument' => [ + 'description' => 'The container that stores the default homepage.'."\n" + ."\n" + .'> You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/IndexDocument', + ], + 'ErrorDocument' => [ + 'description' => 'The container that stores the default 404 page.'."\n" + ."\n" + .'> You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules.'."\n", + 'visibility' => 'public', + '$ref' => '#/components/schemas/ErrorDocument', + ], + 'RoutingRules' => [ + 'title' => 'description', + 'description' => 'The container that stores the redirection rules.'."\n" + ."\n" + .'> You must specify at least one of the following containers: IndexDocument, ErrorDocument, and RoutingRules.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'RoutingRule' => [ + 'title' => 'description', + 'description' => 'The specified redirection rule or mirroring-based back-to-origin rule. You can specify up to 20 rules.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The specified redirection rule or mirroring-based back-to-origin rule. You can specify up to 20 rules.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RoutingRule', + ], + ], + ], + 'sdkIgnore' => false, + ], + ], + ], + ], + ], + 'apis' => [ + 'ListBuckets' => [ + 'summary' => 'Queries all buckets that are owned by a requester.', + 'path' => '/', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9318', + 'abilityTreeNodes' => [ + 'FEATUREossTOZXHW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'title' => '限定返回的 Bucket 名称必须以 prefix 作为前缀。如果不设定，则不过滤前缀信息。', + 'description' => 'The prefix that the names of returned buckets must contain. If this parameter is not specified, prefixes are not used to filter returned buckets. By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'my', + ], + ], + [ + 'name' => 'marker', + 'in' => 'query', + 'schema' => [ + 'title' => '设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。', + 'description' => 'The name of the bucket from which the buckets start to return. The buckets whose names are alphabetically after the value of marker are returned. If this parameter is not specified, all results are returned. By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mybucket10', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'title' => '限定此次返回 Bucket 的最大个数。', + 'description' => 'The maximum number of buckets that can be returned. Valid values: 1 to 1000. Default value: 100'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'x-oss-resource-group-id', + 'in' => 'header', + 'schema' => [ + 'title' => '指定资源组 ID。'."\n" + ."\n" + .'如果在请求中携带该请求头并指定资源组 ID，则 OSS 会返回属于该资源组的所有 Bucket。当指定的资源组 ID 为 rg-default-id 时，OSS 会返回属于默认资源组的所有 Bucket。'."\n" + .'如果在请求中携带了该请求头但未指定资源组 ID，则 OSS 会返回属于默认资源组的所有 Bucket。'."\n" + .'如果在请求中未携带该请求头，则 OSS 会返回请求者拥有的所有 Bucket。您可以通过资源管理的控制台或 ListResourceGroups 接口获取资源组 ID。'."\n", + 'description' => 'The ID of the resource group to which the bucket belongs.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ResourceGroupId', + ], + ], + [ + 'name' => 'tag-key', + 'in' => 'query', + 'schema' => [ + 'title' => '指定Bucket标签键。列举结果中仅会包含那些打上了对应标签的Bucket。', + 'description' => 'A tag key of target buckets. The listing results will only include Buckets that have been tagged with this key.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-key', + ], + ], + [ + 'name' => 'tag-value', + 'in' => 'query', + 'schema' => [ + 'title' => '指定Bucket标签值。如果请求指定了该参数，那么必须同时指定tag-value，列举结果中仅会包含那些打上了对应标签键值对的Bucket。', + 'description' => 'A tag value for the target buckets. If this parameter is specified in the request, the tag-key must also be specified. The listing results will only include Buckets that have been tagged with this key-value pair.', + 'type' => 'string', + 'required' => false, + 'example' => 'test-value', + ], + ], + [ + 'name' => 'tagging', + 'in' => 'query', + 'schema' => [ + 'title' => '指定标签列表。如："k1":"v1","k2":"v2"，只有Bucket匹配列表中所有的标签键值对，才会出现在列举结果中。'."\n" + .'tagging参数与tag-key和tag-value两个参数不能同时存在。', + 'description' => 'Tag list of target buckets. Only Buckets that match all the key-value pairs in the list will added into the listing results. The tagging parameter cannot be used with the tag-key and tag-value parameters in a request.', + 'type' => 'string', + 'required' => false, + 'example' => '"test-key":"test-value"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口响应体。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ListAllMyBucketsResult' => [ + 'title' => '保存存储空间列表的容器。', + 'description' => 'The container that stores the result of ListBuckets(GetService) request.', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'title' => '保存 Bucket 拥有者信息的容器。', + 'description' => 'The container that stores the information about the bucket owner.', + '$ref' => '#/components/schemas/Owner', + ], + 'Prefix' => [ + 'title' => '本次查询结果的前缀。', + 'description' => 'The prefix contained in the names of returned buckets.', + 'type' => 'string', + 'example' => 'logs/', + ], + 'Marker' => [ + 'title' => '本次 ListBuckets（GetSerivce）的起点。', + 'description' => 'The name of the bucket from which the buckets are returned.', + 'type' => 'string', + 'example' => 'abc', + ], + 'MaxKeys' => [ + 'title' => '响应请求内返回结果的最大数。', + 'description' => 'The maximum number of buckets that can be returned.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'IsTruncated' => [ + 'title' => '是否所有的结果都已经返回。取值范围如下：'."\n" + ."\n" + .'true：表示本次没有返回全部结果。'."\n" + .'false：表示本次已经返回了全部结果。', + 'description' => 'Indicates whether all results are returned. Valid values:'."\n" + .'- true: All results are not returned in the response. '."\n" + .'- false: All results are returned in the response.', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'All results are returned', + 'false' => 'Not all results are returned', + ], + 'example' => 'true', + ], + 'NextMarker' => [ + 'title' => '用于继续查询时给 marker 赋值。表示下一次 ListBuckets（GetService）可以以此为 marker，将未返回的结果返回。', + 'description' => 'The marker for the next ListBuckets (GetService) request. You can use the value of this parameter as the value of marker in the next ListBuckets (GetService) request to retrieve the unreturned results.', + 'type' => 'string', + 'example' => 'def', + ], + 'Buckets' => [ + 'title' => '保存 Bucket 信息列表的容器。', + 'description' => 'The container that stores the information about multiple buckets.', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => '保存多个 Bucket 信息的列表。', + 'description' => 'The container that stores the information list of multiple buckets.', + 'type' => 'array', + 'items' => [ + 'title' => '保存 Bucket 信息的容器。', + 'description' => 'The container that stores the information about the specified bucket.', + '$ref' => '#/components/schemas/Bucket', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '5xx' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListAllMyBucketsResult>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <Prefix>logs/</Prefix>\\n <Marker>abc</Marker>\\n <MaxKeys>20</MaxKeys>\\n <IsTruncated>true</IsTruncated>\\n <NextMarker>def</NextMarker>\\n <Buckets>\\n <Bucket>\\n <CreationDate/>\\n <ExtranetEndpoint/>\\n <IntranetEndpoint/>\\n <Location/>\\n <Name/>\\n <Region/>\\n </Bucket>\\n </Buckets>\\n</ListAllMyBucketsResult>","type":"xml"}]', + 'title' => 'ListBuckets', + 'description' => '* You can specify prefix, marker, or max-keys to query a list of buckets that meet the specified conditions.'."\n" + .'* To query a list of buckets, you must have the oss:GetService (ListBuckets) permission. For more information, see the "Attach a custom policy to a RAM user" section of the [Common examples of RAM policies](https://help.aliyun.com/document_detail/199058.htm?spm=a2c4g.11186623.0.0.48be7590hCA8LI#section-ucu-jv0-zip) topic.'."\n" + .'* If all buckets are returned when you call the ListBuckets operation, the XML-format response parameters do not contain Prefix, Marker, MaxKeys, IsTruncated, or NextMarker.'."\n", + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the endpoints of all supported regions or the endpoints of a specific region.', + 'path' => '/?regions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118528', + 'abilityTreeNodes' => [ + 'FEATUREoss4T9JVQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'regions', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss-cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionInfoList' => [ + 'description' => 'The information about the regions.', + 'type' => 'object', + 'properties' => [ + 'RegionInfo' => [ + 'description' => 'The information about the regions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the specified region.', + '$ref' => '#/components/schemas/RegionInfo', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<RegionInfoList>\\n <RegionInfo>\\n <Region/>\\n <InternetEndpoint/>\\n <InternalEndpoint/>\\n <AccelerateEndpoint/>\\n </RegionInfo>\\n</RegionInfoList>","type":"xml"}]', + 'title' => 'DescribeRegions', + ], + 'GetBucketStat' => [ + 'summary' => 'Queries the storage capacity of a bucket and the number of objects that are stored in the bucket.', + 'path' => '/?stat', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The bucket about which you want to query the information.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BucketStat' => [ + 'description' => 'The container that stores all information returned for the GetBucketStat request.', + '$ref' => '#/components/schemas/BucketStat', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketStat>\\n <Storage>1994</Storage>\\n <ObjectCount>32</ObjectCount>\\n <MultipartUploadCount>27</MultipartUploadCount>\\n <LiveChannelCount>2</LiveChannelCount>\\n <MultipartPartCount>128</MultipartPartCount>\\n <DeleteMarkerCount>12</DeleteMarkerCount>\\n <LastModifiedTime>1709724731</LastModifiedTime>\\n <StandardStorage>1990</StandardStorage>\\n <StandardObjectCount>18</StandardObjectCount>\\n <InfrequentAccessStorage>120</InfrequentAccessStorage>\\n <InfrequentAccessRealStorage>120</InfrequentAccessRealStorage>\\n <InfrequentAccessObjectCount>2</InfrequentAccessObjectCount>\\n <ArchiveStorage>120</ArchiveStorage>\\n <ArchiveRealStorage>120</ArchiveRealStorage>\\n <ArchiveObjectCount>2</ArchiveObjectCount>\\n <ColdArchiveStorage>120</ColdArchiveStorage>\\n <ColdArchiveRealStorage>120</ColdArchiveRealStorage>\\n <ColdArchiveObjectCount>2</ColdArchiveObjectCount>\\n <DeepColdArchiveStorage>120</DeepColdArchiveStorage>\\n <DeepColdArchiveRealStorage>120</DeepColdArchiveRealStorage>\\n <DeepColdArchiveObjectCount>2</DeepColdArchiveObjectCount>\\n <MultipartPartStorage>481200</MultipartPartStorage>\\n <StandardMultipartPartCount>128</StandardMultipartPartCount>\\n <StandardMultipartPartStorage>481200</StandardMultipartPartStorage>\\n <InfrequentMultipartPartCount>69</InfrequentMultipartPartCount>\\n <InfrequentMultipartPartStorage>481200</InfrequentMultipartPartStorage>\\n <ArchiveMultipartPartCount>56</ArchiveMultipartPartCount>\\n <ArchiveMultipartPartStorage>481200</ArchiveMultipartPartStorage>\\n <ColdArchiveMultipartPartCount>110</ColdArchiveMultipartPartCount>\\n <ColdArchiveMultipartPartStorage>481200</ColdArchiveMultipartPartStorage>\\n <DeepColdArchiveMultipartPartCount>110</DeepColdArchiveMultipartPartCount>\\n <DeepColdArchiveMultipartPartStorage>481200</DeepColdArchiveMultipartPartStorage>\\n</BucketStat>","type":"xml"}]', + 'title' => 'GetBucketStat', + 'description' => '* To call the GetBucketStat operation, you must have the oss:GetBucketStat permission.'."\n" + .'* Data obtained by calling this operation is not real-time data and may have a latency of over an hour.'."\n" + .'* The time information obtained by calling this operation may not be up-to-date. For example, the value of LastModifiedTime obtained by the current GetBucketStat request may be earlier than the value of this parameter obtained by the previous GetBucketStat request.'."\n", + ], + 'PutBucket' => [ + 'summary' => 'Creates a bucket.', + 'path' => '/', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9062', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + 'FEATUREoss4HN0W2', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'Bucket 名称。存储空间的命名规范如下：'."\n" + ."\n" + .'只能包括小写字母、数字和短划线（-）。'."\n" + .'必须以小写字母或者数字开头和结尾。'."\n" + .'长度必须在 3~63 字符之间。', + 'description' => 'The name of the bucket. The name of a bucket must comply with the following naming conventions:'."\n" + ."\n" + .'* The name can contain only lowercase letters, digits, and hyphens (-).'."\n" + .'* It must start and end with a lowercase letter or a digit.'."\n" + .'* The name must be 3 to 63 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-acl', + 'in' => 'header', + 'schema' => [ + 'title' => 'Bucket 的访问权限 ACL。取值范围如下：'."\n" + ."\n" + .'public-read-write：公共读写'."\n" + .'public-read：公共读'."\n" + .'private（默认）：私有', + 'description' => 'The access control list (ACL) of the bucket to be created. Valid values:'."\n" + ."\n" + .'* public-read-write'."\n" + .'* public-read'."\n" + .'* private (default)'."\n" + ."\n" + .'For more information, see [Bucket ACL](~~31843~~).'."\n", + 'required' => false, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/BucketACL', + ], + ], + [ + 'name' => 'x-oss-resource-group-id', + 'in' => 'header', + 'schema' => [ + 'title' => '指定资源组 ID。'."\n" + ."\n" + .'如果在请求中携带该请求头并指定资源组 ID，则 OSS 会返回属于该资源组的所有 Bucket。当指定的资源组 ID 为 rg-default-id 时，OSS 会返回属于默认资源组的所有 Bucket。'."\n" + .'如果在请求中携带了该请求头但未指定资源组 ID，则 OSS 会返回属于默认资源组的所有 Bucket。'."\n" + .'如果在请求中未携带该请求头，则 OSS 会返回请求者拥有的所有 Bucket。您可以通过资源管理的控制台或 ListResourceGroups 接口获取资源组 ID。', + 'description' => 'The ID of the resource group.'."\n" + ."\n" + .'* If you include the header in the request and specify the ID of the resource group, the bucket that you create belongs to the resource group. If the specified resource group ID is rg-default-id, the bucket that you create belongs to the default resource group.'."\n" + .'* If you do not include the header in the request, the bucket that you create belongs to the default resource group.'."\n" + ."\n" + .'You can obtain the ID of a resource group in the Resource Management console or by calling the ListResourceGroups operation. For more information, see [View basic information of a resource group](~~151181~~) and [ListResourceGroups](~~158855~~).'."\n" + ."\n" + .'> You cannot configure a resource group for an Anywhere Bucket.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ResourceGroupId', + ], + ], + [ + 'name' => 'x-oss-bucket-tagging', + 'in' => 'header', + 'schema' => [ + 'title' => '指定Bucket标签，如 k1=v1&k2=v2。', + 'description' => '指定Bucket标签，如 k1=v1&k2=v2。', + 'type' => 'string', + 'required' => false, + 'example' => 'k1=v1&k2=v2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体', + 'description' => 'The container that stores the request body.', + 'type' => 'object', + 'properties' => [ + 'CreateBucketConfiguration' => [ + 'title' => '存储创建 Bucket 信息的容器。', + 'description' => 'The container that stores the information about the bucket to be created.', + 'required' => false, + '$ref' => '#/components/schemas/CreateBucketConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""}]', + 'title' => 'PutBucket', + 'description' => '* You can create up to 100 buckets in the same region by using an Alibaba Cloud account.'."\n" + .'* Each region can be accessed by using the endpoints of the region. For more information about regions and the mappings between regions and endpoints, see [Regions and endpoints](~~31837~~).'."\n", + ], + 'DeleteBucket' => [ + 'summary' => 'Deletes a bucket.', + 'path' => '/', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucket', + 'description' => '* Only the owner of a bucket has the permissions to delete the bucket.'."\n" + .'* To prevent unexpected deletion, OSS does not allow you to delete a non-empty bucket.'."\n", + ], + 'ListObjects' => [ + 'summary' => 'Queries the information about all objects in a bucket.', + 'path' => '/', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'delimiter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The character that is used to group objects by name. If you specify delimiter in the request, the response contains CommonPrefixes. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the object after which the GetBucket (ListObjects) operation begins. If this parameter is specified, objects whose names are alphabetically after the value of marker are returned.\\'."\n" + .'The objects are returned by page based on marker. The value of marker can be up to 1,024 bytes.\\'."\n" + .'If the value of marker does not exist in the list when you perform a conditional query, the GetBucket (ListObjects) operation starts from the object whose name is alphabetically after the value of marker.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1.txt', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of objects that can be returned. If the number of objects to be returned exceeds the value of max-keys specified in the request, NextMarker is included in the returned response. The value of NextMarker is used as the value of marker for the next request.\\'."\n" + .'Valid values: 1 to 999.\\'."\n" + .'Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix that must be contained in names of the returned objects.'."\n" + ."\n" + .'* The value of prefix can be up to 1,024 bytes in length.'."\n" + .'* If you specify prefix, the names of the returned objects contain the prefix.'."\n" + ."\n" + .'If you set prefix to a directory name, the object whose names start with this prefix are listed. The objects consist of all recursive objects and subdirectories in this directory.\\'."\n" + .'If you set prefix to a directory name and set delimiter to a forward slash (/), only the objects in the directory are listed. The subdirectories in the directory are listed in CommonPrefixes. Recursive objects and subdirectories in the subdirectories are not listed.\\'."\n" + .'For example, a bucket contains the following three objects: fun/test.jpg, fun/movie/001.avi, and fun/movie/007.avi. If prefix is set to fun/, the three objects are returned. If prefix is set to fun/ and delimiter is set to a forward slash (/), fun/test.jpg and fun/movie/ are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fun', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encoding format of the content in the response.'."\n" + ."\n" + .'> The value of Delimiter, Marker, Prefix, NextMarker, and Key are UTF-8 encoded. If the values of Delimiter, Marker, Prefix, NextMarker, and Key contain a control character that is not supported by Extensible Markup Language (XML) 1.0, you can specify encoding-type to encode the value in the response.'."\n", + 'required' => false, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/EncodeType', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'ListBucketResult' => [ + 'description' => 'The container that stores the result of the GetBucket (ListObjects) request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'The bucket name', + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Prefix' => [ + 'title' => 'The prefix that the names of returned objects contain', + 'description' => 'The prefix in the names of the returned objects.'."\n", + 'type' => 'string', + 'example' => 'logs/', + ], + 'Marker' => [ + 'title' => 'The name of the object from which the list operation begins', + 'description' => 'The name of the object after which the list operation starts.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'MaxKeys' => [ + 'title' => 'The maximum number of returned objects in the response', + 'description' => 'The maximum number of the returned objects in the response.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Delimiter' => [ + 'title' => 'The character used to group objects by name', + 'description' => 'The delimiter used to group objects by name. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in the CommonPrefixes parameter.'."\n", + 'type' => 'string', + 'example' => '/', + ], + 'IsTruncated' => [ + 'title' => 'Indicates whether the returned results are truncated', + 'description' => 'Indicates whether the returned results are truncated.'."\n" + ."\n" + .'Valid values: true and false'."\n" + ."\n" + .'true: indicates that not all of the results are returned for the request.'."\n" + ."\n" + .'false indicates that all of the results are returned this time.'."\n" + ."\n" + .'*'."\n" + .'*'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'EncodingType' => [ + 'description' => 'The encoding type of the content in the response. If the encoding-type parameter is specified in the request, the values of Delimiter, Marker, Prefix, NextMarker, and Key in the response are encoded.'."\n", + 'type' => 'string', + 'example' => 'url', + ], + 'NextMarker' => [ + 'description' => 'The position from which the next list operation starts.'."\n", + 'type' => 'string', + 'example' => 'def', + ], + 'Contents' => [ + 'title' => 'The container that stores the returned object metadata', + 'description' => 'The container that stores the metadata of each returned object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the metadata of the returned object.'."\n", + '$ref' => '#/components/schemas/ObjectSummary', + ], + ], + 'CommonPrefixes' => [ + 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', + 'description' => 'If the delimiter parameter is specified in the request, the response contains CommonPrefixes. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The common name prefix of objects.'."\n", + '$ref' => '#/components/schemas/CommonPrefix', + ], + ], + ], + ], + ], + ], + ], + '4xx' => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListBucketResult>\\n <Name>example-bucket</Name>\\n <Prefix>logs/</Prefix>\\n <Marker>abc</Marker>\\n <MaxKeys>20</MaxKeys>\\n <Delimiter>/</Delimiter>\\n <IsTruncated>true</IsTruncated>\\n <EncodingType>url</EncodingType>\\n <NextMarker>def</NextMarker>\\n <Contents>\\n <Key>fun/test.jpg</Key>\\n <LastModified>2012-02-24T08:42:32.000Z</LastModified>\\n <ETag>5B3C1A2E053D763E1B002CC607C5A0FE1****</ETag>\\n <Type>Normal</Type>\\n <Size>344606</Size>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <RestoreInfo>ongoing-request=\\"true”</RestoreInfo>\\n <TransitionTime>2012-02-24T08:42:32.000Z</TransitionTime>\\n </Contents>\\n <CommonPrefixes>\\n <Prefix/>\\n </CommonPrefixes>\\n</ListBucketResult>","type":"xml"}]', + 'title' => 'ListObjects', + 'description' => '* The GetBucket (ListObjects) operation has been updated to GetBucketV2 (ListObjectsV2). We recommend that you use GetBucketV2 (ListObjectsV2) when you develop your applications. Object Storage Service (OSS) provides backward compatibility. This indicates that OSS continues to support the GetBucket (ListObjects) operation. For more information about the GetBucketV2 (ListObjectsV2) operation, see [GetBucketV2 (ListObjectsV2)](~~187544~~).'."\n" + .'* The user metadata of objects is not returned for a GetBucket (ListObjects) request.', + 'translator' => 'machine', + ], + 'ListObjectsV2' => [ + 'summary' => 'Queries the information about all objects in a bucket.', + 'path' => '/?list-type=2', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'delimiter', + 'in' => 'query', + 'schema' => [ + 'title' => 'The character used to group objects by name', + 'description' => 'The character that is used to group objects by name. If you specify delimiter in the request, the response contains CommonPrefixes. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'title' => 'The maximum number of objects to return', + 'description' => 'The maximum number of objects to be returned.\\'."\n" + .'Valid values: 1 to 999.\\'."\n" + .'Default value: 100.'."\n" + ."\n" + .'> If the number of returned objects exceeds the value of max-keys, the response contains NextContinuationToken.Use the value of NextContinuationToken as the value of continuation-token in the next request.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'title' => 'The prefix that the returned object names must contain', + 'description' => 'The prefix that must be contained in names of the returned objects.\\'."\n" + ."\n\n" + .'* The value of prefix can be up to 1,024 bytes in length.'."\n" + .'* If you specify prefix, the names of the returned objects contain the prefix.'."\n" + ."\n" + .'If you set prefix to a directory name, the objects whose names start with this prefix are listed. The objects consist of all objects and subdirectories in this directory.\\'."\n" + .'If you set prefix to a directory name and set delimiter to a forward slash (/), only the objects in the directory are listed. The subdirectories in the directory are returned in CommonPrefixes. Objects and subdirectories in the subdirectories are not listed.\\'."\n" + .'For example, a bucket contains the following three objects: fun/test.jpg, fun/movie/001.avi, and fun/movie/007.avi. If prefix is set to fun/, the three objects are returned. If prefix is set to fun/ and delimiter is set to a forward slash (/), fun/test.jpg and fun/movie/ are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'title' => 'The encoding type of the object name in the response', + 'description' => 'The encoding format of the returned objects in the response.'."\n" + ."\n" + .'> The values of Delimiter, StartAfter, Prefix, NextContinuationToken, and Key are UTF-8 encoded. If the value of Delimiter, StartAfter, Prefix, NextContinuationToken, or Key contains a control character that is not supported by Extensible Markup Language (XML) 1.0, you can specify encoding-type to encode the value in the response.'."\n", + 'required' => false, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/EncodeType', + ], + ], + [ + 'name' => 'fetch-owner', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include the information about the bucket owner in the response. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'start-after', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the object after which the list operation begins. If this parameter is specified, objects whose names are alphabetically after the value of start-after are returned.\\'."\n" + .'The objects are returned by page based on start-after. The value of start-after can be up to 1,024 bytes in length.\\'."\n" + .'If the value of start-after does not exist when you perform a conditional query, the list starts from the object whose name is alphabetically after the value of start-after.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b', + ], + ], + [ + 'name' => 'continuation-token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token from which the list operation starts. You can obtain the token from NextContinuationToken in the response of the ListObjectsV2 request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1.txt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'ListBucketResult' => [ + 'description' => 'The container that stores the metadata of the returned objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'The bucket name', + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Prefix' => [ + 'title' => 'The prefix that the names of returned objects must contain', + 'description' => 'The prefix in the names of the returned objects.'."\n", + 'type' => 'string', + 'example' => 'logs/', + ], + 'StartAfter' => [ + 'description' => 'If the start-after parameter is specified in the request, the response contains StartAfter.'."\n", + 'type' => 'string', + 'example' => 'test.txt', + ], + 'MaxKeys' => [ + 'title' => 'The maximum number of returned objects in the response', + 'description' => 'The maximum number of the returned objects in the response.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Delimiter' => [ + 'description' => 'The delimiter used to group objects by name. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in the CommonPrefixes parameter.'."\n", + 'type' => 'string', + 'example' => '/', + ], + 'IsTruncated' => [ + 'title' => 'Indicates whether the returned results are truncated', + 'description' => 'Indicates whether the returned results are truncated.'."\n" + ."\n" + .'Valid values: true and false'."\n" + ."\n" + .'true: indicates that not all of the results are returned for the request.'."\n" + ."\n" + .'false indicates that all of the results are returned this time.'."\n" + ."\n" + .'*'."\n" + .'*'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'KeyCount' => [ + 'description' => 'The number of keys returned for this request. If Delimiter is specified, the KeyCount value is the sum of the Key and CommonPrefixes values.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'EncodingType' => [ + 'description' => 'The encoding type of the object name in the response. If the encoding-type parameter is specified in the request, the values of Delimiter, StartAfter, Prefix, NextContinuationToken, and Key are encoded in the response.'."\n", + 'type' => 'string', + 'example' => 'url', + ], + 'ContinuationToken' => [ + 'description' => 'If the continuation-token parameter is specified in the request, the response contains ContinuationToken.'."\n", + 'type' => 'string', + 'example' => 'CgJiYw--', + ], + 'NextContinuationToken' => [ + 'description' => 'The token from which the next list operation starts. The NextContinuationToken value is used as the ContinuationToken value to query subsequent results.'."\n", + 'type' => 'string', + 'example' => 'CgJiYw--', + ], + 'Contents' => [ + 'title' => 'The container that stores the versions of objects except for delete markers', + 'description' => 'The container that stores the metadata of each returned object.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the metadata of the returned object.'."\n", + '$ref' => '#/components/schemas/ObjectSummary', + ], + ], + 'CommonPrefixes' => [ + 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', + 'description' => 'If the delimiter parameter is specified in the request, the response contains CommonPrefixes. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The common name prefix of objects.'."\n", + '$ref' => '#/components/schemas/CommonPrefix', + ], + ], + ], + ], + ], + ], + ], + '4xx' => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListBucketResult>\\n <Name>example-bucket</Name>\\n <Prefix>logs/</Prefix>\\n <StartAfter>test.txt</StartAfter>\\n <MaxKeys>20</MaxKeys>\\n <Delimiter>/</Delimiter>\\n <IsTruncated>true</IsTruncated>\\n <KeyCount>6</KeyCount>\\n <EncodingType>url</EncodingType>\\n <ContinuationToken>CgJiYw--</ContinuationToken>\\n <NextContinuationToken>CgJiYw--</NextContinuationToken>\\n <Contents>\\n <Key>fun/test.jpg</Key>\\n <LastModified>2012-02-24T08:42:32.000Z</LastModified>\\n <ETag>5B3C1A2E053D763E1B002CC607C5A0FE1****</ETag>\\n <Type>Normal</Type>\\n <Size>344606</Size>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <RestoreInfo>ongoing-request=\\"true”</RestoreInfo>\\n <TransitionTime>2012-02-24T08:42:32.000Z</TransitionTime>\\n </Contents>\\n <CommonPrefixes>\\n <Prefix/>\\n </CommonPrefixes>\\n</ListBucketResult>","type":"xml"}]', + 'title' => 'ListObjectsV2', + 'description' => 'The user metadata is not returned for a GetBucketV2 (ListObjectsV2) request.', + ], + 'GetBucketInfo' => [ + 'summary' => 'Queries the information about a bucket. Only the owner of a bucket can query the information about the bucket. You can call this operation from an Object Storage Service (OSS) endpoint.', + 'path' => '/?bucketInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BucketInfo' => [ + 'description' => 'The container that stores the information about the bucket.', + '$ref' => '#/components/schemas/BucketInfo', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketInfo>\\n <Bucket>\\n <AccessMonitor>Disabled</AccessMonitor>\\n <CreationDate>2022-01-06T08:20:09.000Z</CreationDate>\\n <CrossRegionReplication>Disabled</CrossRegionReplication>\\n <Location>oss-cn-hangzhou</Location>\\n <Name>test-bucket</Name>\\n <TransferAcceleration>Disabled</TransferAcceleration>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <AccessControlList/>\\n <ServerSideEncryptionRule>\\n <SSEAlgorithm>None</SSEAlgorithm>\\n <KMSMasterKeyID>****</KMSMasterKeyID>\\n <KMSDataEncryption>SM4</KMSDataEncryption>\\n </ServerSideEncryptionRule>\\n <BucketPolicy>\\n <LogBucket>example-bucket</LogBucket>\\n <LogPrefix>log/</LogPrefix>\\n </BucketPolicy>\\n <Comment>An example bucket.</Comment>\\n <BlockPublicAccess>false</BlockPublicAccess>\\n </Bucket>\\n</BucketInfo>","type":"xml"}]', + 'title' => 'GetBucketInfo', + ], + 'GetBucketLocation' => [ + 'summary' => 'Queries the region in which a bucket resides. Only the owner of a bucket can query the region in which the bucket resides.', + 'path' => '/?location', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The container that stores the information about the regions.'."\n", + 'type' => 'object', + 'properties' => [ + 'LocationConstraint' => [ + 'description' => 'The region in which the bucket resides.\\'."\n" + .'Examples: oss-cn-hangzhou, oss-cn-shanghai, oss-cn-qingdao, oss-cn-beijing, oss-cn-zhangjiakou, oss-cn-hongkong, oss-cn-shenzhen, oss-us-west-1, oss-us-east-1, and oss-ap-southeast-1.'."\n" + ."\n" + .'\\'."\n" + .'For more information about the regions in which buckets reside, see [Regions and endpoints](~~31837~~).'."\n", + 'type' => 'string', + 'example' => 'oss-cn-hangzhou', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<LocationConstraint>oss-cn-hangzhou</LocationConstraint>","type":"xml"}]', + 'title' => 'GetBucketLocation', + ], + 'ListAccessPoints' => [ + 'summary' => 'Queries the information about user-level or bucket-level access points.', + 'path' => '/?accessPoint', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185378', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of access points that can be returned. Valid values:'."\n" + ."\n" + .'* For user-level access points: (0,1000].'."\n" + .'* For bucket-level access points: (0,100].'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'title' => '指定返回接入点的最大数量。取值如下：'."\n" + ."\n" + .'- 获取用户级别接入点时，取值要求大于 0 小于等于 1000。'."\n" + .'- 获取 Bucket 级别接入点时，取值要求大于 0 小于等于 100。', + ], + ], + [ + 'name' => 'continuation-token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token from which the listing operation starts. You must specify the value of NextContinuationToken that is obtained from the previous query as the value of continuation-token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + 'title' => '指定 List 操作需要从此 token 开始。您可从返回结果中的 NextContinuationToken 获取此 token。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ListAccessPointsResult' => [ + 'description' => 'The container that stores the information about access points.', + '$ref' => '#/components/schemas/ListAccessPointsResult', + 'title' => '保存本次列举接入点信息结果的容器。', + ], + ], + 'title' => '接口响应体。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListAccessPointsResult>\\n <IsTruncated>true</IsTruncated>\\n <NextContinuationToken>ap-test-01</NextContinuationToken>\\n <AccountId>11489****34218</AccountId>\\n <AccessPoints>\\n <AccessPoint>\\n <Bucket/>\\n <VpcConfiguration>\\n <VpcId>vpc-t4nlw426y44rd3iq4****</VpcId>\\n </VpcConfiguration>\\n </AccessPoint>\\n </AccessPoints>\\n <MaxKeys>10</MaxKeys>\\n</ListAccessPointsResult>","type":"xml"}]', + 'title' => 'ListAccessPoints', + ], + 'GetAccessPoint' => [ + 'summary' => 'Queries the information about an access point.', + 'path' => '/?accessPoint', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GetAccessPointResult' => [ + 'description' => 'The container that stores the information about the access point.', + '$ref' => '#/components/schemas/GetAccessPointResult', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetAccessPointResult>\\n <Bucket>example-bucket</Bucket>\\n <AccountId>114******818</AccountId>\\n <VpcConfiguration>\\n <VpcId>vpc-t4nlw426y44rd3iq4****</VpcId>\\n </VpcConfiguration>\\n <Endpoints/>\\n <PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n </PublicAccessBlockConfiguration>\\n <CreationDate>Sat, 27 Apr 2024 15:04:14 GMT</CreationDate>\\n</GetAccessPointResult>","type":"xml"}]', + 'title' => 'GetAccessPoint', + ], + 'GetAccessPointPolicy' => [ + 'summary' => 'Queries the configurations of an access point policy.', + 'path' => '/?accessPointPolicy', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The configurations of the access point policy.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "Version":"1",'."\n" + .' "Statement":['."\n" + .' {'."\n" + .' "Action":['."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Effect":"Deny",'."\n" + .' "Principal":["27737962156157xxxx"],'."\n" + .' "Resource":['."\n" + .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01",'."\n" + .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' } ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"{\\\\n \\\\\\"Version\\\\\\":\\\\\\"1\\\\\\",\\\\n \\\\\\"Statement\\\\\\":[\\\\n {\\\\n \\\\\\"Action\\\\\\":[\\\\n \\\\\\"oss:PutObject\\\\\\",\\\\n \\\\\\"oss:GetObject\\\\\\"\\\\n ],\\\\n \\\\\\"Effect\\\\\\":\\\\\\"Deny\\\\\\",\\\\n \\\\\\"Principal\\\\\\":[\\\\\\"27737962156157xxxx\\\\\\"],\\\\n \\\\\\"Resource\\\\\\":[\\\\n \\\\\\"acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01\\\\\\",\\\\n \\\\\\"acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*\\\\\\"\\\\n ]\\\\n }\\\\n ]\\\\n } \\"","type":"json"}]', + 'title' => 'GetAccessPointPolicy', + ], + 'DeleteAccessPointPolicy' => [ + 'summary' => 'Deletes an access point policy.', + 'path' => '/?accessPointPolicy', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'header', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteAccessPointPolicy', + ], + 'PutAccessPointPolicy' => [ + 'summary' => 'Configures an access point policy.', + 'path' => '/?accessPointPolicy', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The configurations of the access point policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Version":"1",'."\n" + .' "Statement":['."\n" + .' {'."\n" + .' "Action":['."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Effect":"Deny",'."\n" + .' "Principal":["27737962156157xxxx"],'."\n" + .' "Resource":['."\n" + .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01",'."\n" + .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' } ', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutAccessPointPolicy', + ], + 'DeleteAccessPoint' => [ + 'summary' => 'Deletes an access point.', + 'path' => '/?accessPoint', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteAccessPoint', + ], + 'CreateAccessPoint' => [ + 'summary' => 'Creates an access point.', + 'path' => '/?accessPoint', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'CreateAccessPointConfiguration' => [ + 'description' => 'The container that stores the information about the access point.', + 'required' => false, + '$ref' => '#/components/schemas/CreateAccessPointConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CreateAccessPointResult' => [ + 'description' => 'The container that stores the information about the access point.', + '$ref' => '#/components/schemas/CreateAccessPointResult', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CreateAccessPointResult/>","type":"xml"}]', + 'title' => 'CreateAccessPoint', + 'description' => '* You can create up to 1,000 access points for an Alibaba Cloud account.'."\n" + .'* You can create up to 100 access points for a bucket.'."\n", + ], + 'InitiateBucketWorm' => [ + 'summary' => 'Creates a retention policy.', + 'path' => '/?worm', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'InitiateWormConfiguration' => [ + 'description' => 'The parameters for WORM initialization.', + 'required' => false, + '$ref' => '#/components/schemas/InitiateWormConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-worm-id' => [ + 'schema' => [ + 'sdkPropertyName' => 'wormId', + 'type' => 'string', + ], + ], + ], + ], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'InitiateBucketWorm', + 'description' => 'Object Storage Service (OSS) supports the Write Once Read Many (WORM) feature that prevents an object from being deleted or overwritten for a specific period of time. You can configure a time-based retention policy for buckets. This policy has a protection period ranging from 1 day to 70 years.'."\n" + ."\n" + .'* If a retention policy is not locked within 24 hours after it is created, the retention policy becomes invalid. After a retention policy configured for a bucket is locked, you can read objects from or upload objects to the bucket. You cannot delete the retention policy or objects in the bucket within the retention period. You can delete the objects only after the retention period elapses. For more information about retention policies, see [Retention policy](~~90564~~).'."\n" + .'* You cannot enable versioning and configure retention policies for a bucket at the same time. If versioning is enabled for a bucket, you cannot configure retention policies for the bucket. For more information about versioning, see [Overview](~~109685~~).'."\n", + ], + 'AbortBucketWorm' => [ + 'summary' => 'Deletes an unlocked retention policy for a bucket.', + 'path' => '/?worm', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'AbortBucketWorm', + 'description' => 'By default, a time-based retention policy is in the InProgress state after the policy is created for a bucket. The state remains valid for 24 hours. Within the 24 hours, the retention policy protects the data in the bucket.'."\n" + ."\n" + .'* In the 24-hour window after the retention policy is enabled: If the retention policy is not locked, the bucket owner and authorized users can delete this policy. If the retention policy is locked, the protection period of the policy cannot be shortened and the policy cannot be deleted. The protection period can only be prolonged.'."\n" + .'* 24 hours after the retention policy is enabled: If the retention policy is not locked, the policy becomes invalid.'."\n" + ."\n" + .'\\'."\n" + .'If a bucket contains objects that are within the protection period, you cannot delete the bucket or its retention policy. If a bucket is deleted, the retention policy of the bucket is also deleted. Only the bucket owner can delete a bucket when the bucket is empty.'."\n", + ], + 'CompleteBucketWorm' => [ + 'summary' => 'Locks a retention policy.', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'wormId', + 'in' => 'query', + 'schema' => [ + 'title' => 'The ID of the retention policy', + 'description' => 'The ID of the retention policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1666E2CFB2B3418****', + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CompleteBucketWorm', + 'description' => 'By default, a time-based policy is in the InProgress state after the policy is created for a bucket. The policy remains in this state for 24 hours. Within the 24 hours, the retention policy protects the data in the bucket.'."\n" + ."\n" + .'* In the 24-hour window after the retention policy is enabled: If the retention policy is not locked, the bucket owner and authorized users can delete this policy. If the retention policy is locked, the policy cannot be deleted and the retention period specified by the retention policy can only be extended.'."\n" + .'* 24 hours after the retention policy is enabled: If the retention policy is not locked, the policy becomes invalid.'."\n", + ], + 'ExtendBucketWorm' => [ + 'summary' => 'Extends the retention period of objects in a bucket for which a retention policy is locked.', + 'path' => '/?wormExtend', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'wormId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the retention policy.'."\n" + ."\n" + .'> If the ID of the retention policy that specifies the number of days for which objects can be retained does not exist, the HTTP status code 404 is returned.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1666E2CFB2B3418****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'ExtendWormConfiguration' => [ + 'description' => 'The parameters for WORM extension.', + 'required' => false, + '$ref' => '#/components/schemas/ExtendWormConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + '5xx' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'ExtendBucketWorm', + 'description' => 'By default, a time-based retention policy is in the InProgress state after the policy is created for a bucket. The policy remains in this state for 24 hours. Within the 24 hours, the retention policy protects the data in the bucket.'."\n" + ."\n" + .'* In the 24-hour window after the retention policy is enabled: If the retention policy is not locked, the bucket owner and authorized users can delete this policy. If the retention policy is locked, the policy cannot be deleted and the retention period specified by the retention policy can only be extended.'."\n" + .'* 24 hours after the retention policy is enabled: If the retention policy is not locked, the policy becomes invalid.'."\n" + ."\n" + .'If a bucket contains an object that is within the protection period, you cannot delete the bucket or the retention policy of the bucket. Only the owner of a bucket can delete the bucket when the bucket is empty. If a bucket is deleted, the retention policy of the bucket is also deleted.'."\n" + ."\n" + .'> If the ID of the retention policy that specifies the number of days for which objects can be retained does not exist, Object Storage Service (OSS) returns the HTTP status code 404.'."\n", + ], + 'GetBucketWorm' => [ + 'summary' => 'Queries the retention policy configured for a bucket.', + 'path' => '/?worm', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'WormConfiguration' => [ + 'description' => 'The container that stores the information about retention policies of the bucket.', + 'type' => 'object', + 'properties' => [ + 'WormId' => [ + 'description' => 'The ID of the retention policy.'."\n" + ."\n" + .'>Note If the specified retention policy ID that is used to query the retention policy configurations of the bucket does not exist, OSS returns the 404 error code.', + 'type' => 'string', + 'example' => '1666E2CFB2B3418****', + ], + 'State' => [ + 'description' => 'The status of the retention policy. Valid values:'."\n" + ."\n" + .'- InProgress: indicates that the retention policy is in the InProgress state. By default, a retention policy is in the InProgress state after it is created. The policy remains in this state for 24 hours.'."\n" + .'- Locked: indicates that the retention policy is in the Locked state.', + '$ref' => '#/components/schemas/BucketWormState', + ], + 'RetentionPeriodInDays' => [ + 'description' => 'The number of days for which objects can be retained.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CreationDate' => [ + 'description' => 'The time at which the retention policy was created.', + 'type' => 'string', + 'example' => '2020-10-15T15:50:32', + ], + 'ExpirationDate' => [ + 'type' => 'string', + 'description' => 'The time at which the retention policy will be expired.', + 'example' => '2020-10-16T15:50:32', + ], + ], + ], + ], + 'description' => 'The container of the request body.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<WormConfiguration>\\n <WormId>1666E2CFB2B3418****</WormId>\\n <RetentionPeriodInDays>20</RetentionPeriodInDays>\\n <CreationDate>2020-10-15T15:50:32</CreationDate>\\n <ExpirationDate>2020-10-20T15:50:32\\n</ExpirationDate>\\n</WormConfiguration>","type":"xml"}]', + 'title' => 'GetBucketWorm', + 'description' => 'Object Storage Service (OSS) supports the Write Once Read Many (WORM) feature. This prevents data stored in OSS from being deleted or modified when the data is used within the retention period specified by a retention policy. You can configure a time-based retention policy for a bucket. This policy has a protection period ranging from one day to 70 years.\\'."\n" + .'After a retention policy configured for a bucket is locked, you can read objects from or upload objects to the bucket. The retention policy or objects in the bucket cannot be deleted within the retention period. You can delete the objects only after the retention period expires.'."\n" + ."\n" + .'> If the ID of a retention policy that is used to query the retention policy configurations of the bucket does not exist, OSS returns the 404 error code.'."\n", + ], + 'PutBucketAcl' => [ + 'summary' => 'Configures or modifies the access control list (ACL) for a bucket.', + 'path' => '/?acl', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The ACL that you want to configure or modify for the bucket. The x-oss-acl header is included in PutBucketAcl requests to configure or modify the ACL of the bucket. If this header is not included, the ACL configurations do not take effect.\\'."\n" + .'Valid values:'."\n" + ."\n" + .'* public-read-write: All users can read and write objects in the bucket. Exercise caution when you set the value to public-read-write.'."\n" + .'* public-read: Only the owner and authorized users of the bucket can read and write objects in the bucket. Other users can only read objects in the bucket. Exercise caution when you set the value to public-read.'."\n" + .'* private: Only the owner and authorized users of this bucket can read and write objects in the bucket. Other users cannot access objects in the bucket.'."\n", + 'required' => true, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/BucketACL', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketAcl', + 'description' => '* To call this operation, you must have the `oss:PutBucketAcl` permission on the bucket.'."\n" + .'* This operation uses the overwriting semantics. A new ACL overwrites the existing one.'."\n" + .'* If the specified bucket for which you want to configure or modify the ACL does not exist when you call this operation, a new bucket is created.'."\n", + ], + 'GetBucketAcl' => [ + 'summary' => 'Queries the access control list (ACL) of a bucket. Only the owner of a bucket can query the ACL of the bucket.', + 'path' => '/?acl', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessControlPolicy' => [ + 'description' => 'The container that stores the ACL information.', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The container that stores the information about the bucket owner.', + '$ref' => '#/components/schemas/Owner', + ], + 'AccessControlList' => [ + 'description' => 'The class of the container that stores the ACL information.', + 'type' => 'object', + 'properties' => [ + 'Grant' => [ + 'description' => 'The ACL of the bucket.', + '$ref' => '#/components/schemas/BucketACL', + ], + ], + ], + ], + ], + ], + 'description' => 'The container of the response body.', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<AccessControlPolicy>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <AccessControlList/>\\n</AccessControlPolicy>","type":"xml"}]', + 'title' => 'GetBucketAcl', + ], + 'PutBucketLifecycle' => [ + 'summary' => 'Configures a lifecycle rule for a bucket. After you configure a lifecycle rule for a bucket, Object Storage Service (OSS) automatically deletes the objects that match the rule or converts the storage type of the objects based on the point in time that is specified in the lifecycle rule.', + 'path' => '/?lifecycle', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '9066', + 'abilityTreeNodes' => [ + 'FEATUREoss20S3WM', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-allow-same-action-overlap', + 'in' => 'header', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Specifies whether to allow overlapped prefixes. Valid values:'."\n" + ."\n" + .'true: Overlapped prefixes are allowed.'."\n" + ."\n" + .'false: Overlapped prefixes are not allowed.', + 'example' => 'true', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'LifecycleConfiguration' => [ + 'description' => 'The container that stores the lifecycle configuration.', + 'required' => false, + '$ref' => '#/components/schemas/LifecycleConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketLifecycle', + 'description' => '* Only the bucket owner or Resource Access Management (RAM) users that are granted the PutBucketLifecycle permission can send a request to configure a lifecycle rule for a bucket.'."\n" + .'* If no lifecycle rules are configured for a bucket, a lifecycle rule is created after you call the PutBucketLifecycle operation. If the bucket has an existing lifecycle rule, a new lifecycle rule is created and the existing lifecycle rule is overwritten.'."\n" + .'* The PutBucketLifecycle operation uses the overwriting semantics. If you want to configure a new lifecycle rule for a bucket, call the GetBucketLifecycle operation to query the configurations of the existing lifecycle rule, modify the configurations, and then call the PutBucketLifecycle operation to update the configurations.'."\n" + .'* When you call the PutBucketLifecycle operation, you can specify a validity period for objects or parts that are uploaded in incomplete multipart upload tasks.'."\n", + ], + 'GetBucketLifecycle' => [ + 'summary' => 'Queries the lifecycle rules configured for a bucket. Only the owner of a bucket has the permissions to query the lifecycle rules configured for the bucket.', + 'path' => '/?lifecycle', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9037', + 'abilityTreeNodes' => [ + 'FEATUREoss20S3WM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + 'title' => '存储空间名称', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LifecycleConfiguration' => [ + 'description' => 'The container that stores the lifecycle rules configured for the bucket.', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'description' => 'The container that stores the lifecycle rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the lifecycle rule.'."\n" + ."\n" + .'- A lifecycle rule cannot be configured for a bucket to dump the expired objects in the bucket to the Archive storage class.'."\n" + .'- The period of time from when the objects expire to when the objects are deleted must be longer than the period of time from when the objects expire to when the expired objects are dumped to the Infrequent Access (IA) or Archive storage class.', + '$ref' => '#/components/schemas/LifecycleRule', + ], + ], + ], + 'title' => '保存存储空间生命周期规则的容器', + '$ref' => '#/components/schemas/LifecycleConfiguration', + ], + ], + 'description' => '', + 'title' => '接口响应体', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<LifecycleConfiguration>\\n <Rule>\\n <ID>rule1</ID>\\n <Prefix>logs/</Prefix>\\n <Status>Enabled</Status>\\n <Expiration>\\n <CreatedBeforeDate>2002-10-11T00:00:00.000Z</CreatedBeforeDate>\\n <Days>365</Days>\\n <ExpiredObjectDeleteMarker>true</ExpiredObjectDeleteMarker>\\n <Date>2002-10-11T00:00:00.000Z</Date>\\n </Expiration>\\n <Transition>\\n <CreatedBeforeDate>2002-10-11T00:00:00.000Z</CreatedBeforeDate>\\n <Days>200</Days>\\n <IsAccessTime>true</IsAccessTime>\\n <ReturnToStdWhenVisit>false</ReturnToStdWhenVisit>\\n <AllowSmallFile>true</AllowSmallFile>\\n </Transition>\\n <AbortMultipartUpload>\\n <Days>300</Days>\\n <CreatedBeforeDate>2002-10-11T00:00:00.000Z</CreatedBeforeDate>\\n </AbortMultipartUpload>\\n <Tag>\\n <Key/>\\n <Value/>\\n </Tag>\\n <NoncurrentVersionExpiration>\\n <NoncurrentDays>350</NoncurrentDays>\\n </NoncurrentVersionExpiration>\\n <NoncurrentVersionTransition>\\n <NoncurrentDays>200</NoncurrentDays>\\n <IsAccessTime>true</IsAccessTime>\\n <ReturnToStdWhenVisit>false</ReturnToStdWhenVisit>\\n <AllowSmallFile>true</AllowSmallFile>\\n </NoncurrentVersionTransition>\\n <Filter>\\n <Not>\\n <Prefix>logs/keep/</Prefix>\\n <Tag>\\n <Key/>\\n <Value/>\\n </Tag>\\n </Not>\\n <ObjectSizeGreaterThan>10240</ObjectSizeGreaterThan>\\n <ObjectSizeLessThan>10240</ObjectSizeLessThan>\\n </Filter>\\n <AtimeBase>1626158525</AtimeBase>\\n </Rule>\\n</LifecycleConfiguration>","type":"xml"}]', + 'title' => 'GetBucketLifecycle', + ], + 'DeleteBucketLifecycle' => [ + 'summary' => 'Deletes the lifecycle rules of a bucket.', + 'path' => '/?lifecycle', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '9024', + 'abilityTreeNodes' => [ + 'FEATUREoss20S3WM', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketLifecycle', + 'description' => '* Only the bucket owner can delete lifecycle rules for a bucket.'."\n" + .'* After you call the DeleteBucketLifecycle operation to delete all lifecycle rules for a bucket, the objects in the bucket are not deleted.'."\n", + ], + 'PutBucketTransferAcceleration' => [ + 'summary' => 'Configures transfer acceleration for a bucket. After you enable transfer acceleration for a bucket, the object access speed is accelerated for users worldwide. The transfer acceleration feature is applicable to scenarios where data needs to be transferred over long geographical distances. This feature can also be used to download or upload objects that are gigabytes or terabytes in size.', + 'path' => '/?transferAcceleration', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'TransferAccelerationConfiguration' => [ + 'description' => 'The container that stores the transfer acceleration configurations.', + 'required' => false, + '$ref' => '#/components/schemas/TransferAccelerationConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketTransferAcceleration', + 'description' => '* Only the bucket owner or Resource Access Management (RAM) users to which the oss:PutBucketTransferAcceleration permission is granted can send requests to configure transfer acceleration for a bucket.'."\n" + .'* After you enable transfer acceleration for a bucket, an accelerate endpoint is created for the bucket. You can use the accelerate endpoint in addition to the default endpoint to access the bucket. The access speed is accelerated only when you use the accelerate endpoint.'."\n" + .'* You are charged for the transfer acceleration fees when you use the accelerate endpoint to access a bucket. For more information, see [Transfer acceleration fees](~~173539~~).'."\n" + ."\n" + .'For more information about transfer acceleration, see [Enable transfer acceleration](~~131312~~).'."\n", + ], + 'GetBucketTransferAcceleration' => [ + 'summary' => 'Queries the transfer acceleration configurations of a bucket.', + 'path' => '/?transferAcceleration', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TransferAccelerationConfiguration' => [ + 'description' => 'The container that stores the transfer acceleration configurations.', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => 'Whether the transfer acceleration is enabled for this bucket.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'description' => 'The container of the response body.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<TransferAccelerationConfiguration>\\n <Enabled>true</Enabled>\\n</TransferAccelerationConfiguration>","type":"xml"}]', + 'title' => 'GetBucketTransferAcceleration', + 'description' => '* Only the bucket owner or Resource Access Management (RAM) users that are granted the oss:GetBucketTransferAcceleration permission can call this operation to query the transfer acceleration configurations of a bucket.'."\n" + .'* If transfer acceleration is not configured for the bucket, no configurations are returned.'."\n" + ."\n" + .'For more information about transfer acceleration, see [Enable transfer acceleration](~~131312~~).'."\n", + ], + 'PutBucketVersioning' => [ + 'summary' => 'Configures the versioning state for a bucket.', + 'path' => '/?versioning', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'VersioningConfiguration' => [ + 'description' => 'The container that stores the versioning state of the bucket.', + 'required' => false, + '$ref' => '#/components/schemas/VersioningConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketVersioning', + 'description' => '* Before you configure the versioning state for a bucket, you must have the PutBucketVersioning permission.'."\n" + .'* A bucket can be in one of the following versioning states: disabled, enabled, and suspended. By default, versioning is disabled for a bucket.'."\n" + .'* If versioning is enabled for a bucket, Object Storage Service (OSS) generates unique version IDs for all objects that are added to the bucket. In this case, OSS stores multiple versions of the objects.'."\n" + .'* If versioning is suspended for a bucket, OSS generates the version ID null for all objects that are added to the bucket. In this case, OSS does not store new versions for objects that are deleted or overwritten.'."\n" + ."\n" + .'For more information about versioning, see [Overview](~~109695~~).'."\n", + ], + 'GetBucketVersioning' => [ + 'summary' => 'Queries the versioning state of a bucket.', + 'path' => '/?versioning', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'VersioningConfiguration' => [ + 'description' => 'The container that stores the versioning state of the bucket.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The versioning state of the bucket.', + '$ref' => '#/components/schemas/BucketVersioningStatus', + ], + ], + ], + ], + ], + ], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<VersioningConfiguration/>","type":"xml"}]', + 'title' => 'GetBucketVersioning', + ], + 'ListObjectVersions' => [ + 'summary' => 'Queries the information about the versions of all objects in a bucket, including the delete markers.', + 'path' => '/?versions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'delimiter', + 'in' => 'query', + 'schema' => [ + 'title' => 'The character used to group objects by name', + 'description' => 'The character that is used to group objects by name. If you specify prefix and delimiter in the request, the response contains CommonPrefixes. The objects whose name contains the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in CommonPrefixes. If you specify prefix and set delimiter to a forward slash (/), only the objects in the directory are listed. The subdirectories in the directory are returned in CommonPrefixes. Objects and subdirectories in the subdirectories are not listed.'."\n" + ."\n" + .'By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'key-marker', + 'in' => 'query', + 'schema' => [ + 'title' => 'The name of the object from which the list operation begins', + 'description' => 'The name of the object after which the GetBucketVersions (ListObjectVersions) operation begins. If this parameter is specified, objects whose name is alphabetically after the value of key-marker are returned. Use key-marker and version-id-marker in combination. The value of key-marker must be less than 1,024 bytes in length.'."\n" + ."\n" + .'By default, this parameter is left empty.'."\n" + ."\n" + .'> You must also specify key-marker if you specify version-id-marker.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'version-id-marker', + 'in' => 'query', + 'schema' => [ + 'title' => 'The version id of the object from which the list operation begins', + 'description' => 'The version ID of the object specified in key-marker after which the GetBucketVersions (ListObjectVersions) operation begins. The versions are returned from the latest version to the earliest version. If version-id-marker is not specified, the GetBucketVersions (ListObjectVersions) operation starts from the latest version of the object whose name is alphabetically after the value of key-marker by default.'."\n" + ."\n" + .'By default, this parameter is left empty.'."\n" + ."\n" + .'Valid values: version IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'title' => 'The maximum number of objects to return', + 'description' => 'The maximum number of objects to be returned. If the number of returned objects exceeds the value of max-keys, the response contains `NextKeyMarker` and `NextVersionIdMarker`. Specify the values of `NextKeyMarker` and `NextVersionIdMarker` as the markers for the next request. Valid values: 1 to 999. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'title' => 'The prefix that the returned object names must contain', + 'description' => 'The prefix that the names of returned objects must contain.'."\n" + ."\n" + .'* The value of prefix must be less than 1,024 bytes in length.'."\n" + .'* If you specify prefix, the names of the returned objects contain the prefix.'."\n" + ."\n" + .'If you set prefix to a directory name, the objects whose name starts with the prefix are listed. The returned objects consist of all objects and subdirectories in the directory.'."\n" + ."\n" + .'By default, this parameter is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fun', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'title' => 'The encoding type of the object name in the response', + 'description' => 'The encoding type of the content in the response. By default, this parameter is left empty. Set the value to URL.'."\n" + ."\n" + .'> The values of Delimiter, Marker, Prefix, NextMarker, and Key are UTF-8 encoded. If the value of Delimiter, Marker, Prefix, NextMarker, or Key contains a control character that is not supported by Extensible Markup Language (XML) 1.0, you can specify encoding-type to encode the value in the response.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/EncodeType', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The container that stores the response to the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'ListVersionsResult' => [ + 'description' => 'The container that stores the results of the ListObjectVersions (GetBucketVersions) request.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'The bucket name', + 'description' => 'The bucket name', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Prefix' => [ + 'title' => 'The prefix that the names of returned objects must contain', + 'description' => 'The prefix contained in the names of the returned objects.', + 'type' => 'string', + 'example' => 'logs/', + ], + 'KeyMarker' => [ + 'title' => 'Indicates the object from which the operation starts', + 'description' => 'Indicates the object from which the ListObjectVersions (GetBucketVersions) operation starts.', + 'type' => 'string', + 'example' => 'abc', + ], + 'VersionIdMarker' => [ + 'title' => 'This parameter is returned with KeyMarker together to indicate the version from which the operation starts', + 'description' => 'The version from which the ListObjectVersions (GetBucketVersions) operation starts. This parameter is used together with KeyMarker.', + 'type' => 'string', + 'example' => 'CAEQGBiBgIC_jq7P9xYiIDRiZWJkNjY2Y2Q4NDQ5ZTI5ZGE5ODIxMTIyZThl****', + ], + 'MaxKeys' => [ + 'title' => 'The maximum number of returned objects in the response', + 'description' => 'The maximum number of objects that can be returned in the response.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Delimiter' => [ + 'description' => 'The character that is used to group objects by name. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result parameter in CommonPrefixes.', + 'type' => 'string', + 'example' => '/', + ], + 'IsTruncated' => [ + 'title' => 'Indicates whether the returned results are truncated', + 'description' => 'Indicates whether the returned results are truncated.'."\n" + ."\n" + .'- true: indicates that not all results are returned for the request.'."\n" + .'- false: indicates that all results are returned for the request.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EncodingType' => [ + 'description' => 'The encoding type of the content in the response. If you specify encoding-type in the request, the values of Delimiter, Marker, Prefix, NextMarker, and Key are encoded in the response.', + 'type' => 'string', + 'example' => 'url', + ], + 'NextKeyMarker' => [ + 'description' => 'If not all results are returned for the request, the NextKeyMarker parameter is included in the response to indicate the key-marker value of the next ListObjectVersions (GetBucketVersions) request.', + 'type' => 'string', + 'example' => 'def', + ], + 'NextVersionIdMarker' => [ + 'description' => 'If not all results are returned for the request, the NextVersionIdMarker parameter is included in the response to indicate the version-id-marker value of the next ListObjectVersions (GetBucketVersions) request.', + 'type' => 'string', + 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****', + ], + 'Version' => [ + 'title' => 'The container that stores the versions of objects except for delete markers', + 'description' => 'The container that stores the versions of objects except for delete markers', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of a specific version of objects, excluding delete markers.', + '$ref' => '#/components/schemas/ObjectVersion', + ], + ], + 'DeleteMarker' => [ + 'title' => 'The container that stores delete markers', + 'description' => 'The container that stores delete markers', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of a specific delete markets.', + '$ref' => '#/components/schemas/DeleteMarkerEntry', + ], + ], + 'CommonPrefixes' => [ + 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', + 'description' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', + 'type' => 'array', + 'items' => [ + 'description' => 'If the delimiter parameter is specified in the request, the response contains the CommonPrefixes parameter. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result parameter in CommonPrefixes.', + '$ref' => '#/components/schemas/CommonPrefix', + ], + ], + ], + ], + ], + ], + ], + '4xx' => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListVersionsResult>\\n <Name>example-bucket</Name>\\n <Prefix>logs/</Prefix>\\n <KeyMarker>abc</KeyMarker>\\n <VersionIdMarker>CAEQGBiBgIC_jq7P9xYiIDRiZWJkNjY2Y2Q4NDQ5ZTI5ZGE5ODIxMTIyZThl****</VersionIdMarker>\\n <MaxKeys>20</MaxKeys>\\n <Delimiter>/</Delimiter>\\n <IsTruncated>true</IsTruncated>\\n <EncodingType>url</EncodingType>\\n <NextKeyMarker>def</NextKeyMarker>\\n <NextVersionIdMarker>CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****</NextVersionIdMarker>\\n <Version>\\n <Key>dic/test.txt</Key>\\n <VersionId>CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****</VersionId>\\n <IsLatest>false</IsLatest>\\n <LastModified>2023-04-09T07:27:28.000Z</LastModified>\\n <ETag>\\"250F8A0AE989679A22926A875F0A2****\\"</ETag>\\n <Size>93731</Size>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <RestoreInfo>ongoing-request=\\"true\\"</RestoreInfo>\\n <TransitionTime>2023-04-09T07:27:28.000Z</TransitionTime>\\n </Version>\\n <DeleteMarker>\\n <Key/>\\n <VersionId/>\\n <IsLatest>true</IsLatest>\\n <LastModified/>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n </DeleteMarker>\\n <CommonPrefixes>\\n <Prefix/>\\n </CommonPrefixes>\\n</ListVersionsResult>","type":"xml"}]', + 'title' => 'ListObjectVersions', + 'description' => '* If you call the GetBucket (ListObjects) operation, the current versions of objects in the bucket are returned, excluding the delete markers.'."\n" + .'* If you call the GetBucketVersions (ListObjectVersions) operation, all versions of objects in the bucket are returned, including the delete markers.'."\n" + ."\n" + .'Objects are returned in alphabetical order, but the versions of each object are returned from the latest version to the earliest version.', + ], + 'PutBucketPolicy' => [ + 'summary' => 'Configures a policy for a bucket.', + 'path' => '/?policy', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '9319', + 'abilityTreeNodes' => [ + 'FEATUREossHKEIZ2', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Version":"1",'."\n" + .' "Statement":['."\n" + .' {'."\n" + .' "Action":['."\n" + .' "oss:PutObject",'."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Effect":"Deny",'."\n" + .' "Principal":["1234567890"],'."\n" + .' "Resource":["acs:oss:*:1234567890:*/*"]'."\n" + .' }'."\n" + .' ]'."\n" + .' }', + 'format' => 'binary', + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketPolicy', + 'description' => '* Authorize Resource Access Management (RAM) users of other Alibaba Cloud accounts to access your Object Storage Service (OSS) resources.'."\n" + ."\n" + .'You can authorize RAM users of other Alibaba Cloud accounts to access your OSS resources.'."\n" + ."\n" + .'* Authorize anonymous users to access your OSS resources from the specified IP addresses.'."\n" + ."\n" + .'In some cases, you need to authorize anonymous users to access your OSS resources from the specified IP addresses. For example, you want to authorize employees to access confidential documents only from the IP address of your company. If your company has a large number of employees, you need to perform complex operations to configure a policy for each RAM user. In this case, you can configure a policy that allows only access from the specified IP addresses for a bucket. This allows you to efficiently authorize the employees.'."\n" + ."\n" + .'For more information about how to configure a bucket policy and the scenarios of the bucket policy, see [Overview](~~85111~~). For more information about the policy syntax, see [Policy structure and syntax](~~93739~~).'."\n", + ], + 'GetBucketPolicy' => [ + 'summary' => 'Queries the policies configured for a bucket.', + 'path' => '/?policy', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'A string that indicates the bucket policy.', + 'type' => 'string', + 'example' => '-', + ], + ], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"-\\"","type":"json"}]', + 'title' => 'GetBucketPolicy', + 'description' => '* Authorize Resource Access Management (RAM) users of other Alibaba Cloud accounts to access your Object Storage Service (OSS) resources.'."\n" + ."\n" + .'You can authorize RAM users of other Alibaba Cloud accounts to access your OSS resources.'."\n" + ."\n" + .'* Authorize anonymous users to access your OSS resources from specified IP addresses.'."\n" + ."\n" + .'In some cases, you need to authorize anonymous users to access your OSS resources from specified IP addresses. For example, you want to authorize employees only in your company address but not in other regions to access confidential documents. If your company has a large number of employees, you need to perform complex operations to configure policies for RAM users that are used by the employees. In this case, you can configure a bucket policy that allows only access from specified IP addresses for a bucket. This allows you to efficiently authorize the employees.'."\n" + ."\n" + .'For more information about how to configure a bucket policy and the scenarios of the bucket policy, see [Overview](~~85111~~). For more information about the policy syntax, see [Policy structure and syntax](~~93739~~).'."\n", + ], + 'DeleteBucketPolicy' => [ + 'summary' => 'Deletes a policy for a bucket.', + 'path' => '/?policy', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketPolicy', + 'description' => '* Authorize Resource Access Management (RAM) users of other Alibaba Cloud accounts to access your Object Storage Service (OSS) resources.'."\n" + ."\n" + .'You can authorize RAM users of other Alibaba Cloud accounts to access your OSS resources.'."\n" + ."\n" + .'* Authorize anonymous users to access your OSS resources from specified IP addresses.'."\n" + ."\n" + .'In some cases, you need to authorize anonymous users to access your OSS resources from specified IP addresses. For example, you want to authorize employees to access confidential documents only from the IP address of your company. If your company has a large number of employees, you need to perform complex operations to configure policies for RAM users that are used by the employees. In this case, you can configure a policy that allows only access from specified IP addresses for a bucket. This allows you to efficiently authorize the employees.'."\n" + ."\n" + .'For more information about how to configure a bucket policy and the scenarios of the bucket policy, see [Overview](~~85111~~). For more information about the policy syntax, see [Policy structure and syntax](~~93739~~).'."\n", + ], + 'GetBucketPolicyStatus' => [ + 'summary' => 'Checks whether the current bucket policy allows public access.', + 'path' => '/?policyStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207996', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + 'FEATUREossHKEIZ2', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => false, + 'example' => 'example-bucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PolicyStatus' => [ + 'description' => 'The container that stores public access information.', + 'type' => 'object', + 'properties' => [ + 'IsPublic' => [ + 'description' => 'Indicates whether the current bucket policy allows public access.'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<PolicyStatus>\\n <IsPublic>true</IsPublic>\\n</PolicyStatus>","type":"xml"}]', + 'title' => 'GetBucketPolicyStatus', + ], + 'PutBucketRtc' => [ + 'summary' => 'Enables or disables the Replication Time Control (RTC) feature for existing cross-region replication (CRR) rules.', + 'path' => '/?rtc', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '182629', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'ReplicationRule' => [ + 'description' => 'The container that stores the RTC configurations.', + 'required' => false, + '$ref' => '#/components/schemas/RtcConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketRtc', + ], + 'PutBucketReplication' => [ + 'summary' => 'Configures data replication rules for a bucket. Object Storage Service (OSS) supports cross-region replication (CRR) and same-region replication (SRR).', + 'path' => '/?replication&comp=add', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '9452', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'ReplicationConfiguration' => [ + 'description' => 'The container that stores data replication configurations.', + 'required' => false, + '$ref' => '#/components/schemas/ReplicationConfiguration', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + '$ref' => '#/components/schemas/ReplicationRule', + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-replication-rule-id' => [ + 'schema' => [ + 'title' => '新增数据复制规则的ID', + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketReplication', + 'description' => 'You can use data replication features to automatically synchronize objects and the operations performed on the objects such as creation, overwriting, and deletion operations from a source bucket to a destination bucket. When you use data replication features, take note of the following items:'."\n" + ."\n" + .'* Data is asynchronously replicated. The time that is required to replicate data from the source bucket to the destination bucket may range from a few minutes to a few hours. The replication time varies based on the data size.'."\n" + .'* The source bucket and the destination bucket cannot have the same name.'."\n" + .'* When you use CRR, the source bucket and the destination bucket must be located in different regions. When you use SRR, the source bucket and the destination bucket must be located in the same region.'."\n" + ."\n" + .'For more information, see [CRR](https://help.aliyun.com/document_detail/31864.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-zjp-31z-5db) and [SRR](https://help.aliyun.com/document_detail/254865.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-2067125).'."\n", + ], + 'GetBucketReplication' => [ + 'summary' => 'Queries the data replication rules configured for a bucket.', + 'path' => '/?replication', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9458', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReplicationConfiguration' => [ + 'description' => 'The container that stores data replication configurations.', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'description' => 'The container that stores the data replication rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of a specific replication rule.', + '$ref' => '#/components/schemas/ReplicationRule', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ReplicationConfiguration>\\n <Rule>\\n <ID>first-repl-rule</ID>\\n <PrefixSet>\\n <Prefix>to-backup/</Prefix>\\n </PrefixSet>\\n <Action>ALL</Action>\\n <Destination>\\n <Bucket>destbucket</Bucket>\\n <Location>oss-cn-hangzhou</Location>\\n <TransferType>internal</TransferType>\\n </Destination>\\n <Status>doing</Status>\\n <HistoricalObjectReplication>disabled</HistoricalObjectReplication>\\n <SyncRole>aliyunramrole</SyncRole>\\n <SourceSelectionCriteria>\\n <SseKmsEncryptedObjects>\\n <Status>Disabled</Status>\\n </SseKmsEncryptedObjects>\\n </SourceSelectionCriteria>\\n <EncryptionConfiguration>\\n <ReplicaKmsKeyID>c4d49f85-ee30-426b-a5ed-95e9139dxxxxx</ReplicaKmsKeyID>\\n </EncryptionConfiguration>\\n <RTC>\\n <Status>Enabled</Status>\\n </RTC>\\n </Rule>\\n</ReplicationConfiguration>","type":"xml"}]', + 'title' => 'GetBucketReplication', + ], + 'GetBucketReplicationLocation' => [ + 'summary' => 'Queries the regions in which available destination buckets reside. You can determine the region of the destination bucket to which the data in the source bucket are replicated based on the returned response.', + 'path' => '/?replicationLocation', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReplicationLocation' => [ + 'description' => 'The container that stores the region in which the destination bucket can be located.', + 'type' => 'object', + 'properties' => [ + 'Location' => [ + 'description' => 'The regions in which the destination bucket can be located.', + 'type' => 'array', + 'items' => [ + 'description' => '> If the destination bucket can be located in multiple regions, multiple regions are contained in the response. If regions in which the destination bucket can be located do not exist, the value of Location is null.', + 'type' => 'string', + 'example' => 'oss-cn-beijing', + ], + ], + 'LocationTransferTypeConstraint' => [ + 'description' => 'The container that stores regions in which the destination bucket can be located with TransferType specified.', + 'type' => 'object', + 'properties' => [ + 'LocationTransferType' => [ + 'description' => 'The container that stores regions in which the destination bucket can be located with the TransferType information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the transmission type.', + '$ref' => '#/components/schemas/LocationTransferType', + ], + ], + ], + ], + 'LocationRTCConstraint' => [ + 'type' => 'object', + 'properties' => [ + 'Location' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'The region in which the RTC can be enabled.', + 'example' => 'oss-cn-beijing', + ], + 'description' => 'The regions where RTC is supported.', + ], + ], + 'description' => 'The container that stores regions in which the RTC can be enabled.', + ], + ], + ], + ], + ], + ], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ReplicationLocation>\\n <Location>oss-cn-beijing</Location>\\n <LocationTransferTypeConstraint>\\n <LocationTransferType>\\n <Location>oss-eu-west-1</Location>\\n <TransferTypes>\\n <Type>oss_acc</Type>\\n </TransferTypes>\\n </LocationTransferType>\\n </LocationTransferTypeConstraint>\\n <LocationRTCConstraint>\\n <Location>oss-cn-beijing</Location>\\n </LocationRTCConstraint>\\n</ReplicationLocation>","type":"xml"}]', + 'title' => 'GetBucketReplicationLocation', + ], + 'GetBucketReplicationProgress' => [ + 'summary' => 'Queries the information about the data replication process of a bucket.', + 'path' => '/?replicationProgress', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9465', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucekt.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'rule-id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data replication rule. You can call the GetBucketReplication operation to query the ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_replication_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The container that is used to store the progress of data replication tasks.', + 'type' => 'object', + 'properties' => [ + 'ReplicationProgress' => [ + 'description' => 'The container that is used to store the progress of data replication tasks.', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'description' => 'The container that stores the progress of the data replication task corresponding to each data replication rule.', + '$ref' => '#/components/schemas/ReplicationProgressRule', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/ReplicationProgressRule', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ReplicationProgress>\\n <Rule>\\n <ID>replicate001</ID>\\n <PrefixSet>\\n <Prefix>to-backup/</Prefix>\\n </PrefixSet>\\n <Action>ALL</Action>\\n <Destination>\\n <Bucket>destbucket</Bucket>\\n <Location>oss-cn-hangzhou</Location>\\n <TransferType>internal</TransferType>\\n </Destination>\\n <Status>doing</Status>\\n <HistoricalObjectReplication>disabled</HistoricalObjectReplication>\\n <Progress>\\n <HistoricalObject>0.85</HistoricalObject>\\n <NewObject>Thu, 24 Sep 2015 15:39:18 GMT</NewObject>\\n </Progress>\\n </Rule>\\n</ReplicationProgress>","type":"xml"}]', + 'title' => 'GetBucketReplicationProgress', + ], + 'DeleteBucketReplication' => [ + 'summary' => 'Disables data replication for a bucket and deletes the data replication rule configured for the bucket. After you call this operation, all operations performed on the source bucket are not synchronized to the destination bucket.', + 'path' => '/?replication&comp=delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '9463', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container of the request body.', + 'type' => 'object', + 'properties' => [ + 'ReplicationRules' => [ + 'description' => 'The container that is used to store the data replication rule to delete.', + 'required' => false, + '$ref' => '#/components/schemas/ReplicationRules', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'type' => 'string', + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketReplication', + 'description' => '* The HTTP status code 200 HTTP OK is returned if no data replication rules are configured for the bucket.'."\n" + .'* A data replication rule is not immediately deleted when you call this operation. Object Storage Service (OSS) takes a period of time to clear the data replication tasks that are executed based on the data replication rule. During the process, the data replication tasks are in the Closing state. After the data replication tasks are cleared, the data replication rule is deleted.'."\n" + .'* If you call this operation to delete a data replication rule in the closing state, the HTTP status code 204 NoContent is returned.'."\n", + ], + 'PutBucketInventory' => [ + 'summary' => 'Configures an inventory for a bucket.', + 'path' => '/?inventory', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '9324', + 'abilityTreeNodes' => [ + 'FEATUREossB6HKQU', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'inventoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the inventory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'report1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Request body schema.', + 'type' => 'object', + 'properties' => [ + 'InventoryConfiguration' => [ + 'description' => 'The container that stores the Inventory configuration.', + 'required' => false, + '$ref' => '#/components/schemas/InventoryConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + ], + 'responseDemo' => '[{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""}]', + 'title' => 'PutBucketInventory', + 'description' => 'You can use an inventory to obtain information about objects in a bucket, such as the quantities, sizes, storage classes, and encryption status of the objects. When you configure an inventory for a bucket, take note of the following items:'."\n" + ."\n" + .'- Only the bucket owner or users who have the PutBucketInventory permission can initiate a PutBucketInventory request.'."\n" + ."\n" + .'- Before you configure an inventory for a bucket, you must create a RAM role that has the permissions to read all objects from the source bucket and write objects to the destination bucket. If you use the bucket inventory feature for the first time, we recommend that you configure an inventory in the Object Storage Service (OSS) console. After you configure the inventory, you can obtain the RAM role that has the permissions to read all objects from the source bucket and write objects to the destination bucket. For more information, see Bucket inventory.'."\n" + ."\n" + .'- You can configure up to 1,000 inventories for a bucket.'."\n" + ."\n" + .'- You must deploy the source bucket for which you want to configure an inventory in the same region as the destination bucket in which the inventory list is stored.', + ], + 'GetBucketInventory' => [ + 'summary' => 'Queries the inventories that are configured for a bucket.', + 'path' => '/?inventory', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9325', + 'abilityTreeNodes' => [ + 'FEATUREossB6HKQU', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'inventoryId', + 'in' => 'query', + 'schema' => [ + 'title' => 'The ID of the inventory rule to query', + 'description' => 'The name of the inventory to be queried.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'list1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'The inventory task configured for a bucket', + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'InventoryConfiguration' => [ + 'description' => 'The inventory task configured for a bucket.', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'id', + 'description' => 'The specified inventory name, which must be globally unique in the bucket.', + 'type' => 'string', + 'example' => 'first', + ], + 'IsEnabled' => [ + 'title' => 'status', + 'description' => 'Indicates whether the inventory feature is enabled.'."\n" + .'Valid values: true and false'."\n" + .'- A value of true indicates that the inventory feature is enabled.'."\n" + .'- A value of false indicates that no inventory list is generated.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Destination' => [ + 'description' => 'The container that stores information about exported inventory lists.', + '$ref' => '#/components/schemas/InventoryDestination', + ], + 'Schedule' => [ + 'description' => 'The container that stores information about the frequency at which inventory lists are exported.', + '$ref' => '#/components/schemas/InventorySchedule', + ], + 'Filter' => [ + 'description' => 'The container that stores the prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory list.', + '$ref' => '#/components/schemas/InventoryFilter', + ], + 'IncludedObjectVersions' => [ + 'description' => 'Indicates whether to include the version information about objects in inventory lists.Valid values: All and Current'."\n" + .'- A value of All indicates that all versions of the objects are exported.'."\n" + .'- A value of Current indicates that only the current versions of the objects are exported.', + '$ref' => '#/components/schemas/InventoryIncludedObjectVersions', + ], + 'OptionalFields' => [ + 'description' => 'The container that stores the configuration fields included in the inventory lists.', + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'description' => 'The configuration fields that are included in inventory lists.', + 'type' => 'array', + 'items' => [ + 'description' => 'Valid values: Size, LastModifiedDate, ETag, StorageClass, IsMultipartUploaded, and EncryptionStatus', + '$ref' => '#/components/schemas/InventoryOptionalField', + ], + ], + ], + ], + ], + '$ref' => '#/components/schemas/InventoryConfiguration', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<InventoryConfiguration>\\n <Id>report1</Id>\\n <IsEnabled>true</IsEnabled>\\n <Destination>\\n <OSSBucketDestination>\\n <AccountId>100000000000000</AccountId>\\n <RoleArn>acs:ram::100000000000000:role/AliyunOSSRole</RoleArn>\\n <Bucket>acs:oss:::bucket_0001</Bucket>\\n <Prefix>prefix1/</Prefix>\\n <Encryption>\\n <SSE-KMS>\\n <KeyId>abcd</KeyId>\\n </SSE-KMS>\\n </Encryption>\\n </OSSBucketDestination>\\n </Destination>\\n <Schedule/>\\n <Filter>\\n <Prefix>Pics/</Prefix>\\n <LastModifyBeginTimeStamp>1637883649</LastModifyBeginTimeStamp>\\n <LastModifyEndTimeStamp>1638347592</LastModifyEndTimeStamp>\\n <LowerSizeBound>1024</LowerSizeBound>\\n <UpperSizeBound>1048576</UpperSizeBound>\\n <StorageClass>All</StorageClass>\\n <TagsCondition>OR_FILTER</TagsCondition>\\n <Tags>tag1#val1;tag2#val2</Tags>\\n </Filter>\\n <IncludedObjectVersions>Current</IncludedObjectVersions>\\n <OptionalFields/>\\n <IncrementalInventory>\\n <IsEnabled>true</IsEnabled>\\n <Schedule>\\n <Frequency>600</Frequency>\\n </Schedule>\\n <OptionalFields>\\n <Field>Etag</Field>\\n </OptionalFields>\\n </IncrementalInventory>\\n</InventoryConfiguration>","type":"xml"}]', + 'title' => 'GetBucketInventory', + 'description' => 'By default, an Alibaba Cloud account has the permission to query the specified inventories of a bucket. If you want to query the specified inventories of a bucket by using a RAM user or STS, you must have the oss:GetBucketInventory permission.', + ], + 'ListBucketInventory' => [ + 'summary' => 'Queries all inventories in a bucket at a time.', + 'path' => '/?inventory', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'continuation-token', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the start position of the list operation. You can obtain this token from the NextContinuationToken field of last ListBucketInventory\'s result.', + 'type' => 'string', + 'required' => false, + 'example' => 'test1.txt ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ListInventoryConfigurationsResult' => [ + 'description' => 'The container that stores inventory configuration list.', + 'type' => 'object', + 'properties' => [ + 'InventoryConfiguration' => [ + 'description' => 'The container that stores inventory configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information of a inventory configuration.', + '$ref' => '#/components/schemas/InventoryConfiguration', + ], + ], + 'IsTruncated' => [ + 'description' => 'Specifies whether to list all inventory tasks configured for the bucket.'."\n" + .'Valid values: true and false'."\n" + .'- The value of false indicates that all inventory tasks configured for the bucket are listed.'."\n" + .'- The value of true indicates that not all inventory tasks configured for the bucket are listed. To list the next page of inventory configurations, set the continuation-token parameter in the next request to the value of the NextContinuationToken header in the response to the current request.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextContinuationToken' => [ + 'description' => 'If the value of IsTruncated in the response is true and value of this header is not null, set the continuation-token parameter in the next request to the value of this header.', + 'type' => 'string', + 'example' => 'DFSadfe**', + ], + ], + ], + ], + 'description' => 'The response body schema.', + ], + ], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListInventoryConfigurationsResult>\\n <InventoryConfiguration>\\n <Id>report1</Id>\\n <IsEnabled>true</IsEnabled>\\n <Destination>\\n <OSSBucketDestination>\\n <AccountId>100000000000000</AccountId>\\n <RoleArn>acs:ram::100000000000000:role/AliyunOSSRole</RoleArn>\\n <Bucket>acs:oss:::bucket_0001</Bucket>\\n <Prefix>prefix1/</Prefix>\\n <Encryption>\\n <SSE-KMS>\\n <KeyId>abcd</KeyId>\\n </SSE-KMS>\\n </Encryption>\\n </OSSBucketDestination>\\n </Destination>\\n <Schedule/>\\n <Filter>\\n <Prefix>Pics/</Prefix>\\n <LastModifyBeginTimeStamp>1637883649</LastModifyBeginTimeStamp>\\n <LastModifyEndTimeStamp>1638347592</LastModifyEndTimeStamp>\\n <LowerSizeBound>1024</LowerSizeBound>\\n <UpperSizeBound>1048576</UpperSizeBound>\\n <StorageClass>All</StorageClass>\\n <TagsCondition>OR_FILTER</TagsCondition>\\n <Tags>tag1#val1;tag2#val2</Tags>\\n </Filter>\\n <IncludedObjectVersions>Current</IncludedObjectVersions>\\n <OptionalFields/>\\n <IncrementalInventory>\\n <IsEnabled>true</IsEnabled>\\n <Schedule>\\n <Frequency>600</Frequency>\\n </Schedule>\\n <OptionalFields>\\n <Field>Etag</Field>\\n </OptionalFields>\\n </IncrementalInventory>\\n </InventoryConfiguration>\\n <IsTruncated>true</IsTruncated>\\n <NextContinuationToken>当响应中的IsTruncated为true且NextContinuationToken非空时，使用该字段作为下一次list请求的continuation-token参数。</NextContinuationToken>\\n</ListInventoryConfigurationsResult>","type":"xml"}]', + 'title' => 'ListBucketInventory', + 'description' => '* You can query up to 100 inventories in a single request. To query more than 100 inventories, you must send multiple requests and use the token returned for each request as the parameter for the next request.'."\n" + .'* To call this operation, make sure that you have the permissions to perform operations on inventories of the bucket. By default, the bucket owner has the required permissions to perform this operation. If you do not have the permissions, apply for the permissions from the bucket owner.'."\n", + ], + 'DeleteBucketInventory' => [ + 'summary' => 'Deletes an inventory for a bucket.', + 'path' => '/?inventory', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '9326', + 'abilityTreeNodes' => [ + 'FEATUREossB6HKQU', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'inventoryId', + 'in' => 'query', + 'schema' => [ + 'title' => 'The ID of the inventory task to delete', + 'description' => 'The name of the inventory that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'list1', + ], + ], + ], + 'responses' => [ + 200 => [], + '4xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketInventory', + 'description' => '* To call this operation, make sure that you have the permissions to perform operations on inventories of the bucket. By default, the bucket owner has the permissions to perform this operation. If you do not have the permissions, apply for the permissions from the bucket owner.'."\n" + .'* If the request is successful, HTTP status code 204 is returned.'."\n", + ], + 'PutBucketLogging' => [ + 'summary' => 'Enables logging for a bucket. After you enable logging for a bucket, Object Storage Service (OSS) generates logs every hour based on the defined naming rule and stores the logs as objects in the specified destination bucket.', + 'path' => '/?logging', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketLoggingStatus' => [ + 'description' => 'The container that stores the logging status information.', + 'required' => false, + '$ref' => '#/components/schemas/BucketLoggingStatus', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketLogging', + 'description' => '* The source bucket for which logs are generated and the destination bucket in which the logs are stored can be the same or different. However, the destination bucket must belong to the same Alibaba Cloud account and reside in the same region as the source bucket.'."\n" + .'* OSS generates log objects on an hourly basis. However, requests received in an hour may be recorded in the log objects generated for the previous or subsequent hour. For more information about the naming conventions of log objects and log format, see [Logging](~~31868~~).'."\n" + .'* Before you disable logging, OSS continuously generates log objects. Delete log objects that you no longer need to reduce your storage costs. You can configure lifecycle rules to periodically delete log objects. For more information, see [Overview](~~31863~~).'."\n" + .'* OSS adds specific fields to the end of logs. We recommend that you consider potential compatibility issues when you develop log processing tools.'."\n", + ], + 'GetBucketLogging' => [ + 'summary' => 'Queries the configurations of access log collection of a bucket. Only the owner of a bucket can query the configurations of access log collection of the bucket.', + 'path' => '/?logging', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9039', + 'abilityTreeNodes' => [ + 'FEATUREossCMVNPH', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BucketLoggingStatus' => [ + 'description' => 'Indicates the container used to store access logging configuration of a bucket.', + 'type' => 'object', + 'properties' => [ + 'LoggingEnabled' => [ + 'description' => 'Indicates the container used to store access logging information. This element is returned if it is enabled and is not returned if it is disabled.', + '$ref' => '#/components/schemas/LoggingEnabled', + ], + ], + 'title' => '保存存储空间日志转存配置的容器', + '$ref' => '#/components/schemas/BucketLoggingStatus', + ], + ], + 'description' => '', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketLoggingStatus>\\n <LoggingEnabled>\\n <TargetBucket>examplebucket</TargetBucket>\\n <TargetPrefix>MyLog-</TargetPrefix>\\n <LoggingRole>AliyunOSSLoggingDefaultRole</LoggingRole>\\n </LoggingEnabled>\\n</BucketLoggingStatus>","type":"xml"}]', + 'title' => 'GetBucketLogging', + ], + 'DeleteBucketLogging' => [ + 'summary' => 'Disables the logging feature for a bucket.', + 'path' => '/?logging', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketLogging', + 'description' => '* Only the bucket owner can disable the logging feature for a bucket.'."\n" + .'* The HTTP status code 204 is returned if the logging feature is disabled for the bucket.'."\n", + ], + 'PutUserDefinedLogFieldsConfig' => [ + 'summary' => 'Customizes the user_defined_log_fields field in real-time logs by adding custom request headers or query parameters to the field for subsequent analysis of requests.', + 'path' => '/?userDefinedLogFieldsConfig', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container that stores the specified log configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserDefinedLogFieldsConfiguration' => [ + 'description' => 'The container for the user-defined logging configuration.', + 'required' => false, + '$ref' => '#/components/schemas/UserDefinedLogFieldsConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutUserDefinedLogFieldsConfig', + ], + 'GetUserDefinedLogFieldsConfig' => [ + 'summary' => 'Queries the custom configurations of the user_defined_log_fields field in the real-time logs of a bucket.', + 'path' => '/?userDefinedLogFieldsConfig', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The container in which the log configurations specified by the user are stored.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserDefinedLogFieldsConfiguration' => [ + 'description' => 'The container for the user-defined logging configuration.', + '$ref' => '#/components/schemas/UserDefinedLogFieldsConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<UserDefinedLogFieldsConfiguration>\\n <HeaderSet>\\n <header>header1</header>\\n </HeaderSet>\\n <ParamSet>\\n <parameter>param1</parameter>\\n </ParamSet>\\n</UserDefinedLogFieldsConfiguration>","type":"xml"}]', + 'title' => 'GetUserDefinedLogFieldsConfig', + ], + 'DeleteUserDefinedLogFieldsConfig' => [ + 'summary' => 'Deletes the custom configurations of the user_defined_log_fields field in the real-time logs of a bucket.', + 'path' => '/?userDefinedLogFieldsConfig', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteUserDefinedLogFieldsConfig', + ], + 'GetBucketWebsite' => [ + 'summary' => 'Queries the static website hosting status and redirection rules configured for a bucket.', + 'path' => '/?website', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9043', + 'abilityTreeNodes' => [ + 'FEATUREossLM29D7', + 'FEATUREossIW6LY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'WebsiteConfiguration' => [ + 'description' => 'The containers of the website configuration.', + 'type' => 'object', + 'properties' => [ + 'IndexDocument' => [ + 'description' => 'The container for the default homepage.', + '$ref' => '#/components/schemas/IndexDocument', + ], + 'ErrorDocument' => [ + 'description' => 'The container used to store the default 404 page.', + '$ref' => '#/components/schemas/ErrorDocument', + ], + 'RoutingRules' => [ + 'description' => 'The container used to store RoutingRule.', + 'type' => 'object', + 'properties' => [ + 'RoutingRule' => [ + 'description' => 'The redirection rule or mirroring-based back-to-origin rule. You can specify a maximum of 20 rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the Routing Rule.', + '$ref' => '#/components/schemas/RoutingRule', + ], + ], + ], + ], + ], + '$ref' => '#/components/schemas/WebsiteConfiguration', + ], + ], + 'description' => 'The response body schema.', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<WebsiteConfiguration>\\n <IndexDocument>\\n <Suffix>index.html</Suffix>\\n <SupportSubDir>true</SupportSubDir>\\n <Type>0</Type>\\n </IndexDocument>\\n <ErrorDocument>\\n <Key>error.html</Key>\\n <HttpStatus>200</HttpStatus>\\n </ErrorDocument>\\n <RoutingRules>\\n <RoutingRule>\\n <RuleNumber>1</RuleNumber>\\n <Condition>\\n <KeyPrefixEquals>abc/</KeyPrefixEquals>\\n <KeySuffixEquals>.txt</KeySuffixEquals>\\n <HttpErrorCodeReturnedEquals>404</HttpErrorCodeReturnedEquals>\\n <IncludeHeader>\\n <Key>test-header</Key>\\n <Equals>test-value</Equals>\\n <StartsWith>test-prefix-</StartsWith>\\n <EndsWith>-test-suffix</EndsWith>\\n </IncludeHeader>\\n </Condition>\\n <Redirect>\\n <RedirectType>Mirror</RedirectType>\\n <PassQueryString>true</PassQueryString>\\n <MirrorURL>http://example.com/</MirrorURL>\\n <MirrorSNI>true</MirrorSNI>\\n <MirrorPassQueryString>true</MirrorPassQueryString>\\n <MirrorFollowRedirect>true</MirrorFollowRedirect>\\n <MirrorCheckMd5>false</MirrorCheckMd5>\\n <MirrorHeaders>\\n <PassAll>false</PassAll>\\n <Pass>pass-header</Pass>\\n <Remove>remove-header</Remove>\\n <Set>\\n <Key>set-header</Key>\\n <Value>set-value</Value>\\n </Set>\\n </MirrorHeaders>\\n <Protocol>https</Protocol>\\n <HostName>example.com</HostName>\\n <ReplaceKeyPrefixWith>def/</ReplaceKeyPrefixWith>\\n <EnableReplacePrefix>true</EnableReplacePrefix>\\n <ReplaceKeyWith>prefix/${key}.suffix</ReplaceKeyWith>\\n <HttpRedirectCode>302</HttpRedirectCode>\\n <MirrorPassOriginalSlashes>false</MirrorPassOriginalSlashes>\\n <MirrorURLSlave>https://example.com</MirrorURLSlave>\\n <MirrorURLProbe>https://example.com/hartbeat</MirrorURLProbe>\\n <MirrorSaveOssMeta>true</MirrorSaveOssMeta>\\n <MirrorProxyPass>false</MirrorProxyPass>\\n <MirrorAllowGetImageInfo>true</MirrorAllowGetImageInfo>\\n <MirrorAllowVideoSnapshot>false</MirrorAllowVideoSnapshot>\\n <MirrorIsExpressTunnel>true</MirrorIsExpressTunnel>\\n <MirrorDstRegion>cn-hangzhou</MirrorDstRegion>\\n <MirrorDstVpcId>vpc-test-id</MirrorDstVpcId>\\n <MirrorDstSlaveVpcId>vpc-test-id</MirrorDstSlaveVpcId>\\n <MirrorUserLastModified>false</MirrorUserLastModified>\\n <MirrorSwitchAllErrors>false</MirrorSwitchAllErrors>\\n <MirrorTunnelId>test-tunnel-id</MirrorTunnelId>\\n <MirrorUsingRole>false</MirrorUsingRole>\\n <MirrorRole>aliyun-test-role</MirrorRole>\\n <MirrorAllowHeadObject>true</MirrorAllowHeadObject>\\n <TransparentMirrorResponseCodes>false</TransparentMirrorResponseCodes>\\n <MirrorAsyncStatus>303</MirrorAsyncStatus>\\n <MirrorTaggings>\\n <Taggings>\\n <Key>test-tagging</Key>\\n <Value>test-value</Value>\\n </Taggings>\\n </MirrorTaggings>\\n <MirrorReturnHeaders>\\n <ReturnHeader>\\n <Key>test-header</Key>\\n <Value>test-value</Value>\\n </ReturnHeader>\\n </MirrorReturnHeaders>\\n <MirrorAuth>\\n <AuthType>S3V4</AuthType>\\n <Region>ap-southeast-1</Region>\\n <AccessKeyId>TESTAK</AccessKeyId>\\n <AccessKeySecret>TESTSK</AccessKeySecret>\\n </MirrorAuth>\\n <MirrorMultiAlternates>\\n <MirrorMultiAlternate>\\n <MirrorMultiAlternateNumber>32</MirrorMultiAlternateNumber>\\n <MirrorMultiAlternateURL>https://test-multi-alter.example.com</MirrorMultiAlternateURL>\\n <MirrorMultiAlternateVpcId>vpc-test-id</MirrorMultiAlternateVpcId>\\n <MirrorMultiAlternateDstRegion>ap-southeast-1</MirrorMultiAlternateDstRegion>\\n </MirrorMultiAlternate>\\n </MirrorMultiAlternates>\\n </Redirect>\\n <LuaConfig>\\n <Script>test.lua</Script>\\n </LuaConfig>\\n </RoutingRule>\\n </RoutingRules>\\n</WebsiteConfiguration>","type":"xml"}]', + 'title' => 'GetBucketWebsite', + 'description' => 'Queries the static website hosting status and redirection rules configured for a bucket.', + ], + 'PutBucketWebsite' => [ + 'summary' => 'Enables the static website hosting mode for a bucket and configures redirection rules for the bucket.', + 'path' => '/?website', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '9071', + 'abilityTreeNodes' => [ + 'FEATUREossLM29D7', + 'FEATUREossIW6LY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'WebsiteConfiguration' => [ + 'description' => 'The container that stores the website configuration.', + 'required' => false, + '$ref' => '#/components/schemas/WebsiteConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketWebsite', + 'description' => '* You can call this operation to configure the default home page, default 404 page, and redirection rules. You can specify redirection rules for HTTP 3xx status code or mirroring-based back-to-origin by using RoutingRule. Mirroring-based back-to-origin supports the Alibaba Cloud public cloud and Finance Cloud.'."\n" + .'* To use a custom domain name to access bucket-based static websites, you can use CNAMEs. For more information, see Map custom domain names.'."\n" + .'* If you specify an index page or error page when you enable the static website hosting mode for a bucket, the specified index page or error page must be an object in the bucket.'."\n" + .'* After you enable the static website hosting mode for a bucket, Object Storage Service (OSS) returns the index page for anonymous access to the root domain name of the static website. If a signed request is sent to access the root domain name of the static website, OSS returns the result of the GetBucket (ListObjects) operation.', + ], + 'DeleteBucketWebsite' => [ + 'summary' => 'Disables the static website hosting mode and deletes the redirection rules for a bucket.', + 'path' => '/?website', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '9027', + 'abilityTreeNodes' => [ + 'FEATUREossLM29D7', + 'FEATUREossIW6LY5', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketWebsite', + 'description' => 'Only the owner of a bucket can disable the static website hosting mode for the bucket.'."\n", + ], + 'PutBucketReferer' => [ + 'summary' => 'Configures a Referer whitelist for an Object Storage Service (OSS) bucket. You can specify whether to allow the requests whose Referer field is empty or whose query strings are truncated.', + 'path' => '/?referer', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'RefererConfiguration' => [ + 'description' => 'The container that stores the hotlink protection configurations.', + 'required' => false, + '$ref' => '#/components/schemas/RefererConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketReferer', + ], + 'GetBucketReferer' => [ + 'summary' => 'Queries the hotlink protection configurations for a bucket.', + 'path' => '/?referer', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'RefererConfiguration' => [ + '$ref' => '#/components/schemas/RefererConfiguration', + 'description' => 'The container that stores the hotlink protection configurations.', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<RefererConfiguration>\\n <AllowEmptyReferer>true</AllowEmptyReferer>\\n <AllowTruncateQueryString>false</AllowTruncateQueryString>\\n <TruncatePath>false</TruncatePath>\\n <RefererList>\\n <Referer>https://www.aliyun.com</Referer>\\n </RefererList>\\n <RefererBlacklist>\\n <Referer>https://www.abc.com</Referer>\\n </RefererBlacklist>\\n</RefererConfiguration>","type":"xml"}]', + 'title' => 'GetBucketReferer', + ], + 'PutBucketTags' => [ + 'summary' => 'Adds tags to or modifies the existing tags of a bucket.', + 'path' => '/?tagging', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'Tagging' => [ + 'description' => 'The container used to store TagSet.', + 'required' => false, + '$ref' => '#/components/schemas/Tagging', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketTags', + 'description' => '* Only the bucket owner and authorized Resource Access Management (RAM) users can configure tags for the bucket. If other users attempt to configure tags for the bucket, Object Storage Service (OSS) returns the HTTP status code 403 and the error code AccessDenied.'."\n" + .'* A tag is a key-value pair. You can add up to 20 tags to a bucket.'."\n" + .'* If you call the PutBucketTags operation to add a tag to a bucket to which an existing tag of the same key is already added, the existing tag is overwritten.'."\n", + ], + 'GetBucketTags' => [ + 'summary' => 'Queries the tags of a bucket.', + 'path' => '/?tagging', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Tagging' => [ + 'description' => 'The container that stores the returned tags of the bucket.'."\n" + .'> If no tags are configured for the bucket, an XML message body is returned in which the Tagging element is empty.', + 'type' => 'object', + 'properties' => [ + 'TagSet' => [ + 'description' => 'The container that stores the returned tags of the bucket.', + '$ref' => '#/components/schemas/TagSet', + ], + ], + ], + ], + 'description' => 'The container that stores the returned tags of the bucket.', + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<Tagging>\\n <TagSet>\\n <Tag>\\n <Key/>\\n <Value/>\\n </Tag>\\n </TagSet>\\n</Tagging>","type":"xml"}]', + 'title' => 'GetBucketTags', + ], + 'DeleteBucketTags' => [ + 'summary' => 'Deletes tags configured for a bucket.', + 'path' => '/?tagging', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketTags', + 'description' => 'If no tag is configured for the bucket or the tags that you want to delete do not exist, the HTTP status code 204 is returned.'."\n", + ], + 'ListUserDataRedundancyTransition' => [ + 'summary' => 'List all storage redundancy conversion tasks of the requester', + 'path' => '/?redundancyTransition', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207254', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'continuation-token', + 'in' => 'query', + 'schema' => [ + 'title' => '指定List操作需要从此token开始。', + 'description' => 'Specifies that the List operation should start from this token.', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'title' => '限定此次返回任务的最大个数。取值范围：1-100。', + 'description' => 'Limits the maximum number of tasks returned in this request. Value range: 1-100.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '保存接口响应内容的容器。', + 'description' => 'Container for storing the response content of the interface.', + 'type' => 'object', + 'properties' => [ + 'ListBucketDataRedundancyTransition' => [ + 'title' => '列举存储冗余转换任务的容器。', + 'description' => 'Container for listing storage redundancy transition tasks.', + 'type' => 'object', + 'properties' => [ + 'IsTruncated' => [ + 'title' => '请求中返回的结果是否被截断。取值如下：'."\n" + ."\n" + .'true：表示本次未返回全部结果。'."\n" + ."\n" + .'false：表示本次已返回全部结果。', + 'description' => 'Indicates whether the results in the request are truncated. The values are as follows:'."\n" + ."\n" + .'true: Indicates that not all results are returned in this request.'."\n" + ."\n" + .'false: Indicates that all results are returned in this request.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextContinuationToken' => [ + 'title' => '表明本次ListUserDataRedundancyTransition请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', + 'description' => 'Indicates that the current ListUserDataRedundancyTransition request contains subsequent results, and you need to specify NextContinuationToken as continuation-token to continue retrieving the results.', + 'type' => 'string', + 'example' => 'def', + ], + 'BucketDataRedundancyTransition' => [ + 'title' => '存储冗余转换任务的容器。', + 'description' => 'Container for storage redundancy transition tasks.', + 'type' => 'array', + 'items' => [ + 'title' => '存储冗余转换任务的结构信息。', + 'description' => 'Structure information of the storage redundancy transition task.', + '$ref' => '#/components/schemas/BucketDataRedundancyTransition', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListBucketDataRedundancyTransition>\\n <IsTruncated>true</IsTruncated>\\n <NextContinuationToken>def</NextContinuationToken>\\n <BucketDataRedundancyTransition>\\n <Bucket>example-bucket</Bucket>\\n <TaskId>751f5243f8ac4ae89f34726534d1****</TaskId>\\n <Status>Queueing</Status>\\n <CreateTime>2023-11-17T09:14:39.000Z</CreateTime>\\n <StartTime>2023-11-17T09:14:39.000Z</StartTime>\\n <EndTime>2023-11-17T09:14:39.000Z</EndTime>\\n <ProcessPercentage>88</ProcessPercentage>\\n <EstimatedRemainingTime>10</EstimatedRemainingTime>\\n </BucketDataRedundancyTransition>\\n</ListBucketDataRedundancyTransition>","type":"xml"}]', + 'title' => 'List User-Level Storage Redundancy Type Transition Tasks', + 'translator' => 'machine', + ], + 'ListBucketDataRedundancyTransition' => [ + 'summary' => 'List Storage Redundancy Conversion Tasks for a User', + 'path' => '/?redundancyTransition', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '207262', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The redundancy type conversion tasks performed on the bucket.'."\n", + 'type' => 'object', + 'properties' => [ + 'ListBucketDataRedundancyTransition' => [ + 'description' => 'The container for listed redundancy type conversion tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'BucketDataRedundancyTransition' => [ + 'description' => 'The information about the redundancy type conversion task.'."\n", + '$ref' => '#/components/schemas/BucketDataRedundancyTransition', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListBucketDataRedundancyTransition>\\n <BucketDataRedundancyTransition>\\n <Bucket>example-bucket</Bucket>\\n <TaskId>751f5243f8ac4ae89f34726534d1****</TaskId>\\n <Status>Queueing</Status>\\n <CreateTime>2023-11-17T09:14:39.000Z</CreateTime>\\n <StartTime>2023-11-17T09:14:39.000Z</StartTime>\\n <EndTime>2023-11-17T09:14:39.000Z</EndTime>\\n <ProcessPercentage>88</ProcessPercentage>\\n <EstimatedRemainingTime>10</EstimatedRemainingTime>\\n </BucketDataRedundancyTransition>\\n</ListBucketDataRedundancyTransition>","type":"xml"}]', + 'title' => 'ListBucketDataRedundancyTransition', + 'description' => '- To list all storage redundancy conversion tasks under a Bucket, you must have the `oss:ListBucketDataRedundancyTransition` permission. For more details, see [Grant Custom Permission Policies to RAM Users](~~199058~~).'."\n" + .'- Each region has a corresponding access domain (Endpoint). For more information on the relationship between regions and access domains, see [Access Domains and Data Centers](~~31837~~).', + 'translator' => 'machine', + ], + 'GetBucketDataRedundancyTransition' => [ + 'summary' => 'Queries the redundancy type conversion tasks of a bucket.', + 'path' => '/?redundancyTransition', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207237', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-redundancy-transition-taskid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the redundancy change task.', + 'type' => 'string', + 'required' => true, + 'example' => '751f5243f8ac4ae89f34726534d1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'BucketDataRedundancyTransition' => [ + 'description' => 'The container for a specific redundancy type change task.', + '$ref' => '#/components/schemas/BucketDataRedundancyTransition', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketDataRedundancyTransition>\\n <Bucket>example-bucket</Bucket>\\n <TaskId>751f5243f8ac4ae89f34726534d1****</TaskId>\\n <Status>Queueing</Status>\\n <CreateTime>2023-11-17T09:14:39.000Z</CreateTime>\\n <StartTime>2023-11-17T09:14:39.000Z</StartTime>\\n <EndTime>2023-11-17T09:14:39.000Z</EndTime>\\n <ProcessPercentage>88</ProcessPercentage>\\n <EstimatedRemainingTime>10</EstimatedRemainingTime>\\n</BucketDataRedundancyTransition>","type":"xml"}]', + 'title' => 'GetBucketDataRedundancyTransition', + ], + 'CreateBucketDataRedundancyTransition' => [ + 'summary' => 'Creates a redundancy type conversion task for a bucket.', + 'path' => '/?redundancyTransition', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '207235', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-target-redundancy-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The redundancy type to which you want to convert the bucket. You can only convert the redundancy type of a bucket from LRS to ZRS.', + 'type' => 'string', + 'required' => true, + 'example' => 'ZRS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BucketDataRedundancyTransition' => [ + 'description' => 'The container in which the redundancy type conversion task is stored.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the redundancy type conversion task. The ID can be used to view and delete the redundancy type conversion task.', + 'type' => 'string', + 'example' => ' '."\n" + .'4be5beb0f74f490186311b268bf6****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketDataRedundancyTransition>\\n <TaskId>\\t\\n4be5beb0f74f490186311b268bf6****</TaskId>\\n</BucketDataRedundancyTransition>","type":"xml"}]', + 'title' => 'CreateBucketDataRedundancyTransition', + ], + 'DeleteBucketDataRedundancyTransition' => [ + 'summary' => 'Deletes a redundancy type conversion task of a bucket.', + 'path' => '/?redundancyTransition', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207246', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-redundancy-transition-taskid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the redundancy type change task.', + 'type' => 'string', + 'required' => true, + 'example' => '4be5beb0f74f490186311b268bf6****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketDataRedundancyTransition', + ], + 'PutBucketEncryption' => [ + 'path' => '/?encryption', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'ServerSideEncryptionRule' => [ + 'description' => 'The container that stores server-side encryption rules.', + 'required' => false, + '$ref' => '#/components/schemas/ServerSideEncryptionRule', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketEncryption', + 'summary' => 'Configures encryption rules for a bucket.', + 'description' => 'Only the bucket owner and authorized Resource Access Management (RAM) users can configure encryption rules for a bucket. Otherwise, Object Storage Service (OSS) returns the HTTP status code 403. For more information about bucket encryption, see [Server-side encryption](~~31871~~).'."\n", + ], + 'GetBucketEncryption' => [ + 'summary' => 'Queries the encryption rules configured for a bucket.', + 'path' => '/?encryption', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'ServerSideEncryptionRule' => [ + 'description' => 'The container that stores server-side encryption rules.', + 'type' => 'object', + 'properties' => [ + 'ApplyServerSideEncryptionByDefault' => [ + 'description' => 'The container that stores the default server-side encryption method.', + '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ServerSideEncryptionRule>\\n <ApplyServerSideEncryptionByDefault>\\n <SSEAlgorithm/>\\n <KMSMasterKeyID/>\\n <KMSDataEncryption/>\\n </ApplyServerSideEncryptionByDefault>\\n</ServerSideEncryptionRule>","type":"xml"}]', + 'title' => 'GetBucketEncryption', + 'description' => 'Only the bucket owner or authorized Resource Access Management (RAM) users can query the encryption rules configured for a bucket. If other users try to query the encryption rules configured for the bucket, the HTTP status code 403 is returned. For more information about bucket encryption, see [Server-side encryption](~~31871~~).'."\n", + ], + 'DeleteBucketEncryption' => [ + 'summary' => 'Deletes encryption rules for a bucket.', + 'path' => '/?encryption', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketEncryption', + 'description' => 'Only the bucket owner and authorized Resource Access Management (RAM) users can delete encryption rules for a bucket. Otherwise, Object Storage Service (OSS) returns the HTTP 403 status code. For more information about bucket encryption, see [Server-side encryption](~~31871~~).'."\n", + ], + 'PutBucketRequestPayment' => [ + 'summary' => 'Enables pay-by-requester for a bucket.', + 'path' => '/?requestPayment', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'RequestPaymentConfiguration' => [ + 'description' => 'The container that stores pay-by-requester configurations.', + 'required' => false, + '$ref' => '#/components/schemas/RequestPaymentConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketRequestPayment', + 'description' => '* If you enable pay-by-requester for a bucket, anonymous users cannot access the bucket. Requesters must provide authentication information. Object Storage Service (OSS) can identify requesters based on the given information. This way, the requesters are charged for the requests and the generated traffic. If a requester assumes a Resource Access Management (RAM) role to request data, the Alibaba Cloud account to which the RAM role belongs is charged for the requests sent by the requester and the generated traffic.'."\n" + .'* If you enable pay-by-requester for a bucket, requesters must specify the x-oss-request-payer:requester header in the POST, GET, or HEAD requests. This header indicates that requesters understand that they are charged for the requests and downloading data. Otherwise, the requests cannot be authenticated. The bucket owner does not need to specify the x-oss-request-payer header in requests that are sent to access the bucket. When the bucket owner accesses the bucket as a requester, the bucket owner is charged for the requests and the generated traffic.'."\n", + ], + 'GetBucketRequestPayment' => [ + 'summary' => 'Queries pay-by-requester configurations for a bucket.', + 'path' => '/?requestPayment', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'RequestPaymentConfiguration' => [ + 'description' => 'Indicates the container for the payer.', + 'type' => 'object', + 'properties' => [ + 'Payer' => [ + 'description' => 'Indicates who pays the download and request fees.', + 'type' => 'string', + 'enumValueTitles' => [ + 'Requester' => 'Requester', + 'BucketOwner' => 'BucketOwner', + ], + 'example' => 'Requester', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<RequestPaymentConfiguration>\\n <Payer>Requester</Payer>\\n</RequestPaymentConfiguration>","type":"xml"}]', + 'title' => 'GetBucketRequestPayment', + ], + 'PutBucketCors' => [ + 'summary' => 'Configures cross-origin resource sharing (CORS) rules for a bucket.', + 'path' => '/?cors', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'CORSConfiguration' => [ + 'description' => 'The container that stores CORS rules.'."\n" + ."\n" + .'You can configure up to 10 CORS rules for a bucket. The XML message body in a request can be up to 16 KB in size.', + 'required' => false, + '$ref' => '#/components/schemas/CORSConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","errorExample":""}]', + 'title' => 'PutBucketCors', + 'description' => '* Disabled-by-default design\\'."\n" + .' By default, CORS is disabled for a bucket. All cross-origin requests are not allowed.'."\n" + ."\n" + .'* Overwriting semantics\\'."\n" + .' If you call the PutBucketCors operation to configure a new CORS rule for a bucket for which a CORS rule is already configured, the existing rule is overwritten.'."\n" + ."\n" + .'* Use of CORS in applications\\'."\n" + .' Before you can use CORS in applications, you must call the PutBucketCors operation to configure a CORS rule to enable CORS.\\'."\n" + .' For example, you must call the PutBucketCors operation to configure a CORS rule to access Object Storage Service (OSS) applications from `example.com` by using the `XMLHttpRequest` feature of the browser. You must configure the CORS rule in the XML format.'."\n" + ."\n" + .'* CORS rule matching\\'."\n" + .' When OSS receives a cross-region request or an OPTIONS request, OSS reads the CORS rules configured for the corresponding bucket and performs permission checks. OSS checks the rules in turn. If OSS finds the first match, the corresponding header fields are returned in the response. If the request fails to match the CORS rules, the CORS-related header fields are not returned in the response.\\'."\n" + .' OSS considers that a cross-origin request or an OPTIONS request matches a CORS rule only when the request meets the following conditions:'."\n" + ."\n" + .' * The origin from which the cross-origin request is sent matches one of the values of `AllowedOrigin` in the CORS rule.'."\n" + .' * The method of the cross-origin request such as GET or PUT or the method that corresponds to `Access-Control-Request-Method` in the OPTIONS request matches one of the values of `AllowedMethod` in the CORS rule.'."\n" + .' * Each header that is included in `Access-Control-Request-Headers` in the OPTIONS request matches one of the values of `AllowedHeader` in the CORS rule.'."\n", + ], + 'GetBucketCors' => [ + 'summary' => 'Queries the cross-origin resource sharing (CORS) rules that are configured for a bucket.', + 'path' => '/?cors', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CORSConfiguration' => [ + 'description' => 'The container that stores CORS configuration.', + 'type' => 'object', + 'properties' => [ + 'CORSRule' => [ + 'description' => 'The container that stores CORS rules. Up to 10 rules can be configured for a bucket.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detail of a specific CORS rule.', + '$ref' => '#/components/schemas/CORSRule', + ], + ], + 'ResponseVary' => [ + 'description' => 'Indicates whether the Vary: Origin header was returned. Default value: false.'."\n" + .'- true: The Vary: Origin header is returned regardless whether the request is a cross-origin request or whether the cross-origin request succeeds.'."\n" + .'- false: The Vary: Origin header is not returned.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'description' => 'The request body schema.', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CORSConfiguration>\\n <CORSRule>\\n <AllowedOrigin>*</AllowedOrigin>\\n <AllowedMethod>GET</AllowedMethod>\\n <AllowedHeader>x-oss-*</AllowedHeader>\\n <ExposeHeader>Expires</ExposeHeader>\\n <MaxAgeSeconds>300</MaxAgeSeconds>\\n </CORSRule>\\n <ResponseVary>true</ResponseVary>\\n</CORSConfiguration>","type":"xml"}]', + 'title' => 'GetBucketCors', + 'description' => ' ', + ], + 'DeleteBucketCors' => [ + 'summary' => 'Disables the cross-origin resource sharing (CORS) feature and deletes all CORS rules for a bucket.', + 'path' => '/?cors', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketCors', + 'description' => '### [](#)Precautions'."\n" + ."\n" + .'To disable the CORS feature, you must have the `oss:DeleteBucketCors` permission.'."\n", + ], + 'OptionObject' => [ + 'summary' => 'Determines whether to send a cross-origin request. Before a cross-origin request is sent, the browser sends a preflight OPTIONS request that includes a specific origin, HTTP method, and header information to Object Storage Service (OSS) to determine whether to send the cross-origin request.', + 'path' => '/{key}', + 'methods' => [ + 'options', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'Origin', + 'in' => 'header', + 'schema' => [ + 'description' => 'The origin of the request. It is used to identify a cross-origin request. You can specify only one Origin header in a cross-origin request. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.example.com', + ], + ], + [ + 'name' => 'Access-Control-Request-Method', + 'in' => 'header', + 'schema' => [ + 'description' => 'The method to be used in the actual cross-origin request. You can specify only one Access-Control-Request-Method header in a cross-origin request. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUT', + ], + ], + [ + 'name' => 'Access-Control-Request-Headers', + 'in' => 'header', + 'schema' => [ + 'description' => 'The custom headers to be sent in the actual cross-origin request. You can configure multiple custom headers in a cross-origin request. Custom headers are separated by commas (,). By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x-oss-test1,x-oss-test2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Access-Control-Allow-Origin' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Access-Control-Allow-Methods' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Access-Control-Allow-Headers' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Access-Control-Expose-Headers' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Access-Control-Max-Age' => [ + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'OptionObject', + 'description' => 'The browser automatically determines whether to send the preflight request based on whether the actual request is a cross-origin request.'."\n", + ], + 'PutBucketAccessMonitor' => [ + 'summary' => 'Modifies the access tracking status of a bucket.', + 'path' => '/?accessmonitor', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'AccessMonitorConfiguration' => [ + 'description' => 'The access tracking configurations of the bucket.', + 'required' => false, + '$ref' => '#/components/schemas/AccessMonitorConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketAccessMonitor', + 'description' => 'To enable or disable access tracking for a bucket, you must have the oss:PutBucketAccessMonitor permission. For more information, see Attach a custom policy to a RAM user.', + ], + 'GetBucketAccessMonitor' => [ + 'summary' => 'Queries the access tracking status of a bucket.', + 'path' => '/?accessmonitor', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '169396', + 'abilityTreeNodes' => [ + 'FEATUREoss20S3WM', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + 'title' => '存储空间名称', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '请求响应体结构', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AccessMonitorConfiguration' => [ + 'description' => 'The container that stores access monitor configuration.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The access tracking status of the bucket. Valid values:'."\n" + ."\n" + .'- Enabled: Access tracking is enabled.'."\n" + ."\n" + .'- Disabled: Access tracking is disabled.', + '$ref' => '#/components/schemas/AccessMonitorStatus', + ], + ], + '$ref' => '#/components/schemas/AccessMonitorConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<AccessMonitorConfiguration>\\n <AllowCopy>true</AllowCopy>\\n</AccessMonitorConfiguration>","type":"xml"}]', + 'title' => 'GetBucketAccessMonitor', + ], + 'GetMetaQueryStatus' => [ + 'summary' => 'Queries the information about the metadata index library of a bucket.', + 'path' => '/?metaQuery', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'MetaQueryStatus' => [ + 'description' => 'The container that stores the metadata information.', + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => 'The status of the metadata index library. Valid values:'."\n" + .'- Ready: The metadata index library is being prepared after it is created.'."\n" + .'In this case, the metadata index library cannot be used to query data.'."\n" + ."\n" + .'- Stop: The metadata index library is paused.'."\n" + .'- Running: The metadata index library is running.'."\n" + .'- Retrying: The metadata index library failed to be created and is being created again.'."\n" + .'- Failed: The metadata index library failed to be created.'."\n" + .'- Deleted: The metadata index library is deleted.', + 'type' => 'string', + 'example' => 'Runing', + ], + 'Phase' => [ + 'description' => 'The scan type. Valid values:'."\n" + .'- FullScanning: Full scanning is in progress.'."\n" + .'- IncrementalScanning: Incremental scanning is in progress.', + 'type' => 'string', + 'example' => 'FullScanning', + ], + 'CreateTime' => [ + 'description' => 'The time when the metadata index library was created. The value follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the year, month, and day. T indicates the beginning of the time element. HH:mm:ss indicates the hour, minute, and second. TIMEZONE indicates the time zone.', + 'type' => 'string', + 'example' => '2021-08-02T10:49:17.289372919+08:00', + ], + 'UpdateTime' => [ + 'description' => 'The time when the metadata index library was updated. The value follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the year, month, and day. T indicates the beginning of the time element. HH:mm:ss indicates the hour, minute, and second. TIMEZONE indicates the time zone.', + 'type' => 'string', + 'example' => '2021-08-02T10:49:17.289372919+08:00', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<MetaQueryStatus>\\n <State>Runing</State>\\n <Phase>FullScanning</Phase>\\n <CreateTime>2021-08-02T10:49:17.289372919+08:00</CreateTime>\\n <UpdateTime>2021-08-02T10:49:17.289372919+08:00</UpdateTime>\\n</MetaQueryStatus>","type":"xml"}]', + 'title' => 'GetMetaQueryStatus', + ], + 'CloseMetaQuery' => [ + 'summary' => 'Disables the metadata management feature for an Object Storage Service (OSS) bucket. After the metadata management feature is disabled for a bucket, OSS automatically deletes the metadata index library of the bucket and you cannot perform metadata indexing.', + 'path' => '/?metaQuery&comp=delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CloseMetaQuery', + ], + 'DoMetaQuery' => [ + 'summary' => 'Queries the objects in a bucket that meet the specified conditions by using the data indexing feature. The information about the objects is listed based on the specified fields and sorting methods.', + 'path' => '/?metaQuery&comp=query', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169403', + 'abilityTreeNodes' => [ + 'FEATUREossNCEJ8M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + 'title' => '存储空间名称', + ], + ], + [ + 'name' => 'mode', + 'in' => 'query', + 'schema' => [ + 'title' => '指定检索模式。'."\n" + .'- basic：标量检索（默认）'."\n" + .'- semantic：向量检索', + 'type' => 'string', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'MetaQuery' => [ + 'description' => 'The containerfor query conditions.', + 'required' => false, + '$ref' => '#/components/schemas/MetaQuery', + 'title' => '数据索引查询参数', + ], + ], + 'required' => false, + 'title' => '接口请求体结构', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口响应体结构', + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'MetaQuery' => [ + 'description' => 'The container for the query result.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token that is used for the next query when the total number of objects exceeds the value of MaxResults.'."\n" + .'The value of NextToken is used to return the unreturned results in the next query.'."\n" + ."\n" + .'This parameter has a value only when not all objects are returned.', + 'type' => 'string', + 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', + ], + 'Files' => [ + 'description' => 'The container for the information about objects.', + 'type' => 'object', + 'properties' => [ + 'File' => [ + 'description' => 'The list of file information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container for the information about a single object.', + '$ref' => '#/components/schemas/MetaQueryFile', + ], + ], + ], + ], + ], + '$ref' => '#/components/schemas/MetaQueryResp', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<MetaQuery>\\n <NextToken>MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****</NextToken>\\n <Files>\\n <File>\\n <Filename>exampleobject.txt</Filename>\\n <Size>120</Size>\\n <FileModifiedTime>2021-06-29T15:04:05.000000000Z07:00</FileModifiedTime>\\n <OSSObjectType>Normal</OSSObjectType>\\n <OSSStorageClass>Standard</OSSStorageClass>\\n <ObjectACL>default</ObjectACL>\\n <ETag>\\"fba9dede5f27731c9771645a3986****\\"</ETag>\\n <OSSCRC64>4858A48BD1466884</OSSCRC64>\\n <ServerSideEncryption>AES256</ServerSideEncryption>\\n <ServerSideEncryptionCustomerAlgorithm>SM4</ServerSideEncryptionCustomerAlgorithm>\\n <OSSTaggingCount>2</OSSTaggingCount>\\n <OSSTagging>\\n <Tagging>\\n <Key/>\\n <Value/>\\n </Tagging>\\n </OSSTagging>\\n <OSSUserMeta>\\n <UserMeta>\\n <Key/>\\n <Value/>\\n </UserMeta>\\n </OSSUserMeta>\\n <URI>oss://examplebucket/test-object.jpg</URI>\\n <ProduceTime>2021-06-29T14:50:13.011643661+08:00</ProduceTime>\\n <ContentType>image/jpeg</ContentType>\\n <MediaType>image</MediaType>\\n <LatLong>30.134390,120.074997</LatLong>\\n <Title>test</Title>\\n <OSSExpiration>2124-12-01T12:00:00.000Z</OSSExpiration>\\n <AccessControlAllowOrigin>https://aliyundoc.com</AccessControlAllowOrigin>\\n <AccessControlRequestMethod>PUT</AccessControlRequestMethod>\\n <ServerSideDataEncryption>SM4</ServerSideDataEncryption>\\n <ServerSideEncryptionKeyId>9468da86-3509-4f8d-a61e-6eab1eac****</ServerSideEncryptionKeyId>\\n <CacheControl>no-cache</CacheControl>\\n <ContentDisposition>attachment; filename =test.jpg</ContentDisposition>\\n <ContentEncoding>UTF-8</ContentEncoding>\\n <ContentLanguage>zh-CN</ContentLanguage>\\n <ImageHeight>500</ImageHeight>\\n <ImageWidth>270</ImageWidth>\\n <VideoWidth>1080</VideoWidth>\\n <VideoHeight>1920</VideoHeight>\\n <Bitrate>13091201</Bitrate>\\n <Artist>Jane</Artist>\\n <AlbumArtist>Jenny</AlbumArtist>\\n <Composer>Jane</Composer>\\n <Performer>Jane</Performer>\\n <Album>FirstAlbum</Album>\\n <Duration>15.263</Duration>\\n <VideoStreams>\\n <VideoStream>\\n <CodecName>h264</CodecName>\\n <Language>en</Language>\\n <Bitrate>5407765</Bitrate>\\n <FrameRate>25/1</FrameRate>\\n <StartTime>0</StartTime>\\n <Duration>22.88</Duration>\\n <FrameCount>572</FrameCount>\\n <BitDepth>8</BitDepth>\\n <PixelFormat>yuv420p</PixelFormat>\\n <ColorSpace>bt709</ColorSpace>\\n <Height>720</Height>\\n <Width>1280</Width>\\n </VideoStream>\\n </VideoStreams>\\n <AudioStreams>\\n <AudioStream>\\n <CodecName>aac</CodecName>\\n <Bitrate>320087</Bitrate>\\n <SampleRate>48000</SampleRate>\\n <StartTime>0.0235</StartTime>\\n <Duration>3.690667</Duration>\\n <Channels>2</Channels>\\n <Language>en</Language>\\n </AudioStream>\\n </AudioStreams>\\n <Subtitles>\\n <Subtitle>\\n <CodecName>mov_text</CodecName>\\n <Language>en</Language>\\n <StartTime>0</StartTime>\\n <Duration>71.378</Duration>\\n </Subtitle>\\n </Subtitles>\\n <Addresses>\\n <Address>\\n <AddressLine>中国浙江省杭州市余杭区文一西路969号</AddressLine>\\n <City>杭州市</City>\\n <District>余杭区</District>\\n <Language>zh-Hans</Language>\\n <Province>浙江省</Province>\\n <Township>文一西路</Township>\\n </Address>\\n </Addresses>\\n <Insights>\\n <Video>\\n <Caption>手拿洗发水</Caption>\\n <Description>视频中展示了两个不同场景：一个是静止的白色盘子、黑色瓶子和透明玻璃杯，另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移</Description>\\n </Video>\\n <Image>\\n <Caption>站着一个人</Caption>\\n <Description>图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色</Description>\\n </Image>\\n </Insights>\\n </File>\\n </Files>\\n <Aggregations>\\n <Aggregation>\\n <Field>Size</Field>\\n <Operation>sum</Operation>\\n <Value>200</Value>\\n <Groups>\\n <Group>\\n <Value>100</Value>\\n <Count>5</Count>\\n </Group>\\n </Groups>\\n </Aggregation>\\n </Aggregations>\\n</MetaQuery>","type":"xml"}]', + 'title' => 'DoMetaQuery', + ], + 'OpenMetaQuery' => [ + 'summary' => 'Enables metadata management for a bucket. After you enable the metadata management feature for a bucket, Object Storage Service (OSS) creates a metadata index library for the bucket and creates metadata indexes for all objects in the bucket. After the metadata index library is created, OSS continues to perform quasi-real-time scans on incremental objects in the bucket and creates metadata indexes for the incremental objects.', + 'path' => '/?metaQuery&comp=add', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '169400', + 'abilityTreeNodes' => [ + 'FEATUREossNCEJ8M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + 'title' => '存储空间名称', + ], + ], + [ + 'name' => 'mode', + 'in' => 'query', + 'schema' => [ + 'title' => '检索模式。取值如下：'."\n" + ."\n" + .'basic（默认值）：标量检索'."\n" + ."\n" + .'semantic：向量检索', + 'type' => 'string', + ], + ], + [ + 'name' => 'role', + 'in' => 'query', + 'schema' => [ + 'title' => '指定用于访问 OSS 服务的 RAM 角色名称，支持在控制台为角色授予权限，实现安全访问。', + 'type' => 'string', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体参数', + 'type' => 'object', + 'properties' => [ + 'MetaQuery' => [ + 'title' => '保存为Bucket开启元数据管理功能的请求体参数', + '$ref' => '#/components/schemas/MetaQueryOpenRequest', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'OpenMetaQuery', + ], + 'UpdateUserAntiDDosInfo' => [ + 'summary' => 'Modifies the status of an Anti-DDoS instance.', + 'path' => '/?antiDDos', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169390', + 'abilityTreeNodes' => [ + 'FEATUREossB6Q3Z5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'x-oss-defender-instance', + 'in' => 'header', + 'schema' => [ + 'description' => 'The Anti-DDoS instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', + ], + ], + [ + 'name' => 'x-oss-defender-status', + 'in' => 'header', + 'schema' => [ + 'description' => 'The new status of the Anti-DDoS instance. Set the value to HaltDefending, which indicates that the Anti-DDos protection is disabled for a bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'HaltDefending', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'UpdateUserAntiDDosInfo', + ], + 'UpdateBucketAntiDDosInfo' => [ + 'summary' => 'Updates the status of an Anti-DDoS instance of a bucket.', + 'path' => '/?antiDDos', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-defender-instance', + 'in' => 'header', + 'schema' => [ + 'description' => 'The Anti-DDoS instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', + ], + ], + [ + 'name' => 'x-oss-defender-status', + 'in' => 'header', + 'schema' => [ + 'description' => 'The new status of the Anti-DDoS instance. Valid values:'."\n" + ."\n" + .'* Init: You must specify the custom domain name that you want to protect.'."\n" + .'* Defending: You can select whether to specify the custom domain name that you want to protect.'."\n" + .'* HaltDefending: You do not need to specify the custom domain name that you want to protect.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Init', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'AntiDDOSConfiguration' => [ + 'description' => 'The container that stores the configurations of Anti-DDoS instances.', + 'required' => false, + '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'UpdateBucketAntiDDosInfo', + ], + 'ListBucketAntiDDosInfo' => [ + 'summary' => 'Queries the protection list of an Anti-DDoS instance of a bucket.', + 'path' => '/?bucketAntiDDos', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169392', + 'abilityTreeNodes' => [ + 'FEATUREossB6Q3Z5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Anti-DDoS instance from which the list starts. The Anti-DDoS instances whose names are alphabetically after the value of marker are returned.'."\n" + ."\n" + .'> You can set marker to an empty string in the first request. If IsTruncated is returned in the response and the value of IsTruncated is true, you must use the value of Marker in the response as the value of marker in the next request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nextMarker', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of Anti-DDoS instances that can be returned.'."\n" + ."\n" + .'Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 100.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AntiDDOSListConfiguration' => [ + 'description' => 'The container that stores the protection list of an Anti-DDoS instance of a bucket.', + 'type' => 'object', + 'properties' => [ + 'Marker' => [ + 'description' => 'The Anti-DDoS instances whose names are alphabetically after the specified marker.', + 'type' => 'string', + 'example' => 'abc', + ], + 'IsTruncated' => [ + 'description' => 'Indicates whether all Anti-DDoS instances are returned.'."\n" + ."\n" + .'- true: All Anti-DDoS instances are returned.'."\n" + ."\n" + .'- false: Not all Anti-DDoS instances are returned.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AntiDDOSConfiguration' => [ + 'description' => 'The container that stores information about the Anti-DDoS instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Anti-DDoS information.', + '$ref' => '#/components/schemas/BucketAntiDDOSInfo', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<AntiDDOSListConfiguration>\\n <Marker>abc</Marker>\\n <IsTruncated>true</IsTruncated>\\n <AntiDDOSConfiguration>\\n <InstanceId/>\\n <Owner/>\\n <Bucket/>\\n <Ctime>0</Ctime>\\n <Mtime>0</Mtime>\\n <ActiveTime>0</ActiveTime>\\n <Status/>\\n <Type/>\\n <Cnames>\\n <Domain/>\\n </Cnames>\\n </AntiDDOSConfiguration>\\n</AntiDDOSListConfiguration>","type":"xml"}]', + 'title' => 'ListBucketAntiDDosInfo', + ], + 'InitUserAntiDDosInfo' => [ + 'summary' => 'Creates an Anti-DDoS instance.', + 'path' => '/?antiDDos', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '169389', + 'abilityTreeNodes' => [ + 'FEATUREossB6Q3Z5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-defender-instance' => [ + 'schema' => [ + 'sdkPropertyName' => 'defenderInstance', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'InitUserAntiDDosInfo', + ], + 'InitBucketAntiDDosInfo' => [ + 'summary' => 'Initializes an Anti-DDoS instance for a bucket.', + 'path' => '/?antiDDos', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'x-oss-defender-instance', + 'in' => 'header', + 'schema' => [ + 'description' => 'The ID of the Anti-DDoS instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', + ], + ], + [ + 'name' => 'x-oss-defender-type', + 'in' => 'header', + 'schema' => [ + 'description' => 'The type of the Anti-DDoS instance. Set the value to AntiDDosPremimum.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AntiDDosPremimum', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'AntiDDOSConfiguration' => [ + 'description' => 'The container that stores the configurations of Anti-DDoS instances.', + 'required' => false, + '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'InitBucketAntiDDosInfo', + ], + 'GetUserAntiDDosInfo' => [ + 'summary' => 'Queries the information about an Anti-DDoS instance of an Alibaba Cloud account.', + 'path' => '/?antiDDos', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169391', + 'abilityTreeNodes' => [ + 'FEATUREossB6Q3Z5', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AntiDDOSListConfiguration' => [ + 'description' => 'The container that stores the list of Anti-DDoS instances.', + 'type' => 'object', + 'properties' => [ + 'AntiDDOSConfiguration' => [ + 'description' => 'The container that stores information about the Anti-DDoS instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of UserAntiDDOSInfo.', + '$ref' => '#/components/schemas/UserAntiDDOSInfo', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<AntiDDOSListConfiguration>\\n <AntiDDOSConfiguration>\\n <InstanceId/>\\n <Owner/>\\n <Ctime>0</Ctime>\\n <Mtime>0</Mtime>\\n <ActiveTime>0</ActiveTime>\\n <Status/>\\n </AntiDDOSConfiguration>\\n</AntiDDOSListConfiguration>","type":"xml"}]', + 'title' => 'GetUserAntiDDosInfo', + ], + 'GetBucketResourceGroup' => [ + 'summary' => 'Queries the ID of the resource group to which a bucket belongs.', + 'path' => '/?resourceGroup', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '要查询的目标Bucket', + 'description' => 'The name of the bucket that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '资源组ID的容器。', + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketResourceGroupConfiguration' => [ + 'description' => 'The container that stores the ID of the resource group.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'title' => 'Bucket所属的资源组ID。', + 'description' => 'The ID of the resource group to which the bucket belongs.'."\n" + ."\n" + .'If this element is not specified, the bucket is moved to the default resource group.', + 'type' => 'string', + 'example' => 'rg-asdfklj***', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<BucketResourceGroupConfiguration>\\n <ResourceGroupId>rg-asdfklj***</ResourceGroupId>\\n</BucketResourceGroupConfiguration>","type":"xml"}]', + 'title' => 'GetBucketResourceGroup', + 'description' => '- Before you configure a resource group for a bucket, make sure that you familiarize yourself with this feature. '."\n" + ."\n" + .'- By default, an Alibaba Cloud account has the permission to configure a resource group to which a bucket belongs. To configure a resource group to which a bucket belongs by using a RAM user or Security Token Service (STS), you must have the oss:PutBucketResourceGroup permission. For more information, see Attach a custom policy to a RAM user.', + ], + 'PutBucketResourceGroup' => [ + 'summary' => 'Modifies the ID of the resource group to which a bucket belongs.', + 'path' => '/?resourceGroup', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '要修改的目标Bucket', + 'description' => 'The bucket for which you want to modify the ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketResourceGroupConfiguration' => [ + 'description' => 'The container that contains the ID of the resource group.', + 'required' => false, + '$ref' => '#/components/schemas/BucketResourceGroupConfiguration', + ], + ], + 'required' => false, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketResourceGroup', + ], + 'PutCname' => [ + 'summary' => 'Maps a CNAME record to a bucket.', + 'path' => '/?cname&comp=add', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketCnameConfiguration' => [ + 'description' => 'The container that stores the CNAME record.', + 'required' => false, + '$ref' => '#/components/schemas/BucketCnameConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutCname', + ], + 'ListCname' => [ + 'summary' => 'Queries all CNAME records that are mapped to a bucket.', + 'path' => '/?cname', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'ListCnameResult' => [ + 'description' => 'The container that is used to query information about all CNAME records.', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the bucket to which the CNAME records you want to query are mapped.', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Owner' => [ + 'description' => 'The name of the bucket owner.', + 'type' => 'string', + 'example' => '133413***273506', + ], + 'Cname' => [ + 'description' => 'The container that is used to store the information about all CNAME records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a specific cname.', + '$ref' => '#/components/schemas/CnameInfo', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListCnameResult>\\n <Bucket>example-bucket</Bucket>\\n <Owner>133413***273506</Owner>\\n <Cname>\\n <Domain/>\\n <LastModified/>\\n <Status/>\\n <Certificate>\\n <Type/>\\n <CertId/>\\n <Status/>\\n <CreationDate/>\\n <Fingerprint/>\\n <ValidStartDate/>\\n <ValidEndDate/>\\n </Certificate>\\n </Cname>\\n</ListCnameResult>","type":"xml"}]', + 'title' => 'ListCname', + ], + 'DeleteCname' => [ + 'summary' => 'Deletes a CNAME record that is mapped to a bucket.', + 'path' => '/?cname&comp=delete', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketCnameConfiguration' => [ + 'description' => 'The container that stores the CNAME record.', + 'required' => false, + '$ref' => '#/components/schemas/BucketCnameConfiguration', + 'type' => 'object', + 'properties' => [ + 'Cname' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteCname', + ], + 'GetCnameToken' => [ + 'summary' => 'Queries the created CNAME tokens.', + 'path' => '/?comp=token', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'cname', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the CNAME record that is mapped to the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CnameToken' => [ + 'description' => 'The container in which the CNAME token is stored.', + '$ref' => '#/components/schemas/CnameToken', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CnameToken>\\n <Bucket/>\\n <Cname/>\\n <Token/>\\n <ExpireTime/>\\n</CnameToken>","type":"xml"}]', + 'title' => 'GetCnameToken', + ], + 'CreateCnameToken' => [ + 'summary' => 'Creates a CNAME token to verify the ownership of a domain name.', + 'path' => '/?cname&comp=token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'BucketCnameConfiguration' => [ + 'description' => 'The container that stores the CNAME record.', + 'type' => 'object', + 'properties' => [ + 'Cname' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The custom domain name.'."\n", + 'example' => 'example.com', + ], + ], + 'required' => false, + 'description' => 'The container that stores the CNAME information.'."\n", + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'CnameToken' => [ + 'description' => 'The container in which the CNAME token is stored.', + '$ref' => '#/components/schemas/CnameToken', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CnameToken>\\n <Bucket/>\\n <Cname/>\\n <Token/>\\n <ExpireTime/>\\n</CnameToken>","type":"xml"}]', + 'title' => 'CreateCnameToken', + 'description' => 'By default, a CNAME token expires within 72 hours after it is created. If a new CNAME token is created within the validity period of the existing token, the existing CNAME token is returned.', + ], + 'PutStyle' => [ + 'summary' => 'Adds an image style to a bucket. An image style contains one or more image processing parameters.', + 'path' => '/?style', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '169383', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket'."\n", + ], + ], + [ + 'name' => 'styleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image style.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'imagestyle', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The category of the style.', + 'example' => 'image', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container that stores the content information about the image style.'."\n", + 'type' => 'object', + 'properties' => [ + 'Style' => [ + 'description' => 'The style content.', + 'required' => false, + '$ref' => '#/components/schemas/Style', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutStyle', + ], + 'ListStyle' => [ + 'summary' => 'Queries all image styles that are created for a bucket.', + 'path' => '/?style', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '169386', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'StyleList' => [ + 'description' => 'The container that was used to query the information about image styles.', + 'type' => 'object', + 'properties' => [ + 'Style' => [ + 'description' => 'The list of styles.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that was used to query the content of image styles.', + '$ref' => '#/components/schemas/StyleInfo', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<StyleList>\\n <Style>\\n <Name>first</Name>\\n <Content>image/resize,p_50</Content>\\n <CreateTime>Wed, 20 May 2020 12:07:15 GMT</CreateTime>\\n <LastModifyTime>Wed, 21 May 2020 12:07:15 GMT</LastModifyTime>\\n <Category>image</Category>\\n </Style>\\n</StyleList>","type":"xml"}]', + 'title' => 'ListStyle', + ], + 'GetStyle' => [ + 'summary' => 'Queries the information about an image style of a bucket.', + 'path' => '/?style', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '169384', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'styleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image style.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'imagestyle', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body in which the queried image styles are stored.'."\n", + 'type' => 'object', + 'properties' => [ + 'Style' => [ + 'description' => 'The container in which the queried image styles are stored.'."\n", + '$ref' => '#/components/schemas/StyleInfo', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<Style>\\n <Name>first</Name>\\n <Content>image/resize,p_50</Content>\\n <CreateTime>Wed, 20 May 2020 12:07:15 GMT</CreateTime>\\n <LastModifyTime>Wed, 21 May 2020 12:07:15 GMT</LastModifyTime>\\n <Category>image</Category>\\n</Style>","type":"xml"}]', + 'title' => 'GetStyle', + ], + 'DeleteStyle' => [ + 'summary' => 'Deletes an image style from a bucket.', + 'path' => '/?style', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '169385', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'styleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the image style.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'imagestyle', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteStyle', + ], + 'GetBucketHttpsConfig' => [ + 'summary' => 'Queries the Transport Layer Security (TLS) version configurations of a bucket.', + 'path' => '/?httpsConfig', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'HttpsConfiguration' => [ + 'description' => 'The container that stores HTTPS configurations.', + '$ref' => '#/components/schemas/HttpsConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<HttpsConfiguration>\\n <TLS>\\n <Enable>true</Enable>\\n <TLSVersion>TLSv1.2</TLSVersion>\\n </TLS>\\n <CipherSuite>\\n <Enable>true</Enable>\\n <StrongCipherSuite>false</StrongCipherSuite>\\n <CustomCipherSuite>ECDHE-ECDSA-AES128-SHA256</CustomCipherSuite>\\n <TLS13CustomCipherSuite>ECDHE-ECDSA-AES256-CCM8</TLS13CustomCipherSuite>\\n </CipherSuite>\\n</HttpsConfiguration>","type":"xml"}]', + 'title' => 'GetBucketHttpsConfig', + 'description' => 'To query the TLS version configurations of a bucket, you must have the oss:GetBucketHttpsConfig permission. For more information, see [Common examples of RAM policies](https://www.alibabacloud.com/help/en/oss/user-guide/common-examples-of-ram-policies#section-ucu-jv0-zip).'."\n" + ."\n" + .'Each region has its own Object Storage Service (OSS) endpoints. For more information about regions and their endpoints, see [Regions and endpoints](https://www.alibabacloud.com/help/en/oss/user-guide/regions-and-endpoints).', + ], + 'PutBucketHttpsConfig' => [ + 'summary' => 'Enables or disables Transport Layer Security (TLS) version management for a bucket.', + 'path' => '/?httpsConfig', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'This name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'HttpsConfiguration' => [ + 'description' => 'The container that stores HTTPS configurations.', + 'required' => false, + '$ref' => '#/components/schemas/HttpsConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketHttpsConfig', + 'description' => 'To enable or disable TLS version management for a bucket, you must have the oss:PutBucketHttpsConfig permission. For more information, see [Common examples of RAM policies](https://www.alibabacloud.com/help/en/oss/user-guide/common-examples-of-ram-policies#section-ucu-jv0-zip).'."\n" + ."\n" + .'Each region has its own Object Storage Service (OSS) endpoints. For more information about regions and their endpoints, see [Regions and endpoints](https://www.alibabacloud.com/help/en/oss/user-guide/regions-and-endpoints).', + ], + 'CreateAccessPointForObjectProcess' => [ + 'summary' => 'Creates an Object FC Access Point.', + 'path' => '/?accessPointForObjectProcess', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '207844', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'CreateAccessPointForObjectProcessConfiguration' => [ + 'description' => 'The container that stores information about the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'AccessPointName' => [ + 'description' => 'The name of the access point.', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-01', + ], + 'ObjectProcessConfiguration' => [ + 'description' => 'The container that stores the processing information about the Object FC Access Point.', + 'required' => false, + '$ref' => '#/components/schemas/ObjectProcessConfiguration', + ], + 'AllowAnonymousAccessForObjectProcess' => [ + 'description' => 'Whether allow anonymous user to access this FC Access Point.', + 'type' => 'string', + 'required' => false, + 'example' => 'disable', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreateAccessPointForObjectProcessResult' => [ + 'description' => 'The container that stores information about the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'AccessPointForObjectProcessArn' => [ + 'description' => 'The ARN of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01', + ], + 'AccessPointForObjectProcessAlias' => [ + 'description' => 'The alias of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CreateAccessPointForObjectProcessResult>\\n <AccessPointForObjectProcessArn>acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01</AccessPointForObjectProcessArn>\\n <AccessPointForObjectProcessAlias>fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias</AccessPointForObjectProcessAlias>\\n</CreateAccessPointForObjectProcessResult>","type":"xml"}]', + 'title' => 'CreateAccessPointForObjectProcess', + ], + 'GetAccessPointForObjectProcess' => [ + 'summary' => 'Queries basic information about an Object FC Access Point.', + 'path' => '/?accessPointForObjectProcess', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207845', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point. The name of an Object FC Access Point must meet the following requirements:'."\n" + ."\n" + .'The name cannot exceed 63 characters in length.'."\n" + ."\n" + .'The name can contain only lowercase letters, digits, and hyphens (-) and cannot start or end with a hyphen (-).'."\n" + ."\n" + .'The name must be unique in the current region.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GetAccessPointForObjectProcessResult' => [ + 'description' => 'The container that stores information about the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'AccessPointNameForObjectProcess' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01', + ], + 'AccessPointForObjectProcessAlias' => [ + 'description' => 'The alias of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', + ], + 'AccessPointName' => [ + 'description' => 'The name of the access point.', + 'type' => 'string', + 'example' => 'ap-01', + ], + 'AccountId' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the Object FC Access Point belongs.', + 'type' => 'string', + 'example' => '111933544165****', + ], + 'AccessPointForObjectProcessArn' => [ + 'description' => 'The ARN of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01', + ], + 'CreationDate' => [ + 'description' => 'The time when the Object FC Access Point was created. The value is a timestamp.', + 'type' => 'string', + 'example' => '1626769503', + ], + 'Status' => [ + 'description' => 'The status of the Object FC Access Point. Valid values:'."\n" + ."\n" + .'enable: The Object FC Access Point is created.'."\n" + ."\n" + .'disable: The Object FC Access Point is disabled.'."\n" + ."\n" + .'creating: The Object FC Access Point is being created.'."\n" + ."\n" + .'deleting: The Object FC Access Point is deleted.', + 'type' => 'string', + 'example' => 'enable', + ], + 'Endpoints' => [ + 'description' => 'The container that stores the endpoints of the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'PublicEndpoint' => [ + 'description' => 'The public endpoint of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01-111933544165****.oss-cn-qingdao.oss-object-process.aliyuncs.com', + ], + 'InternalEndpoint' => [ + 'description' => 'The internal endpoint of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01-111933544165****.oss-cn-qingdao-internal.oss-object-process.aliyuncs.com', + ], + ], + ], + 'AllowAnonymousAccessForObjectProcess' => [ + 'description' => 'Whether allow anonymous users to access this FC Access Point.', + 'type' => 'string', + 'example' => 'false', + ], + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetAccessPointForObjectProcessResult>\\n <AccessPointNameForObjectProcess>fc-ap-01</AccessPointNameForObjectProcess>\\n <AccessPointForObjectProcessAlias>fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias</AccessPointForObjectProcessAlias>\\n <AccessPointName>ap-01</AccessPointName>\\n <AccountId>111933544165****</AccountId>\\n <AccessPointForObjectProcessArn>acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01</AccessPointForObjectProcessArn>\\n <CreationDate>1626769503</CreationDate>\\n <Status>enable</Status>\\n <Endpoints>\\n <PublicEndpoint>fc-ap-01-111933544165****.oss-cn-qingdao.oss-object-process.aliyuncs.com</PublicEndpoint>\\n <InternalEndpoint>fc-ap-01-111933544165****.oss-cn-qingdao-internal.oss-object-process.aliyuncs.com</InternalEndpoint>\\n </Endpoints>\\n <AllowAnonymousAccessForObjectProcess>false</AllowAnonymousAccessForObjectProcess>\\n <PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n </PublicAccessBlockConfiguration>\\n</GetAccessPointForObjectProcessResult>","type":"xml"}]', + 'title' => 'GetAccessPointForObjectProcess', + ], + 'ListAccessPointsForObjectProcess' => [ + 'summary' => 'Lists information about Object FC Access Points in an Alibaba Cloud account.', + 'path' => '/?accessPointForObjectProcess', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207848', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of Object FC Access Points to return.'."\n" + ."\n" + .'Valid values: 1 to 1000'."\n" + ."\n" + .'> If the list cannot be complete at a time due to the configurations of the max-keys element, the NextContinuationToken element is included in the response as the token for the next list.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'continuation-token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token from which the list operation must start. You can obtain this token from the NextContinuationToken element in the returned result.', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ListAccessPointsForObjectProcessResult' => [ + 'description' => 'The container that stores information about the Object FC Access Points that are returned.', + 'type' => 'object', + 'properties' => [ + 'IsTruncated' => [ + 'description' => 'Indicates whether the returned results are truncated. Valid values:'."\n" + ."\n" + .'true: indicates that not all results are returned for the request.'."\n" + ."\n" + .'false: indicates that all results are returned for the request.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextContinuationToken' => [ + 'description' => 'Indicates that this ListAccessPointsForObjectProcess request contains subsequent results. You need to set the NextContinuationToken element to continuation-token for subsequent results.', + 'type' => 'string', + 'example' => 'abc', + ], + 'AccountId' => [ + 'description' => 'The UID of the Alibaba Cloud account to which the Object FC Access Points belong.', + 'type' => 'string', + 'example' => '111933544165****', + ], + 'AccessPointsForObjectProcess' => [ + 'description' => 'The container that stores information about all Object FC Access Points.', + 'type' => 'object', + 'properties' => [ + 'AccessPointForObjectProcess' => [ + 'description' => 'The container that stores information about a single Object FC Access Point.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessPointNameForObjectProcess' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01', + ], + 'AccessPointForObjectProcessAlias' => [ + 'description' => 'The alias of the Object FC Access Point.', + 'type' => 'string', + 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', + ], + 'AccessPointName' => [ + 'description' => 'The name of the access point.', + 'type' => 'string', + 'example' => 'fc-01', + ], + 'Status' => [ + 'description' => 'The status of the Object FC Access Point. Valid values:'."\n" + ."\n" + .'enable: The Object FC Access Point is created.'."\n" + ."\n" + .'disable: The Object FC Access Point is disabled.'."\n" + ."\n" + .'creating: The Object FC Access Point is being created.'."\n" + ."\n" + .'deleting: The Object FC Access Point is deleted.', + 'type' => 'string', + 'example' => 'enable', + ], + 'AllowAnonymousAccessForObjectProcess' => [ + 'description' => 'Whether allow anonymous user access this FC Access Point.', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListAccessPointsForObjectProcessResult>\\n <IsTruncated>true</IsTruncated>\\n <NextContinuationToken>abc</NextContinuationToken>\\n <AccountId>111933544165****</AccountId>\\n <AccessPointsForObjectProcess>\\n <AccessPointForObjectProcess>\\n <AccessPointNameForObjectProcess>fc-ap-01</AccessPointNameForObjectProcess>\\n <AccessPointForObjectProcessAlias>fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias</AccessPointForObjectProcessAlias>\\n <AccessPointName>fc-01</AccessPointName>\\n <Status>enable</Status>\\n <AllowAnonymousAccessForObjectProcess>false</AllowAnonymousAccessForObjectProcess>\\n </AccessPointForObjectProcess>\\n </AccessPointsForObjectProcess>\\n</ListAccessPointsForObjectProcessResult>","type":"xml"}]', + 'title' => 'ListAccessPointsForObjectProcess', + ], + 'DeleteAccessPointForObjectProcess' => [ + 'summary' => 'Deletes an Object FC Access Point.', + 'path' => '/?accessPointForObjectProcess', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteAccessPointForObjectProcess', + ], + 'GetAccessPointConfigForObjectProcess' => [ + 'summary' => 'Queries the configurations of an Object FC Access Point.', + 'path' => '/?accessPointConfigForObjectProcess', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207952', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GetAccessPointConfigForObjectProcessResult' => [ + 'description' => 'The container that stores the configurations of the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'ObjectProcessConfiguration' => [ + 'description' => 'The container that stores the processing information about the Object FC Access Point.', + '$ref' => '#/components/schemas/ObjectProcessConfiguration', + ], + 'AllowAnonymousAccessForObjectProcess' => [ + 'description' => 'Whether allow anonymous user to access this FC Access Points.', + 'type' => 'string', + 'example' => 'false', + ], + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetAccessPointConfigForObjectProcessResult>\\n <ObjectProcessConfiguration>\\n <AllowedFeatures>\\n <AllowedFeature>GetObject-Range</AllowedFeature>\\n </AllowedFeatures>\\n <TransformationConfigurations>\\n <TransformationConfiguration>\\n <Actions>\\n <Action>OSS API操作，目前仅支持GetObject</Action>\\n </Actions>\\n <ContentTransformation>\\n <FunctionCompute>\\n <FunctionAssumeRoleArn>acs:ram::111933544165****:role/aliyunfcdefaultrole</FunctionAssumeRoleArn>\\n <FunctionArn>acs:fc:cn-qingdao:111933544165****:services/test-oss-fc.LATEST/functions/fc-01</FunctionArn>\\n </FunctionCompute>\\n <AdditionalFeatures>\\n <CustomForwardHeaders>\\n <CustomForwardHeader/>\\n </CustomForwardHeaders>\\n </AdditionalFeatures>\\n </ContentTransformation>\\n </TransformationConfiguration>\\n </TransformationConfigurations>\\n </ObjectProcessConfiguration>\\n <AllowAnonymousAccessForObjectProcess>false</AllowAnonymousAccessForObjectProcess>\\n <PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n </PublicAccessBlockConfiguration>\\n</GetAccessPointConfigForObjectProcessResult>","type":"xml"}]', + 'title' => 'GetAccessPointConfigForObjectProcess', + ], + 'PutAccessPointConfigForObjectProcess' => [ + 'summary' => 'Changes the configurations of an Object FC Access Point.', + 'path' => '/?accessPointConfigForObjectProcess', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '207951', + 'abilityTreeNodes' => [ + 'FEATUREoss3VNG8Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point. The name of an Object FC Access Point must meet the following requirements:'."\n" + ."\n" + .'The name cannot exceed 63 characters in length.'."\n" + ."\n" + .'The name can contain only lowercase letters, digits, and hyphens (-) and cannot start or end with a hyphen (-).'."\n" + ."\n" + .'The name must be unique in the current region.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'PutAccessPointConfigForObjectProcessConfiguration' => [ + 'description' => 'The container that stores information about the Object FC Access Point.', + 'type' => 'object', + 'properties' => [ + 'ObjectProcessConfiguration' => [ + 'description' => 'The container that stores the processing information about the Object FC Access Point.', + 'required' => false, + '$ref' => '#/components/schemas/ObjectProcessConfiguration', + ], + 'AllowAnonymousAccessForObjectProcess' => [ + 'description' => 'Whether allow anonymous user to access this FC Access Point.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + 'required' => false, + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutAccessPointConfigForObjectProcess', + ], + 'PutAccessPointPolicyForObjectProcess' => [ + 'summary' => 'Configures policies for an Object FC Access Point.', + 'path' => '/?accessPointPolicyForObjectProcess', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'fc-ap-01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The json format permission policies for an Object FC Access Point.', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": [{'."\n" + .' "Effect": "Allow",'."\n" + .' "Action": ['."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "237210000000000xxxx"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*"'."\n" + .' ]'."\n" + .' }]'."\n" + .' }', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutAccessPointPolicyForObjectProcess', + ], + 'GetAccessPointPolicyForObjectProcess' => [ + 'summary' => 'Queries the policies of an Object FC Access Point.', + 'path' => '/?accessPointPolicyForObjectProcess', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [ + 'application/json', + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The json format permission policies for an Object FC Access Point.', + 'type' => 'string', + 'example' => '{'."\n" + .' "Version": "1",'."\n" + .' "Statement": [{'."\n" + .' "Effect": "Allow",'."\n" + .' "Action": ['."\n" + .' "oss:GetObject"'."\n" + .' ],'."\n" + .' "Principal": ['."\n" + .' "237210000000000xxxx"'."\n" + .' ],'."\n" + .' "Resource": ['."\n" + .' "acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*"'."\n" + .' ]'."\n" + .' }]'."\n" + .' }', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root>{\\n\\t \\"Version\\": \\"1\\",\\n\\t \\"Statement\\": [{\\n\\t\\t \\"Effect\\": \\"Allow\\",\\n\\t\\t \\"Action\\": [\\n\\t\\t\\t \\"oss:GetObject\\"\\n\\t\\t ],\\n\\t\\t \\"Principal\\": [\\n\\t\\t\\t \\"237210000000000xxxx\\"\\n\\t\\t ],\\n\\t\\t \\"Resource\\": [\\n\\t\\t\\t \\"acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*\\"\\n\\t\\t ]\\n\\t }]\\n }</root>","type":"xml"}]', + 'title' => 'GetAccessPointPolicyForObjectProcess', + ], + 'DeleteAccessPointPolicyForObjectProcess' => [ + 'summary' => 'Deletes the policies of an Object FC Access Point.', + 'path' => '/?accessPointPolicyForObjectProcess', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'x-oss-access-point-for-object-process-name', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the Object FC Access Point.', + 'type' => 'string', + 'required' => true, + 'example' => 'fc-ap-01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteAccessPointPolicyForObjectProcess', + ], + 'GetPublicAccessBlock' => [ + 'summary' => 'Queries the Block Public Access configurations of OSS resources.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207983', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n</PublicAccessBlockConfiguration>","type":"xml"}]', + 'title' => 'GetPublicAccessBlock', + ], + 'PutPublicAccessBlock' => [ + 'summary' => 'Enables or disables Block Public Access for Object Storage Service (OSS) resources.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207982', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + 'required' => false, + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutPublicAccessBlock', + ], + 'DeletePublicAccessBlock' => [ + 'summary' => 'Deletes the Block Public Access configurations of OSS resources.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207984', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeletePublicAccessBlock', + ], + 'GetBucketPublicAccessBlock' => [ + 'summary' => 'Queries the Block Public Access configurations of a bucket.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207988', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n</PublicAccessBlockConfiguration>","type":"xml"}]', + 'title' => 'GetBucketPublicAccessBlock', + ], + 'PutBucketPublicAccessBlock' => [ + 'summary' => 'Enables or disables Block Public Access for a bucket.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '207985', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => false, + 'example' => 'exmaplebucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + 'required' => false, + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketPublicAccessBlock', + ], + 'DeleteBucketPublicAccessBlock' => [ + 'summary' => 'Deletes the Block Public Access configurations of a bucket.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketPublicAccessBlock', + ], + 'GetAccessPointPublicAccessBlock' => [ + 'summary' => 'Queries the Block Public Access configurations of an access point.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207994', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the access point.', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<PublicAccessBlockConfiguration>\\n <BlockPublicAccess>true</BlockPublicAccess>\\n</PublicAccessBlockConfiguration>","type":"xml"}]', + 'title' => 'GetAccessPointPublicAccessBlock', + ], + 'PutAccessPointPublicAccessBlock' => [ + 'summary' => 'Enables or disables Block Public Access for an access point.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '207993', + 'abilityTreeNodes' => [ + 'FEATUREoss4PB2DT', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the access point.', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-01', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'PublicAccessBlockConfiguration' => [ + 'description' => 'The container in which the Block Public Access configurations are stored.', + 'required' => false, + '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutAccessPointPublicAccessBlock', + ], + 'DeleteAccessPointPublicAccessBlock' => [ + 'summary' => 'Deletes the Block Public Access configurations of an access point.', + 'path' => '/?publicAccessBlock', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => false, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'x-oss-access-point-name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the access point.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ap-01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteAccessPointPublicAccessBlock', + ], + 'GetBucketArchiveDirectRead' => [ + 'summary' => '查看存储空间归档直读状态', + 'path' => '/?bucketArchiveDirectRead', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ArchiveDirectReadConfiguration' => [ + 'description' => 'The container that stores the configurations for real-time access of Archive objects.', + '$ref' => '#/components/schemas/ArchiveDirectReadConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ArchiveDirectReadConfiguration>\\n <Enabled>true</Enabled>\\n</ArchiveDirectReadConfiguration>","type":"xml"}]', + 'title' => 'GetBucketArchiveDirectRead', + ], + 'PutBucketArchiveDirectRead' => [ + 'summary' => '开启或关闭存储空间归档直读功能', + 'path' => '/?bucketArchiveDirectRead', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'example-bucket'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'ArchiveDirectReadConfiguration' => [ + 'description' => 'The container that stores the configurations for real-time access of Archive objects.', + 'required' => false, + '$ref' => '#/components/schemas/ArchiveDirectReadConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketArchiveDirectRead', + ], + 'PutBucketOverwriteConfig' => [ + 'summary' => 'Call the PutBucketOverwriteConfig operation to configure overwrite protection for a bucket. This prevents specified objects from being overwritten.', + 'path' => '/?overwriteConfig', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287827', + 'abilityTreeNodes' => [ + 'FEATUREossJ033DA', + 'FEATUREossDK8IBS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket Name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体结构', + 'description' => 'Structure of the API Request Body', + 'type' => 'object', + 'properties' => [ + 'OverwriteConfiguration' => [ + 'title' => '保存存储空间覆盖写配置规则的容器', + 'description' => 'Container for Saving the Overwrite Configuration Rules of the Bucket', + 'required' => false, + '$ref' => '#/components/schemas/OverwriteConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'PutBucketOverwriteConfig', + 'translator' => 'machine', + ], + 'GetBucketOverwriteConfig' => [ + 'summary' => 'Call the GetBucketOverwriteConfig operation to retrieve the overwrite configuration of a bucket.', + 'path' => '/?overwriteConfig', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287828', + 'abilityTreeNodes' => [ + 'FEATUREossJ033DA', + 'FEATUREossDK8IBS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket Name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口响应体结构', + 'description' => 'Response Body Structure', + 'type' => 'object', + 'properties' => [ + 'OverwriteConfiguration' => [ + 'title' => '保存存储空间覆盖写规则的容器', + 'description' => 'Container for Saving Bucket Overwrite Rules', + '$ref' => '#/components/schemas/OverwriteConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<OverwriteConfiguration>\\n <Rule>\\n <ID>forbid-write-rule1</ID>\\n <Action>forbid</Action>\\n <Prefix>a/</Prefix>\\n <Suffix>.txt</Suffix>\\n <Principals>\\n <Principal>27737962156157xxxx</Principal>\\n </Principals>\\n </Rule>\\n</OverwriteConfiguration>","type":"xml"}]', + 'title' => 'GetBucketOverwriteConfig', + 'translator' => 'machine', + ], + 'DeleteBucketOverwriteConfig' => [ + 'summary' => 'Delete overwrite configuration rule for the bucket.', + 'path' => '/?overwriteConfig', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287829', + 'abilityTreeNodes' => [ + 'FEATUREossJ033DA', + 'FEATUREossDK8IBS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketOverwriteConfig', + 'translator' => 'machine', + ], + 'PutObject' => [ + 'summary' => 'You can call this operation to upload an object.', + 'path' => '/{key}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'x-oss-forbid-overwrite', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifies whether the object that is uploaded by calling the PutObject operation overwrites the existing object that has the same name. When versioning is enabled or suspended for the bucket to which you want to upload the object, the **x-oss-forbid-overwrite** header does not take effect. In this case, the object that is uploaded by calling the PutObject operation overwrites the existing object that has the same name. '."\r\n" + .' - If you do not specify the **x-oss-forbid-overwrite** header or set the **x-oss-forbid-overwrite** header to **false**, the object that is uploaded by calling the PutObject operation overwrites the existing object that has the same name. '."\r\n" + .' - If the value of **x-oss-forbid-overwrite** is set to **true**, existing objects cannot be overwritten by objects that have the same names. '."\r\n" + ."\r\n" + .'If you specify the **x-oss-forbid-overwrite** request header, the queries per second (QPS) performance of OSS is degraded. If you want to use the **x-oss-forbid-overwrite** request header to perform a large number of operations (QPS greater than 1,000), contact technical support. '."\r\n" + .'Default value: **false**.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The method that is used to encrypt the object on the OSS server when the object is created. '."\n" + ."\n" + .'Valid values: **AES256**, **KMS**, and **SM4****.'."\n" + ."\n" + .'If you specify the header, the header is returned in the response. OSS uses the method that is specified by this header to encrypt the uploaded object. When you download the encrypted object, the **x-oss-server-side-encryption** header is included in the response and the header value is set to the algorithm that is used to encrypt the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'x-oss-server-side-data-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The encryption method on the server side when an object is created. '."\r\n" + ."\r\n" + .'Valid values: **AES256**, **KMS**, and **SM4**.'."\r\n" + ."\r\n" + .'If you specify the header, the header is returned in the response. OSS uses the method that is specified by this header to encrypt the uploaded object. When you download the encrypted object, the **x-oss-server-side-encryption** header is included in the response and the header value is set to the algorithm that is used to encrypt the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption-key-id', + 'in' => 'header', + 'schema' => [ + 'description' => 'The ID of the customer master key (CMK) managed by Key Management Service (KMS). '."\r\n" + .'This header is valid only when the **x-oss-server-side-encryption** header is set to KMS.', + 'type' => 'string', + 'required' => false, + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + ], + ], + [ + 'name' => 'x-oss-object-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The access control list (ACL) of the object. Default value: default. '."\r\n" + .'Valid values:'."\r\n" + ."\r\n" + .'- default: The ACL of the object is the same as that of the bucket in which the object is stored. '."\r\n" + .'- private: The ACL of the object is private. Only the owner of the object and authorized users can read and write this object. '."\r\n" + .'- public-read: The ACL of the object is public-read. Only the owner of the object and authorized users can read and write this object. Other users can only read the object. Exercise caution when you set the object ACL to this value. '."\r\n" + .'- public-read-write: The ACL of the object is public-read-write. All users can read and write this object. Exercise caution when you set the object ACL to this value. '."\r\n" + ."\r\n" + .'For more information about the ACL, see **[ACL](~~100676~~)**.', + 'required' => false, + '$ref' => '#/components/schemas/ObjectACL', + ], + ], + [ + 'name' => 'x-oss-storage-class', + 'in' => 'header', + 'schema' => [ + 'description' => 'The storage class of the bucket. Default value: Standard. Valid values:'."\r\n" + ."\r\n" + .'- Standard'."\r\n" + .'- IA'."\r\n" + .'- Archive'."\r\n" + .'- ColdArchive', + 'required' => false, + '$ref' => '#/components/schemas/StorageClass', + ], + ], + [ + 'name' => 'x-oss-tagging', + 'in' => 'header', + 'schema' => [ + 'description' => 'The tag of the object. You can configure multiple tags for the object. Example: TagA=A&TagB=B. '."\r\n" + .'> The key and value of a tag must be URL-encoded. If a tag does not contain an equal sign (=), the value of the tag is considered an empty string.', + 'type' => 'string', + 'required' => false, + 'example' => 'a:1', + ], + ], + [ + 'name' => 'x-oss-meta-*', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the PutObject request contains a parameter prefixed with **x-oss-meta-***, the parameter is considered as the user metadata. Example: `x-oss-meta-location`. You can specify multiple similar headers for an object. However, the user metadata of an object cannot exceed 8 KB in size. '."\r\n" + ."\r\n" + .'The names of user metadata headers can contain letters, digits, and hyphens (-). Uppercase letters are converted to lowercase letters. Other characters such as underscores (_) are not supported.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'If the PutObject request contains a parameter prefixed with **x-oss-meta-***, the parameter is considered as the user metadata. Example: `x-oss-meta-location`. You can specify multiple similar headers for an object. However, the user metadata of an object cannot exceed 8 KB in size. '."\r\n" + ."\r\n" + .'The names of user metadata headers can contain letters, digits, and hyphens (-). Uppercase letters are converted to lowercase letters. Other characters such as underscores (_) are not supported.', + 'example' => 'x-oss-meta-location', + ], + 'example' => 'x-oss-meta-location', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The body of the request.', + 'type' => 'string', + 'format' => 'binary', + 'required' => false, + 'example' => 'Binary content', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-hash-crc64ecma' => [ + 'schema' => [ + 'sdkPropertyName' => 'crc64', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'x-oss-version-id' => [ + 'schema' => [ + 'sdkPropertyName' => 'contentMD5', + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Upload an object', + 'description' => '**Usage notes**'."\n" + .'- The object that you want to upload cannot be larger than 5 GB in size.'."\n" + ."\n" + .'- By default, if you upload an object whose name is the same as that of an existing object on which you have permissions, the existing object is overwritten by the uploaded object and 200 OK is returned.'."\n" + ."\n" + .'- Object Storage Service (OSS) does not use folders. All resources in OSS are stored as objects. However, you can create a simulated folder by creating an empty object whose name ends with a forward slash (/).'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'- If you call the PutObject operation to upload an object to a versioning-enabled bucket, OSS generates a unique version ID for the uploaded object and returns the version ID as the x-oss-version-id header in the response. '."\n" + .'- If you call the PutObject operation to upload an object to a versioning-suspended bucket, OSS generates a version ID of null for the uploaded object. An object can have only one version whose version ID is null.', + ], + 'CopyObject' => [ + 'summary' => 'Copies objects within a bucket or between buckets in the same region.', + 'path' => '/{key}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss-example', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'x-oss-copy-source', + 'in' => 'header', + 'schema' => [ + 'description' => 'The path of the source object. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/oss-example/oss.jpg', + ], + ], + [ + 'name' => 'x-oss-forbid-overwrite', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifies whether the CopyObject operation overwrites objects with the same name. The **x-oss-forbid-overwrite** request header does not take effect when versioning is enabled or suspended for the destination bucket. In this case, the CopyObject operation overwrites the existing object that has the same name as the destination object.'."\n" + ."\n" + .'* If you do not specify the **x-oss-forbid-overwrite** header or set the header to **false**, an existing object that has the same name as the object that you want to copy is overwritten.****'."\n" + .'* If you set the **x-oss-forbid-overwrite** header to **true**, an existing object that has the same name as the object that you want to copy is not overwritten.'."\n" + ."\n" + .'If you specify the **x-oss-forbid-overwrite** header, the queries per second (QPS) performance of OSS may be degraded. If you want to specify the **x-oss-forbid-overwrite** header in a large number of requests (QPS greater than 1,000), contact technical support. Default value: false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-match', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object copy condition. If the ETag value of the source object is the same as the ETag value that you specify in the request, OSS copies the object and returns 200 OK. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5B3C1A2E053D763E1B002CC607C5****', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-none-match', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object copy condition. If the ETag value of the source object is different from the ETag value that you specify in the request, OSS copies the object and returns 200 OK. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5B3C1A2E053D763E1B002CC607C5****', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-unmodified-since', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object copy condition. If the time that you specify in the request is the same as or later than the modification time of the object, OSS copies the object and returns 200 OK. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-04-09T07:01:56.000Z', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-modified-since', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the source object is modified after the time that you specify in the request, OSS copies the object. By default, this header is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-04-09T07:01:56.000Z', + ], + ], + [ + 'name' => 'x-oss-metadata-directive', + 'in' => 'header', + 'schema' => [ + 'description' => 'The method that is used to configure the metadata of the destination object. Default value: COPY.'."\n" + ."\n" + .'* **COPY**: The metadata of the source object is copied to the destination object. The **x-oss-server-side-encryption** attribute of the source object is not copied to the destination object. The **x-oss-server-side-encryption** header in the CopyObject request specifies the method that is used to encrypt the destination object.'."\n" + .'* **REPLACE**: The metadata that you specify in the request is used as the metadata of the destination object.'."\n" + ."\n" + .'> If the path of the source object is the same as the path of the destination object and versioning is disabled for the bucket in which the source and destination objects are stored, the metadata that you specify in the CopyObject request is used as the metadata of the destination object regardless of the value of the x-oss-metadata-directive header.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'COPY', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The entropy coding-based encryption algorithm that OSS uses to encrypt an object when you create the object. The valid values of the header are **AES256** and **KMS**. You must activate Key Management Service (KMS) in the OSS console before you can use the KMS encryption algorithm. Otherwise, the KmsServiceNotEnabled error is returned.'."\n" + ."\n" + .'* If you do not specify the **x-oss-server-side-encryption** header in the CopyObject request, the destination object is not encrypted on the server regardless of whether the source object is encrypted on the server.'."\n" + .'* If you specify the **x-oss-server-side-encryption** header in the CopyObject request, the destination object is encrypted on the server after the CopyObject operation is performed regardless of whether the source object is encrypted on the server. In addition, the response to a CopyObject request contains the **x-oss-server-side-encryption** header whose value is the encryption algorithm of the destination object. When the destination object is downloaded, the **x-oss-server-side-encryption** header is included in the response. The value of this header is the encryption algorithm of the destination object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'x-oss-server-side-data-encryption', + 'in' => 'header', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'The server side data encryption algorithm. Invalid value: SM4', + 'example' => 'SM4', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption-key-id', + 'in' => 'header', + 'schema' => [ + 'description' => 'The ID of the customer master key (CMK) that is managed by KMS. This parameter is available only if you set **x-oss-server-side-encryption** to KMS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + ], + ], + [ + 'name' => 'x-oss-object-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The access control list (ACL) of the destination object when the object is created. Default value: default.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* default: The ACL of the object is the same as the ACL of the bucket in which the object is stored.'."\n" + .'* private: The ACL of the object is private. Only the owner of the object and authorized users have read and write permissions on the object. Other users do not have permissions on the object.'."\n" + .'* public-read: The ACL of the object is public-read. Only the owner of the object and authorized users have read and write permissions on the object. Other users have only read permissions on the object. Exercise caution when you set the ACL of the bucket to this value.'."\n" + .'* public-read-write: The ACL of the object is public-read-write. All users have read and write permissions on the object. Exercise caution when you set the ACL of the bucket to this value.'."\n" + ."\n" + .'For more information about ACLs, see [Object ACL](~~100676~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ObjectACL', + ], + ], + [ + 'name' => 'x-oss-storage-class', + 'in' => 'header', + 'schema' => [ + 'description' => 'The storage class of the object that you want to upload. Default value: Standard. If you specify a storage class when you upload the object, the storage class applies regardless of the storage class of the bucket to which you upload the object. For example, if you set **x-oss-storage-class** to Standard when you upload an object to an IA bucket, the storage class of the uploaded object is Standard.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* IA'."\n" + .'* Archive'."\n" + .'* ColdArchive'."\n" + ."\n" + .'For more information about storage classes, see [Overview](~~51374~~).'."\n", + 'required' => false, + '$ref' => '#/components/schemas/StorageClass', + ], + ], + [ + 'name' => 'x-oss-tagging', + 'in' => 'header', + 'schema' => [ + 'description' => 'The tag of the destination object. You can add multiple tags to the destination object. Example: TagA=A\\&TagB=B.'."\n" + ."\n" + .'> The tag key and tag value must be URL-encoded. If a key-value pair does not contain an equal sign (=), the tag value is considered an empty string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a:1', + ], + ], + [ + 'name' => 'x-oss-tagging-directive', + 'in' => 'header', + 'schema' => [ + 'description' => 'The method that is used to add tags to the destination object. Default value: Copy. Valid values:'."\n" + ."\n" + .'* **Copy**: The tags of the source object are copied to the destination object.'."\n" + .'* **Replace**: The tags that you specify in the request are added to the destination object.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Copy', + ], + ], + [ + 'name' => 'x-oss-meta-*', + 'in' => 'header', + 'schema' => [ + 'description' => 'You can add parameters that contain the x-oss-meta- prefix when you create an append object. You cannot include these parameters in the requests when you append objects to an existing append object. Parameters that contain the x-oss-meta-\\* prefix are considered the metadata of the object. You can specify multiple parameters that contain the x-oss-meta- prefix for an object. The total size of the metadata cannot exceed 8 KB. The names of parameters that contain the x-oss-meta- prefix can contain hyphens (-), digits, and letters. Uppercase letters are converted into lowercase letters. Other characters such as underscores (\\_) are not supported.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'You can add parameters that contain the x-oss-meta- prefix when you create an append object. You cannot include these parameters in the requests when you append objects to an existing append object. Parameters that contain the x-oss-meta-\\* prefix are considered the metadata of the object. You can specify multiple parameters that contain the x-oss-meta- prefix for an object. The total size of the metadata cannot exceed 8 KB. The names of parameters prefixed with x-oss-meta- can contain hyphens (-), digits, and letters. Uppercase letters are converted to lowercase letters. Other characters such as underscores (\\_) are not supported.'."\n", + 'example' => 'x-oss-meta-location', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-copy-source-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'x-oss-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'CopyObjectResult' => [ + 'description' => 'The results of the CopyObject operation.', + 'type' => 'object', + 'properties' => [ + 'ETag' => [ + 'description' => 'The ETag value of the destination object.', + 'type' => 'string', + 'example' => '5B3C1A2E053D763E1B002CC607C5****', + ], + 'LastModified' => [ + 'description' => 'The time when the destination object was last modified.', + 'type' => 'string', + 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CopyObjectResult>\\n <ETag>5B3C1A2E053D763E1B002CC607C5****</ETag>\\n <LastModified>Fri, 24 Feb 2012 07:18:48 GMT</LastModified>\\n</CopyObjectResult>","type":"xml"}]', + 'title' => 'CopyObject', + 'description' => '**Versioning**'."\n" + ."\n" + .'* By default, the value of `x-oss-copy-source` in a CopyObject request specifies that the current version of the object is copied. You can add versionId to x-oss-copy-source to copy a specific version of the object. If the version of the object that you want to copy is a delete marker, Object Storage Service (OSS) returns 404 Not Found, which indicates that the object does not exist.'."\n" + .'* To restore a previous version of an object to the current version, you can copy the previous version of the object to the bucket in which the object is stored. OSS stores the previous version of the object as the current version.'."\n" + .'* If versioning is enabled for the destination bucket, OSS generates a unique version ID for the new object. The version ID is the value of x-oss-version-id in the response. If versioning is disabled or suspended for the destination bucket, OSS generates a version whose ID is null for the object that is copied to the destination bucket and overwrites the original version whose ID is null.'."\n" + ."\n" + .'**Limits**'."\n" + ."\n" + .'* The following limits are imposed on the size of an object when you call the CopyObject operation:'."\n" + ."\n" + .' * If you copy objects within a bucket by calling the CopyObject operation, no limit is imposed on the size of the object that is copied.'."\n" + .' * If you copy objects between buckets in the same region, we recommend that you call this operation to copy objects that are smaller than 1 GB in size. To copy objects that are larger than 1 GB in size, you can call the [UploadPartCopy](~~31994~~) operation.'."\n" + ."\n" + .' To call the CopyObject or UploadPartCopy operation, you must have read permissions on the source object.'."\n" + ."\n" + .'* When you call the CopyObject operation to copy an object within an unversioned bucket, OSS only modifies the metadata of the source object. OSS does not copy the content of the object.'."\n" + ."\n" + .'* You cannot copy objects that are generated by using append upload in versioned buckets.'."\n" + ."\n" + .'* If the source object is a symbolic link, only the symbolic link is copied. The object to which the symbolic link points is not copied.'."\n" + ."\n" + .'**Billing**'."\n" + ."\n" + .'* Each time you call the CopyObject operation, you are charged for a PUT request to the destination bucket.'."\n" + .'* When you call the CopyObject operation, the storage usage of the destination bucket increases.'."\n" + .'* You are also charged when the CopyObject operation overwrites an object to change the storage class of an object. For example, if you call the CopyObject operation to convert an Infrequent Access (IA) object into a Standard object by overwriting the IA object less than 10 days after the IA object is created, you are charged for the entire minimum storage duration of 30 days. For more information, see the [Storage fees](~~173534~~).'."\n", + ], + 'GetObject' => [ + 'summary' => 'You can call this operation to query an object.', + 'path' => '/{key}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '9047', + 'abilityTreeNodes' => [ + 'FEATUREossM3J9J1', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'response-content-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content-type header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => 'image/jpg', + ], + ], + [ + 'name' => 'response-content-language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content-language header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => '中文', + ], + ], + [ + 'name' => 'response-expires', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expires header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 24 Feb 2012 17:00:00 GMT', + ], + ], + [ + 'name' => 'response-cache-control', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cache-control header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => 'no-cache', + ], + ], + [ + 'name' => 'response-content-disposition', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content-disposition header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => 'attachment; filename:testing.txt', + ], + ], + [ + 'name' => 'response-content-encoding', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content-encoding header in the response that OSS returns.', + 'type' => 'string', + 'required' => false, + 'example' => 'utf-8', + ], + ], + [ + 'name' => 'Range', + 'in' => 'header', + 'schema' => [ + 'description' => 'The range of data of the object to be returned. '."\r\n" + .' - If the value of Range is valid, OSS returns the response that includes the total size of the object and the range of data returned. For example, Content-Range: bytes 0~9/44 indicates that the total size of the object is 44 bytes, and the range of data returned is the first 10 bytes. '."\r\n" + .' - However, if the value of Range is invalid, the entire object is returned, and the response returned by OSS excludes Content-Range. '."\r\n" + ."\r\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'Content-Range: bytes 100-900/344606', + ], + ], + [ + 'name' => 'If-Modified-Since', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the time specified in this header is earlier than the object modified time or is invalid, OSS returns the object and 200 OK. If the time specified in this header is later than or the same as the object modified time, OSS returns 304 Not Modified. '."\r\n" + .'The time must be in GMT. Example: `Fri, 13 Nov 2015 14:47:53 GMT`.'."\r\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', + ], + ], + [ + 'name' => 'If-Unmodified-Since', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the time specified in this header is the same as or later than the object modified time, OSS returns the object and 200 OK. If the time specified in this header is earlier than the object modified time, OSS returns 412 Precondition Failed.'."\r\n" + .' '."\r\n" + .'The time must be in GMT. Example: `Fri, 13 Nov 2015 14:47:53 GMT`.'."\r\n" + .'You can specify both the **If-Modified-Since** and **If-Unmodified-Since** headers in a request. '."\r\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', + ], + ], + [ + 'name' => 'If-Match', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the ETag specified in the request matches the ETag value of the object, OSS transmits the object and returns 200 OK. If the ETag specified in the request does not match the ETag value of the object, OSS returns 412 Precondition Failed. '."\r\n" + .'The ETag value of an object is used to check whether the content of the object has changed. You can check data integrity by using the ETag value. '."\r\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'fba9dede5f27731c9771645a3986****', + ], + ], + [ + 'name' => 'If-None-Match', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the ETag specified in the request does not match the ETag value of the object, OSS transmits the object and returns 200 OK. If the ETag specified in the request matches the ETag value of the object, OSS returns 304 Not Modified. '."\r\n" + .'You can specify both the **If-Match** and **If-None-Match** headers in a request. '."\r\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => '5B3C1A2E0563E1B002CC607C****', + ], + ], + [ + 'name' => 'Accept-Encoding', + 'in' => 'header', + 'schema' => [ + 'description' => 'The encoding type at the client side. '."\n" + .'If you want an object to be returned in the GZIP format, you must include the Accept-Encoding:gzip header in your request. OSS determines whether to return the object compressed in the GZip format based on the Content-Type header and whether the size of the object is larger than or equal to 1 KB.'."\n" + .' '."\n" + .'> If an object is compressed in the GZip format, the response OSS returns does not include the ETag value of the object. '."\n" + .'> - OSS supports the following Content-Type values to compress the object in the GZip format: text/cache-manifest, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, application/json, and text/json. '."\n" + ."\n" + .'Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'gzip', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version ID of the object that you want to query.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-server-side-encryption' => [ + 'schema' => [ + 'sdkPropertyName' => 'serverSideEncryption', + 'type' => 'string', + ], + ], + 'x-oss-server-side-encryption-key-id' => [ + 'schema' => [ + 'sdkPropertyName' => 'sseKeyId', + 'type' => 'string', + ], + ], + 'x-oss-storage-class' => [ + 'schema' => [ + 'sdkPropertyName' => 'storageClass', + 'type' => 'string', + ], + ], + 'x-oss-object-type' => [ + 'schema' => [ + 'sdkPropertyName' => 'objectType', + 'type' => 'string', + ], + ], + 'x-oss-next-append-position' => [ + 'schema' => [ + 'sdkPropertyName' => 'nextAppendPosition', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'x-oss-hash-crc64ecma' => [ + 'schema' => [ + 'sdkPropertyName' => 'crc64ecma', + 'type' => 'string', + ], + ], + 'x-oss-expiration' => [ + 'schema' => [ + 'sdkPropertyName' => 'expiration', + 'type' => 'string', + ], + ], + 'x-oss-restore' => [ + 'schema' => [ + 'sdkPropertyName' => 'restore', + 'type' => 'string', + ], + ], + 'x-oss-process-status' => [ + 'schema' => [ + 'sdkPropertyName' => 'processStatus', + 'type' => 'string', + ], + ], + 'x-oss-request-charged' => [ + 'schema' => [ + 'sdkPropertyName' => 'requestCharged', + 'type' => 'string', + ], + ], + 'Content-Md5' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Content-Length' => [ + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'Last-Modified' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'Content-Type' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'ETag' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'x-oss-meta-*' => [ + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + 'parseType' => 'struct', + ], + ], + 'x‑oss‑tagging‑count' => [ + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'schema' => [ + 'description' => 'The number of tags added to the object. This header is included in the response only when you have the read permissions on tags.', + 'type' => 'string', + 'format' => 'binary', + 'example' => '10', + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"10\\"","type":"json"}]', + 'title' => 'Query an object', + 'description' => '**Usage notes**'."\n" + .'- By default, the GetObject operation supports access over HTTP and HTTPS. To impose a limit on access to a bucket only over HTTPS, configure a bucket policy for the bucket to specify the access method. For more information, see [Configure bucket policies to authorize other users to access OSS resources](~~85111~~).'."\n" + ."\n" + .'- If the storage class of the object that you want to query is Archive, you must send a RestoreObject request to restore the object before you call the GetObject operation.'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'By default, only the current version of an object is returned after GetObject is called. '."\n" + .'If the version ID of the object is specified in the request, OSS returns the specified version of the object. If the version ID is set to null in the request, OSS returns the version of the object whose version ID is null.', + ], + 'AppendObject' => [ + 'summary' => 'You can call this operation to upload an object by appending the object to an existing object.', + 'path' => '/{key}?append', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'position', + 'in' => 'query', + 'schema' => [ + 'description' => 'The position from which the AppendObject operation starts. Each time an AppendObject operation succeeds, the x-oss-next-append-position header is included in the response to specify the position from which the next AppendObject operation starts. The value of position in the first AppendObject operation performed on an object must be 0. The value of position in subsequent AppendObject operations performed on the object is the current length of the object. For example, if the value of position specified in the first AppendObject request is 0 and the value of content-length is 65536, the value of position in the second AppendObject request must be 65536. '."\r\n" + ."\r\n" + .'- If the value of position in the AppendObject request is 0 and the name of the object that you want to append is unique, you can set headers such as x-oss-server-side-encryption in an AppendObject request in the same way as you set in a PutObject request. If you add the x-oss-server-side-encryption header to an AppendObject request, the x-oss-server-side-encryption header is included in the response to the request. If you want to modify metadata, you can call the CopyObject operation. '."\r\n" + .'- If you call an AppendObject operation to append a 0 KB object whose position value is valid to an Appendable object, the status of the Appendable object is not changed.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The method used to encrypt objects on the specified OSS server. '."\r\n" + .'Valid values:'."\r\n" + ."\r\n" + .'- AES256: Keys managed by OSS are used for encryption and decryption (SSE-OSS). '."\r\n" + .'- KMS: Keys managed by Key Management Service (KMS) are used for encryption and decryption. '."\r\n" + .'- SM4: The SM4 block cipher algorithm is used for encryption and decryption.', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'x-oss-object-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The access control list (ACL) of the object. Default value: default. Valid values:'."\r\n" + ."\r\n" + .'- default: The ACL of the object is the same as that of the bucket in which the object is stored. '."\r\n" + .'- private: The ACL of the object is private. Only the owner of the object and authorized users can read and write this object. '."\r\n" + .'- public-read: The ACL of the object is public-read. Only the owner of the object and authorized users can read and write this object. Other users can only read the object. Exercise caution when you set the object ACL to this value. '."\r\n" + .'- public-read-write: The ACL of the object is public-read-write. All users can read and write this object. Exercise caution when you set the object ACL to this value. '."\r\n" + ."\r\n" + .'For more information about the ACL, see [ACL](~~100676~~).', + 'required' => false, + '$ref' => '#/components/schemas/ObjectACL', + 'example' => 'default', + ], + ], + [ + 'name' => 'x-oss-storage-class', + 'in' => 'header', + 'schema' => [ + 'description' => 'The storage class of the object that you want to upload. Valid values:'."\r\n" + ."\r\n" + .'- Standard'."\r\n" + .'- IA'."\r\n" + .'- Archive'."\r\n" + .'If you specify the object storage class when you upload an object, the storage class of the uploaded object is the specified value regardless of the storage class of the bucket to which the object is uploaded. If you set x-oss-storage-class to Standard when you upload an object to an IA bucket, the object is stored as a Standard object. '."\r\n" + .'For more information about storage classes, see the "Overview" topic in Developer Guide. '."\r\n" + ."\r\n" + .'><notice> The value that you specify takes effect only when you call the AppendObject operation on an object for the first time.', + 'required' => false, + '$ref' => '#/components/schemas/StorageClass', + 'example' => 'Standard', + ], + ], + [ + 'name' => 'x-oss-meta-*', + 'in' => 'header', + 'schema' => [ + 'description' => 'You can add parameters whose names are prefixed with x-oss-meta-* when you call the AppendObject operation. These parameters cannot be included in the requests when you append objects to an existing object. Parameters whose names are prefixed with x-oss-meta-* are considered the metadata of the object. '."\r\n" + .'You can configure multiple parameters whose name are prefixed with x-oss-meta- for an object. However, the total size of user metadata cannot exceed 8 KB. '."\r\n" + .'The name of parameters whose name are prefixed with x-oss-meta- can contain hyphens (-), numbers, and letters. Uppercase letters are converted to lowercase letters. Other characters such as underscores (_) are not supported.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'x-oss-meta-location', + 'description' => 'You can add parameters whose names are prefixed with x-oss-meta-* when you call the AppendObject operation. These parameters cannot be included in the requests when you append objects to an existing object. Parameters whose names are prefixed with x-oss-meta-* are considered the metadata of the object. '."\r\n" + .'You can configure multiple parameters whose name are prefixed with x-oss-meta- for an object. However, the total size of user metadata cannot exceed 8 KB. '."\r\n" + .'The name of parameters whose name are prefixed with x-oss-meta- can contain hyphens (-), numbers, and letters. Uppercase letters are converted to lowercase letters. Other characters such as underscores (_) are not supported.', + ], + 'example' => 'x-oss-meta-location', + ], + ], + [ + 'name' => 'Cache-Control', + 'in' => 'header', + 'schema' => [ + 'description' => 'The web page caching behavior for the object. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'no-cache', + ], + ], + [ + 'name' => 'Content-Disposition', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the object when the object is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'attachment;filename=oss_download.jpg', + ], + ], + [ + 'name' => 'Content-Encoding', + 'in' => 'header', + 'schema' => [ + 'description' => 'The encoding format of the object content. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'utf-8', + ], + ], + [ + 'name' => 'Content-MD5', + 'in' => 'header', + 'schema' => [ + 'description' => 'The Content-MD5 header value is a string calculated by using the MD5 algorithm. The header is used to check whether the content of the received message is the same as that of the sent message. '."\r\n" + .'To obtain the value of the Content-MD5 header, calculate a 128-bit number based on the message content except for the header, and then encode the number in Base64. '."\r\n" + .'Default value: null.'."\r\n" + .'Limits: none.', + 'type' => 'string', + 'required' => false, + 'example' => 'ohhnqLBJFiKkPSBO1eNaUA==', + ], + ], + [ + 'name' => 'Expires', + 'in' => 'header', + 'schema' => [ + 'description' => 'The expiration time. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'Wed, 08 Jul 2015 16:57:01 GMT', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'string', + 'format' => 'binary', + 'required' => false, + 'example' => 'Binary content.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-next-append-position' => [ + 'schema' => [ + 'sdkPropertyName' => 'nextAppendPosition', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'x-oss-hash-crc64ecma' => [ + 'schema' => [ + 'sdkPropertyName' => 'crc64', + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Upload an object by appending the object to an existing object', + 'description' => '**Versioning**'."\n" + ."\n" + .'When you perform operations on Appendable objects in a bucket for which versioning is enabled or suspended, take note of the following items:'."\n" + ."\n" + .'- You can call the AppendObject operation only on an Appendable object of the current version. When you call this operation, Object Storage Service (OSS) does not generate a previous version for the Appendable object.'."\n" + .'- When you call the PutObject or DeleteObject operation on an Appendable object of the current version, OSS stores the object as a previous version and prevents the object from being further appended.'."\n" + .'- You cannot copy Appendable objects.'."\n" + .'- The AppendObject operation cannot be performed on non-Appendable objects, such as normal objects and delete markers.'."\n" + ."\n\n" + .'**Limits**'."\n" + ."\n" + .'- The maximum size of an object that is generated by using the AppendObject operation is 5 GB.'."\n" + .'- You cannot call the AppendObject operation on objects that are protected by a retention policy. For more information, see [Retention policy](~~90564~~).'."\n" + .'- Append objects stored in the OSS server cannot be encrypted by using a specified CMK ID.', + ], + 'SealAppendObject' => [ + 'summary' => 'This operation stops writing to the Appendable Object, after which the user can configure lifecycle rules to change the storage class of the corresponding Appendable Object to Cold Archive or Deep Cold Archive.', + 'path' => '/{key}?seal', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '270912', + 'abilityTreeNodes' => [ + 'FEATUREoss3B98QQ', + 'FEATUREoss6C3PSM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'Bucket name', + 'example' => 'test-bucket', + 'required' => true, + 'title' => '存储空间名称', + 'type' => 'string', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'Name of the Appendable Object', + 'example' => 'test-appendable-object', + 'required' => true, + 'title' => 'Appendable Object的名称', + 'type' => 'string', + ], + ], + [ + 'name' => 'position', + 'in' => 'query', + 'schema' => [ + 'description' => 'Used to specify the expected length of the file when the user wants to seal it.', + 'example' => '1024', + 'format' => 'int64', + 'required' => true, + 'type' => 'integer', + 'title' => '指定执行SealAppendObject操作时Object的预期长度。OSS会检查此长度与Object的实际长度是否一致。如果不一致，请求将失败并返回PositionNotEqualToLength错误。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-sealed-time' => [ + 'schema' => [ + 'title' => '该Object执行SealAppendable操作的GMT时间。 若该Object未执行过SealAppendable操作，则返回本次操作时间。 若该Object执行过SealAppendable操作，则返回对应的操作时间。', + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Seal Appendable Object', + 'translator' => 'machine', + ], + 'DeleteObject' => [ + 'summary' => 'You can call this operation to delete an object.', + 'path' => '/{key}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The information about the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version ID of the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQMxiBgIDh3ZCB0BYiIGE4YjIyMjExZDhhYjQxNzZiNGUyZTI4ZjljZDcz****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-delete-marker' => [ + 'schema' => [ + 'type' => 'boolean', + ], + ], + 'x-oss-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'Delete an object', + 'description' => '**Usage notes**'."\n" + ."\n" + .'* To delete an object, you must have write permissions on the object.'."\n" + .'* HTTP status code 204 is returned when the DeleteObject operation succeeds, regardless of whether the object exists.'."\n" + .'* If the object you want to delete is a symbolic link, the DeleteObject operation deletes only the symbolic link but not the content to which the link points.'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'When you call DeleteObject to delete an object from a versioned bucket, you must determine whether to specify a version ID in the request.'."\n" + ."\n" + .'- Delete an object without specifying a version ID (temporary deletion)'."\n" + .'<br>By default, if you do not specify the version ID of the object you want to delete in the request, OSS does not delete the current version of the object and instead add a delete marker to the object as the new current version. In this case, if you perform the GetObject operation on the object without specifying a version ID in the request, OSS identifies that the current version of the object is a delete marker and returns `404 Not Found`. In addition, the `x-oss-delete-marker=true` header and the `x-oss-version-id` header that indicates the version ID of the created delete marker are included in the response.'."\n" + .'<br>The value of the `x-oss-delete-marker` header in the response is true, which indicates that the `x-oss-version-id` is the version ID of a delete marker.'."\n" + ."\n" + .'- Delete an object by specifying a version ID (permanently deletion)'."\n" + .'<br>If you specify the version ID of the object you want to delete in the request, OSS permanently deletes the version specified by the `versionId` field in the `params` parameter. To delete a version whose ID is null, add `params[\'versionId\'] = "null" `in `params` in the request. OSS identifies the string "null" as the ID of the version to delete and deletes the version whose ID is null.', + ], + 'HeadObject' => [ + 'summary' => 'You can call this operation to query the metadata of an object.', + 'path' => '/{key}', + 'methods' => [ + 'head', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9054', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + 'FEATUREoss4HN0W2', + 'FEATUREoss3B98QQ', + 'FEATUREoss6C3PSM', + 'FEATUREossNKCGPP', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'example' => 'examplebucket', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'example' => 'exampledir/exampleobject/txt', + 'required' => true, + 'type' => 'string', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version ID of the object for which you want to query metadata.', + 'example' => 'CAEQMxiBgMCZov2D0BYiIDY4MDllOTc2YmY5MjQxMzdiOGI3OTlhNTU0ODIx****', + 'type' => 'string', + ], + ], + [ + 'name' => 'If-Modified-Since', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the time that is specified in the request is earlier than the time when the object is modified, OSS returns 200 OK and the metadata of the object. Otherwise, OSS returns 304 not modified. '."\r\n" + .'Default value: null.', + 'example' => 'Fri, 9 Apr 2021 14:47:53 GMT', + 'type' => 'string', + ], + ], + [ + 'name' => 'If-Unmodified-Since', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the time that is specified in the request is later than or the same as the time when the object is modified, OSS returns 200 OK and the metadata of the object. Otherwise, OSS returns 412 precondition failed. '."\r\n" + .'Default value: null.', + 'example' => 'Fri, 13 Oct 2021 14:47:53 GMT', + 'type' => 'string', + ], + ], + [ + 'name' => 'If-Match', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the ETag value that is specified in the request matches the ETag value of the object, OSS returns 200 OK and the metadata of the object. Otherwise, OSS returns 412 precondition failed. '."\r\n" + .'Default value: null.', + 'example' => 'fba9dede5f27731c9771645a3986****', + 'type' => 'string', + ], + ], + [ + 'name' => 'If-None-Match', + 'in' => 'header', + 'schema' => [ + 'description' => 'If the ETag value that is specified in the request does not match the ETag value of the object, OSS returns 200 OK and the metadata of the object. Otherwise, OSS returns 304 Not Modified. '."\r\n" + .'Default value: null.', + 'example' => '5B3C1A2E0563E1B002CC607C****', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-server-side-encryption' => [ + 'schema' => [ + 'sdkPropertyName' => 'serverSideEncryption', + 'title' => '如果该Object为进行服务器端熵编码加密存储的，则在响应头头中会返回此参数，其值表明该Object的服务器端加密算法。', + 'type' => 'string', + ], + ], + 'x-oss-server-side-encryption-key-id' => [ + 'schema' => [ + 'sdkPropertyName' => 'sseKeyId', + 'title' => '如果用户在创建Object时使用了服务端加密，且加密方法为KMS，则响应中会包含此Header，表示加密所使用的用户KMS key ID。', + 'type' => 'string', + ], + ], + 'x-oss-storage-class' => [ + 'schema' => [ + 'sdkPropertyName' => 'storageClass', + 'title' => '表示Object的存储类型，分别为标准存储类型（Standard）、低频访问存储类型（IA）、归档存储类型（Archive）、冷归档存储类型（ColdArchive）以及深度冷归档存储类型（DeepColdArchive）。', + 'type' => 'string', + ], + ], + 'x-oss-object-type' => [ + 'schema' => [ + 'sdkPropertyName' => 'objectType', + 'title' => '表示Object的类型。 通过PutObject上传的Object类型为Normal。 通过AppendObject上传的Object类型为Appendable。 通过MultipartUpload上传的Object类型为Multipart。', + 'type' => 'string', + ], + ], + 'x-oss-next-append-position' => [ + 'schema' => [ + 'sdkPropertyName' => 'nextAppendPosition ', + 'title' => '对于Appendable类型的Object会返回此Header，指明下一次请求应当提供的position。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'x-oss-hash-crc64ecma' => [ + 'schema' => [ + 'sdkPropertyName' => 'crc64ecma', + 'title' => '表示该Object的64位CRC值。该64位CRC根据ECMA-182标准计算得出。 对OSS支持CRC64校验前创建的Object，调用HeadObject接口时可能不会返回此响应头。', + 'type' => 'string', + ], + ], + 'x-oss-expiration' => [ + 'schema' => [ + 'sdkPropertyName' => 'expiration', + 'title' => '如果为该Object设置了生命周期规则（Lifecycle），响应中将包含x-oss-expiration header。其中expiry-date的值表示该Object的过期日期，rule-id的值表示相匹配的规则ID。', + 'type' => 'string', + ], + ], + 'x-oss-restore' => [ + 'schema' => [ + 'sdkPropertyName' => 'restore', + 'title' => '如果Bucket类型为Archive，且用户已经提交Restore请求，则响应头中会以x-oss-restore返回该Object的Restore状态，分如下几种情况： 如果没有提交Restore或者Restore已经超时，则不返回该字段。 如果已经提交Restore，且Restore没有完成，则返回的x-oss-restore值为ongoing-request=”true”。 如果已经提交Restore，且Restore已经完成，则返回的x-oss-restore值为ongoing-request=”false”, expiry-date=”Sun, 16 Apr 2017 08:12:33 GMT”，其中expiry-date是Restore完成后Object进入可读状态的过期时间。', + 'type' => 'string', + ], + ], + 'x-oss-process-status' => [ + 'schema' => [ + 'sdkPropertyName' => 'processStatus', + 'title' => '当用户通过MNS消息服务创建OSS事件通知后，在进行请求OSS相关操作时如果有匹配的事件通知规则，则响应中会携带这个Header，值为经过Base64编码JSON格式的事件通知结果。', + 'type' => 'string', + ], + ], + 'x-oss-request-charged' => [ + 'schema' => [ + 'sdkPropertyName' => 'requestCharged', + 'title' => '当Object所属的Bucket被设置为请求者付费模式，且请求者不是Bucket的拥有者时，响应中将携带此Header，值为requester。', + 'type' => 'string', + ], + ], + 'Content-Md5' => [ + 'schema' => [ + 'title' => '对于Normal类型的Object，根据RFC 1864标准对消息内容（不包括Header）计算Md5值获得128比特位数字，对该数字进行Base64编码作为一个消息的Content-Md5值。 Multipart和Appendable类型的文件不会返回这个Header。', + 'type' => 'string', + ], + ], + 'Content-Length' => [ + 'schema' => [ + 'title' => 'RFC 2616中定义的HTTP请求内容长度。此处是Object内容的大小，单位字节。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'Last-Modified' => [ + 'schema' => [ + 'title' => 'Object最后一次修改的日期，格式为HTTP 1.1协议中规定的GMT时间。', + 'type' => 'string', + ], + ], + 'Content-Type' => [ + 'schema' => [ + 'title' => 'RFC 2616中定义的HTTP请求内容类型。', + 'type' => 'string', + ], + ], + 'ETag' => [ + 'schema' => [ + 'title' => 'ETag (entity tag) 在每个Object生成的时候被创建，用于标识一个Object的内容。对于Put Object请求创建的Object，ETag值是其内容的MD5值；对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。ETag值可以用于检查Object内容是否发生变化。', + 'type' => 'string', + ], + ], + 'x-oss-meta-*' => [ + 'style' => 'json', + 'schema' => [ + 'title' => '以x-oss-meta-为前缀的参数作为用户自定义meta header。当用户在PutObject时设置了以x-oss-meta-为前缀的自定义meta，则响应中会包含这些自定义meta。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + 'parseType' => 'struct', + ], + ], + 'x-oss-transition-time' => [ + 'schema' => [ + 'title' => '对象通过Lifecycle转为冷归档或者深度冷归档的时间。', + 'type' => 'string', + ], + ], + 'x‑oss‑tagging‑count' => [ + 'schema' => [ + 'title' => '对象关联的标签个数。仅当用户有读取标签权限时返回。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'description' => '- When you call this operation, the object content is not returned in the results. '."\n" + .'- By default, you can call the HeadObject operation to query the metadata of the object of the current version. If the current version of the object is a delete marker, OSS returns 404 Not Found. If you specify a version ID in the request, OSS returns the metadata of the object of the specified version.', + 'title' => 'Query the metadata of an object', + ], + 'GetObjectMeta' => [ + 'summary' => 'You can call this operation to query the metadata of an object, including ETag, Size, and LastModified. The content of the object is not returned.', + 'path' => '/{key}?objectMeta', + 'methods' => [ + 'head', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9049', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + 'FEATUREoss6C3PSM', + 'FEATUREoss4HN0W2', + 'FEATUREoss3B98QQ', + 'FEATUREossNKCGPP', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The versionID of the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQNRiBgIDMh4mD0BYiIDUzNDA4OGNmZjBjYTQ0YmI4Y2I4ZmVlYzJlNGVk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-version-id' => [ + 'schema' => [ + 'title' => 'Object的版本ID。只有查看Object指定版本的元数据信息时才显示该字段。', + 'type' => 'string', + ], + ], + 'ETag' => [ + 'schema' => [ + 'title' => 'Object生成时会创建ETag (entity tag)，ETag用于标识一个Object的内容。 对于通过PutObject请求创建的Object，ETag值是其内容的MD5值；对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。ETag值可以用于检查Object内容是否发生变化。不建议用户使用ETag作为Object内容的MD5校验来验证数据完整性。', + 'type' => 'string', + ], + ], + 'Content-Length' => [ + 'schema' => [ + 'title' => 'Object的文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + 'x-oss-last-access-time' => [ + 'schema' => [ + 'title' => 'Object的最后一次访问时间。时间格式为HTTP 1.1协议中规定的GMT时间。开启访问追踪时，该字段的值会随着文件被访问的时间持续更新。如果开启后关闭了访问追踪，该字段的值保留为上一次最后更新的值。', + 'type' => 'string', + ], + ], + 'Last-Modifed' => [ + 'schema' => [ + 'title' => 'Object最后一次修改时间。时间格式为HTTP 1.1协议中规定的GMT时间。', + 'type' => 'string', + ], + ], + 'x-oss-transition-time' => [ + 'schema' => [ + 'title' => 'Object通过LIfecycle转为冷归档或深度冷归档的GMT时间。', + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Query the metadata of an object', + 'description' => '**Usage notes**'."\n" + .'- The metadata of an object includes ETag, Size, and LastModified. The content of the object is not returned. If the type of the object is a symbolic link, the information about the symbolic link is returned. '."\n" + .'- To query the metadata of an object in an unversioned bucket, you must have the oss:GetObject permission. To query the metadata of an object of a specific version in a versioned bucket by sending a request that contains the x-oss-version-id header, you must have the oss:GetObjectVersion permission. For more information, see [Attach a custom policy to a RAM user](~~199058~~). '."\n" + ."\n" + .'**Versioning**'."\n" + .'<br>By default, the GetObjectMeta operation queries the metadata of an object of the current version. If the current version of the object is a delete marker, OSS returns 404 Not Found. If you specify a version ID in the request, OSS returns the metadata of the object of the specified version.', + ], + 'RestoreObject' => [ + 'summary' => 'You can call this operation to restore objects of the Archive and Cold Archive storage classes.', + 'path' => '/{key}?restore', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the object that you want to restore.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'RestoreRequest' => [ + 'description' => 'The container that stores information about the RestoreObject request.', + 'required' => false, + '$ref' => '#/components/schemas/RestoreRequest', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-object-restore-priority' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + 'x-oss-version-id' => [ + 'schema' => [ + 'title' => '', + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Restore an Archive object or a Cold Archive object', + 'description' => '**Versioning**'."\n" + ."\n" + .'Different versions of an object may have different storage classes. By default, when you call the RestoreObject operation on an object, the current version of the object is restored. You can specify a version ID in the request to restore a specified version of an object.'."\n" + ."\n" + .'> '."\n" + .'- The RestoreObject operation applies only to Archive objects or Cold Archive objects. This operation does not apply to Standard or Infrequent Access (IA) objects. '."\n" + .'- When RestoreObject is called on an object for the first time, code 202 is returned. '."\n" + .'- When you call RestoreObject on an object that has been restored, 200 OK is returned. '."\n" + ."\n" + .'**Restoration**'."\n" + ."\n" + .'If you want to read an Archive object or a Cold Archive object, you must restore the object in advance. It takes several minutes to restore an Archive object and several hours to restore a Cold Archive object.'."\n" + ."\n" + .'The following describes the status of an Archive object or a Cold Archive object throughout the restoration process:'."\n" + ."\n" + .'1 By default, an Archive object or a Cold Archive object is in the frozen state before restoration.'."\n" + .'<br> 2 After you submit a restore request, the object is in the restoring state.'."\n" + .'<br>3 After the server completes the restoration task, the object enters the restored state and you can read the object. '."\n" + ."\n" + .' - For Archive objects, the restored state lasts 24 hours by default. During the 24 hours, if you call RestoreObject again, the restored state is extended by 24 hours. You can prolong the restored state up to seven days by calling RestoreObject six times during the first 24 hours of restored state. You can also configure the duration of the restored state in days by calling RestoreObject. You can specify a duration of at most seven days. '."\n" + .'- For Cold Archive objects, you can specify the duration of restored state and restoration priority. The duration of the restored state must be at least one day and at most seven days. The time required to restore a Cold Archive object to the readable state is determined based on the restoration priority of the object:'."\n" + ."\n" + .' - Expedited: The object is restored within one hour.'."\n" + ."\n" + .' - Standard: The object is restored within two to five hours. If the JobParameters element is not passed in, the default restoration mode is Standard.'."\n" + ."\n" + .' - Bulk: The object is restored in five to twelve hours.'."\n" + ."\n" + .'<br>4 After the restored state expires, the object returns to the frozen state.'."\n" + ."\n" + .'**Billing**'."\n" + ."\n" + .'The fees generated when an object is converted between different states are described as follows:'."\n" + ."\n" + .'- Data retrieval fees are generated when the restore operation is performed on a frozen object.'."\n" + .'- The restored state can be extended to up to seven days. During this period, data retrieval fees are not generated.'."\n" + .'- After the restored state expires, the object returns to the frozen state. Data retrieval fees are generated if you restore the object again.', + ], + 'CleanRestoredObject' => [ + 'summary' => 'You can call this operation to clean an object restored from Archive or Cold Archive state. After that, the restored object returns to the frozen state.', + 'path' => '/{key}?cleanRestoredObject', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247583', + 'abilityTreeNodes' => [ + 'FEATUREoss6C3PSM', + 'FEATUREossNKCGPP', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'The name of the bucket', + 'type' => 'string', + 'required' => true, + 'example' => 'archive-bucket-example', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'title' => '要清理的解冻副本文件名称', + 'description' => 'The name of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/restored-object', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'CleanRestoredObject', + ], + 'SelectObject' => [ + 'summary' => 'You can call this operation to execute SQL statements on a target object. Results are returned after the execution.', + 'path' => '/{key}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9079', + 'abilityTreeNodes' => [ + 'FEATUREossY4V3W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'x-oss-process', + 'in' => 'query', + 'schema' => [ + 'description' => 'If it is a CSV file, this value should be set to csv/select; if it is a JSON file, it should be set to json/select.', + 'type' => 'string', + 'required' => true, + 'example' => 'csv/select', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The container that stores the SelectObject request.', + 'type' => 'object', + 'properties' => [ + 'SelectRequest' => [ + 'description' => 'Container for saving Select request.', + 'required' => false, + '$ref' => '#/components/schemas/SelectRequest', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'HTTP status code 206 is returned if the operation is successful.'."\n" + ."\n" + .'If the value of header x-oss-select-output-raw is true, the object data except for frame-based data is returned. The client can obtain the data in the same manner as the GetObject operation.'."\n" + ."\n" + .'If the value of x-oss-select-output-raw is false, the result is returned as frames.'."\n" + ."\n" + .'The frames are returned in the Version|Frame-Type | Payload Length | Header Checksum | Payload | Payload Checksum<1 byte><--3 bytes--><---4 bytes----><-------4 bytes--><variable><----4bytes----------> format.'."\n" + ."\n" + .'>The value of Checksum in frames is CRC-32. All integers in a frame are big-endian. Currently, the value of Version is 1.', + 'type' => 'string', + 'format' => 'binary', + 'example' => 'none', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"无\\"","type":"json"}]', + 'title' => 'Execute SQL statements on an object and return the result', + 'description' => '- You must have read permissions on the object. '."\n" + .'- The 206 status code is returned if the execution is successful. If the SQL statement is not valid or cannot match any objects, the 400 HTTP status code is returned. '."\n" + .'- For more information about the features of SelectObject, see [OSS Developer Guide](~~106082~~).', + 'translator' => 'machine', + ], + 'CreateSelectObjectMeta' => [ + 'summary' => 'Used to get the total number of rows, total number of columns (for CSV files), and the number of Splits', + 'path' => '/{key}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '122930', + 'abilityTreeNodes' => [ + 'FEATUREossXWZUYL', + ], + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'Bucket name.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the Object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.png', + ], + ], + [ + 'name' => 'x-oss-process', + 'in' => 'query', + 'schema' => [ + 'description' => 'Parameters to specify the file formate.', + 'type' => 'string', + 'required' => true, + 'example' => 'csv/meta', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Container for the CreateSelectObjectMeta request.', + 'type' => 'object', + 'properties' => [ + 'CsvMetaRequest' => [ + 'description' => 'The request body used to create select meta.', + 'required' => false, + '$ref' => '#/components/schemas/SelectMetaRequest', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Container for storing CreateSelectObjectMeta information.', + '$ref' => '#/components/schemas/SelectMetaStatus', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root>\\n <Offset>0</Offset>\\n <TotalScannedBytes>0</TotalScannedBytes>\\n <Status>0</Status>\\n <SplitsCount>0</SplitsCount>\\n <RowsCount>0</RowsCount>\\n <ColsCount>0</ColsCount>\\n <ErrorMessage/>\\n</root>","type":"xml"}]', + 'title' => 'Get Total Number of Rows, Columns, and Splits of the Target File', + 'description' => '- The `CreateSelectObjectMeta` operation requires you to have write permission for the Object.'."\n" + ."\n" + .'- If the API executes correctly, it returns 200. If the target file is not a valid CSV or JSON LINES file, or if the specified CSV delimiter does not match the target CSV, it returns 400.', + 'translator' => 'machine', + ], + 'InitiateMultipartUpload' => [ + 'summary' => 'Initiates a multipart upload task.', + 'path' => '/{key}?uploads', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket to which the object is uploaded by the multipart upload task.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the object that is uploaded by the multipart upload task.', + 'type' => 'string', + 'required' => true, + 'example' => 'multipart.data', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method used to encode the object name in the response. Only URL encoding is supported. The object name can contain characters encoded in UTF-8. However, the XML 1.0 standard cannot be used to parse specific control characters, such as characters whose ASCII values range from 0 to 10. You can configure the encoding-type parameter to encode object names that include characters that cannot be parsed by XML 1.0 in the response.'."\n" + .'<br>Default value: null', + 'required' => false, + '$ref' => '#/components/schemas/EncodeType', + ], + ], + [ + 'name' => 'x-oss-forbid-overwrite', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifies whether the InitiateMultipartUpload operation overwrites the existing object that has the same name as the object that you want to upload. When versioning is enabled or suspended for the bucket to which you want to upload the object, the **x-oss-forbid-overwrite** header does not take effect. In this case, the InitiateMultipartUpload operation overwrites the existing object that has the same name as the object that you want to upload. '."\r\n" + .' - If you do not specify the **x-oss-forbid-overwrite** header or set the **x-oss-forbid-overwrite** header to **false**, the object that is uploaded by calling the PutObject operation overwrites the existing object that has the same name. '."\r\n" + .' - If the value of **x-oss-forbid-overwrite** is set to **true**, existing objects cannot be overwritten by objects that have the same names. '."\r\n" + ."\r\n" + .'If you specify the **x-oss-forbid-overwrite** request header, the queries per second (QPS) performance of OSS is degraded. If you want to use the **x-oss-forbid-overwrite** request header to perform a large number of operations (QPS greater than 1,000), contact technical support', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'x-oss-storage-class', + 'in' => 'header', + 'schema' => [ + 'description' => 'The storage class of the bucket. Default value: Standard. Valid values:'."\r\n" + ."\r\n" + .'- Standard'."\r\n" + .'- IA'."\r\n" + .'- Archive'."\r\n" + .'- ColdArchive', + 'required' => false, + '$ref' => '#/components/schemas/StorageClass', + ], + ], + [ + 'name' => 'x-oss-tagging', + 'in' => 'header', + 'schema' => [ + 'description' => 'The tag of the object. You can configure multiple tags for the object. Example: TagA=A&TagB=B.'."\n" + .'> The key and value of a tag must be URL-encoded. If a tag does not contain an equal sign (=), the value of the tag is considered an empty string.', + 'type' => 'string', + 'required' => false, + 'example' => 'a:1', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The server-side encryption method that is used to encrypt each part of the object that you want to upload. '."\n" + .'Valid values: **AES256**, **KMS**, and **SM4**.'."\n" + .'> You must activate Key Management Service (KMS) before you set this header to KMS. '."\n" + ."\n\n" + .'If you specify this header in the request, this header is included in the response. OSS uses the method specified by this header to encrypt each uploaded part. When you download the object, the x-oss-server-side-encryption header is included in the response and the header value is set to the algorithm that is used to encrypt the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'AES256', + ], + ], + [ + 'name' => 'x-oss-server-side-data-encryption', + 'in' => 'header', + 'schema' => [ + 'description' => 'The algorithm that is used to encrypt the object that you want to upload. If this header is not specified, the object is encrypted by using AES-256. This header is valid only when **x-oss-server-side-encryption** is set to KMS. '."\r\n" + .'Valid value: SM4.', + 'type' => 'string', + 'required' => false, + 'example' => 'SM4', + ], + ], + [ + 'name' => 'x-oss-server-side-encryption-key-id', + 'in' => 'header', + 'schema' => [ + 'description' => 'The ID of the CMK that is managed by KMS. '."\r\n" + .'This header is valid only when **x-oss-server-side-encryption** is set to KMS.', + 'type' => 'string', + 'required' => false, + 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', + ], + ], + [ + 'name' => 'Cache-Control', + 'in' => 'header', + 'schema' => [ + 'description' => 'The caching behavior of the web page when the object is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + ], + [ + 'name' => 'Content-Disposition', + 'in' => 'header', + 'schema' => [ + 'description' => 'The name of the object when the object is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'attachment;filename=oss_download.jpg ', + ], + ], + [ + 'name' => 'Content-Encoding', + 'in' => 'header', + 'schema' => [ + 'description' => 'The content encoding format of the object when the object is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'utf-8', + ], + ], + [ + 'name' => 'Expires', + 'in' => 'header', + 'schema' => [ + 'description' => 'The expiration time of the request. Unit: milliseconds. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**. '."\r\n" + .'Default value: null.', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 28 Feb 2012 05:38:42 GMT ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'InitiateMultipartUploadResult' => [ + 'description' => 'The container that stores the results of the InitiateMultipartUpload request.', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the bucket to which the object is uploaded by the multipart upload task.', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Key' => [ + 'description' => 'The name of the object that is uploaded by the multipart upload task.', + 'type' => 'string', + 'example' => 'test.txt', + ], + 'UploadId' => [ + 'description' => 'The upload ID that uniquely identifies the multipart upload task. The upload ID is used to call UploadPart and CompleteMultipartUpload later.', + 'type' => 'string', + 'example' => '0004B9894A22E5B1888A1E29F823****', + ], + 'EncodingType' => [ + 'description' => 'The encoding type of the object name in the response. If the encoding-type parameter is specified in the request, the object name in the response is encoded.', + 'type' => 'string', + 'example' => 'url', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<InitiateMultipartUploadResult>\\n <Bucket>example-bucket</Bucket>\\n <Key>test.txt</Key>\\n <UploadId>0004B9894A22E5B1888A1E29F823****</UploadId>\\n <EncodingType>url</EncodingType>\\n</InitiateMultipartUploadResult>","type":"xml"}]', + 'title' => 'InitiateMultipartUpload', + 'description' => '- When you call the InitiateMultipartUpload operation, OSS creates and returns a unique upload ID to identify the multipart upload task. You can initiate operations such as stopping or querying the multipart upload task by using this upload ID.'."\n" + .'- When you initiate a multipart upload request to upload an object, the existing object that has the same name is not affected.'."\n" + .'- If you want to calculate the signature for authentication when you call this operation, you must add `?uploads` to `CanonicalizedResource`.'."\n", + ], + 'UploadPart' => [ + 'summary' => 'You can call this operation to upload an object by part based on the object name and the upload ID that you specify.', + 'path' => '/{key}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'partNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number that identifies a part. '."\n" + ."\n" + .'Valid values: 1 to 10000.'."\n" + ."\n" + .'The size of a part ranges from 100 KB to 5 GB. '."\n" + .'> In multipart upload, each part except the last part must be larger than or equal to 100 KB in size. When you call the UploadPart operation, the size of each part is not verified because not all parts have been uploaded and OSS does not know which part is the last part. The size of each part is verified only when you call CompleteMultipartUpload.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'uploadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID that identifies the object to which the part that you want to upload belongs.', + 'type' => 'string', + 'required' => true, + 'example' => '0004B9895DBBB6EC98E36', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'string', + 'format' => 'binary', + 'required' => false, + 'example' => 'Binary content.', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Upload data by part', + 'description' => '- Before you call the UploadPart operation to upload data by part, you must call the InitiateMultipartUpload operation to obtain an upload ID that is generated by OSS.'."\n" + .'- If you use the same partNumber to upload a new part, the existing part that is uploaded by using the partNumber is overwritten.'."\n" + .'- OSS includes the MD5 hash value of each received part in the ETag header of the response.'."\n" + .'- If you specify the x-oss-server-side-encryption request header when you call the InitiateMultipartUpload operation, the part that you upload is encrypted. '."\n" + .'<br>The x-oss-server-side-encryption header is included in the response, which indicates the server-side encryption algorithm of the part. For more information, see [InitiateMultipartUpload](~~31992~~).'."\n", + ], + 'CompleteMultipartUpload' => [ + 'summary' => 'You can call this operation to complete the multipart upload task of an object.', + 'path' => '/{key}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'uploadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the multipart upload task.', + 'type' => 'string', + 'required' => true, + 'example' => '0004B9895DBBB6E****', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encodingtype of the object name in the response. Only URL encoding is supported.'."\n" + .'The object name can contain characters that are encoded in UTF-8. However, the XML 1.0 standard cannot be used to parse control characters, such as characters with an ASCII value from 0 to 10. You can configure this parameter to encode the object name in the response.', + 'required' => false, + '$ref' => '#/components/schemas/EncodeType', + ], + ], + [ + 'name' => 'x-oss-forbid-overwrite', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifieswhethertheobjectwith the sameobjectname is overwritten when you call the CompleteMultipartUpload operation.'."\n" + ."\n" + .'- If the value of x-oss-forbid-overwrite is not specified or set to false, the existing object can be overwritten by the object that has the same name. '."\n" + .'- If the value of x-oss-forbid-overwrite is set to true, the existing object cannot be overwritten by the object that has the same name. '."\n" + ."\n" + .'- The x-oss-forbid-overwrite request header is invalid if versioning is enabled or suspended for the bucket. In this case, the existing object can be overwritten by the object that has the same name when you call the CompleteMultipartUpload operation. '."\n" + .'- If you specify the x-oss-forbid-overwrite request header, the queries per second (QPS) performance of OSS may be degraded. If you want to configure the x-oss-forbid-overwrite header in a large number of requests (QPS > 1,000), submit a ticket.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'x-oss-complete-all', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifies whether to list all parts that are uploaded by using the current upload ID.'."\n" + ."\n" + .'Valid value: yes.'."\n" + ."\n" + .'- If x-oss-complete-all is set to yes in the request, OSS lists all parts that are uploaded by using the current upload ID, sorts the parts by part number, and then performs the CompleteMultipartUpload operation. When OSS performs the CompleteMultipartUpload operation, OSS cannot detect the parts that are not uploaded or currently being uploaded. Before you call the CompleteMultipartUpload operation, make sure that all parts are uploaded.'."\n" + ."\n" + .'- If x-oss-complete-all is specified in the request, the request body cannot be specified. Otherwise, an error occurs.'."\n" + ."\n" + .'- If x-oss-complete-all is specified in the request, the format of the response remains unchanged.', + 'type' => 'string', + 'required' => false, + 'example' => 'yes', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'CompleteMultipartUpload' => [ + 'description' => 'The container that stores the content of the CompleteMultipartUpload request.', + 'required' => false, + '$ref' => '#/components/schemas/CompleteMultipartUpload', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-version-id' => [ + 'schema' => [ + 'title' => '文件版本id', + 'type' => 'string', + ], + ], + ], + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'CompleteMultipartUploadResult' => [ + 'description' => 'The container that stores the results of the CompleteMultipartUpload request.', + 'type' => 'object', + 'properties' => [ + 'EncodingType' => [ + 'description' => 'The encoding type of the object name in the response. If this parameter is specified in the request, the object name is encoded in the response.', + 'type' => 'string', + 'example' => 'url', + ], + 'Location' => [ + 'description' => 'The URL that is used to access the uploaded object.', + 'type' => 'string', + 'example' => 'http://oss-example.oss-cn-hangzhou.aliyuncs.com/multipart.data', + ], + 'Bucket' => [ + 'description' => 'The name of the bucket that contains the object you want to restore.', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Key' => [ + 'description' => 'The name of the uploaded object.', + 'type' => 'string', + 'example' => 'multipart.data', + ], + 'ETag' => [ + 'description' => 'The ETag that is generated when an object is created. ETags are used to identify the content of objects.'."\n" + ."\n" + .'If an object is created by calling the CompleteMultipartUpload operation, the ETag value is not the MD5 hash of the object content but a unique value calculated based on a specific rule.'."\n" + ."\n" + .'> The ETag of an object can be used to check whether the object content is modified. However, we recommend that you use the MD5 hash of an object rather than the ETag value of the object to verify data integrity.', + 'type' => 'string', + 'example' => '"B864DB6A936D376F9F8D3ED3BBE540****"', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CompleteMultipartUploadResult>\\n <EncodingType>url</EncodingType>\\n <Location>http://oss-example.oss-cn-hangzhou.aliyuncs.com/multipart.data</Location>\\n <Bucket>example-bucket</Bucket>\\n <Key>multipart.data</Key>\\n <ETag>\\"B864DB6A936D376F9F8D3ED3BBE540****\\"</ETag>\\n</CompleteMultipartUploadResult>","type":"xml"}]', + 'title' => 'Complete the multipart upload task of an object', + 'description' => '**Usage notes**'."\n" + .'- Confirm the size of each part'."\n" + .'<br>When you call the CompleteMultipartUpload operation, OSS checks whether each part except the last part is larger than or equal to 100 KB in size and verifies the part number and ETag of each part provided in the part list. Therefore, when a part is uploaded, the client must record not only the part number of the part but also the ETag value of the part returned from the server.'."\n" + ."\n" + .'- Handle requests'."\n" + .'<br>It may take a period of time for OSS to process a CompleteMultipartUpload request. If the client is disconnected from OSS during the period, OSS continues to process the request.'."\n" + ."\n" + .'- PartNumber'."\n" + .'<br>OSS verifies the value of PartNumber when you call the CompleteMultipartUpload operation. '."\n" + .' The value of PartNumber ranges from 1 to 10000. The part numbers listed in the request can be non-consecutive but must be sorted in ascending order. For example, if the part number of the first part is 1, the part number of the second part can be 5.'."\n" + ."\n" + .'- UploadId'."\n" + .'<br>An object can be uploaded by multiple upload tasks that have independent upload IDs. When one upload task is completed, its upload ID becomes invalid, but the upload IDs of other upload tasks are not affected.'."\n" + ."\n" + .'- The x-oss-server-side-encryption request header'."\n" + .'<br>If the x-oss-server-side-encryption header is specified in an InitiateMultipartUpload request, this header is returned in the response to the CompleteMultipartUpload request. The value of the x-oss-server-side-encryption header in the response indicates the method that is used to encrypt the object on the OSS server.'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'You can call the CompleteMultipartUpload operation to complete the multipart upload task of an object when versioning is enabled for the bucket to which the object is uploaded. In this case, OSS generates a unique version ID for the object, and returns the version ID as the x-oss-version-id header in the response.', + ], + 'UploadPartCopy' => [ + 'summary' => '通过拷贝现有文件的方式上传单个分片', + 'path' => '/{key}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'x-oss-copy-source', + 'in' => 'header', + 'schema' => [ + 'description' => 'The address to access the source object. You must have permissions to read the source object.'."\n" + .'<br>Default value: null', + 'type' => 'string', + 'required' => true, + 'example' => '/oss-example/ src-object', + ], + ], + [ + 'name' => 'partNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of parts.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'uploadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID that identifies the object to which the parts to upload belong.', + 'type' => 'string', + 'required' => true, + 'example' => '0004B999EF5A239BB9138C6227D69F95', + ], + ], + [ + 'name' => 'x-oss-copy-source-range', + 'in' => 'header', + 'schema' => [ + 'description' => 'The range of bytes to copy data from the source object. For example, if you specify bytes to 0 to 9, the system transfers byte 0 to byte 9, a total of 10 bytes.'."\n" + .'<br>Default value: null'."\n" + ."\n" + .'- If the x-oss-copy-source-range request header is not specified, the entire source object is copied.'."\n" + .'- If the x-oss-copy-source-range request header is specified, the response contains the length of the entire object and the range of bytes to be copied for this operation. For example, Content-Range: bytes 0~9/44 indicates that the length of the entire object is 44 bytes. The range of bytes to be copied is byte 0 to byte 9.'."\n" + .'- If the specified range does not conform to the range conventions, OSS copies the entire object and does not include Content-Range in the response.', + 'type' => 'string', + 'required' => false, + 'example' => 'bytes=100-6291756', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-match', + 'in' => 'header', + 'schema' => [ + 'description' => 'The copy operation condition. If the ETag value of the source object is the same as the ETag value provided by the user, OSS copies data. Otherwise, OSS returns 412 Precondition Failed.'."\n" + .'<br>Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => '5B3C1A2E053D763E1B002CC607C5****', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-none-match', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object transfer condition. If the input ETag value does not match the ETag value of the object, the system transfers the object normally and returns 200 OK. Otherwise, OSS returns 304 Not Modified.'."\n" + .'<br>Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => '5B3C1A2E053D763E1B002CC607C5****', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-unmodified-since', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object transfer condition. If the specified time is the same as or later than the actual modified time of the object, OSS transfers the object normally and returns 200 OK. Otherwise, OSS returns 412 Precondition Failed.'."\n" + .'<br>Default value: null', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 13 Oct 2015 14:47:53 GMT', + ], + ], + [ + 'name' => 'x-oss-copy-source-if-modified-since', + 'in' => 'header', + 'schema' => [ + 'description' => 'The object transfer condition. If the specified time is earlier than the actual modified time of the object, the system transfers the object normally and returns 200 OK. Otherwise, OSS returns 304 Not Modified.'."\n" + .'<br>Default value: null'."\n" + .'<br>Time format: ddd, dd MMM yyyy HH:mm:ss GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.', + 'type' => 'string', + 'required' => false, + 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-copy-source-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'CopyPartResult' => [ + 'description' => 'The container that stores the copy result.', + 'type' => 'object', + 'properties' => [ + 'LastModified' => [ + 'description' => 'The last modified time of copy source.', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2014-07-17T06:27:54.000Z', + ], + 'ETag' => [ + 'description' => 'The ETag of the copied part.', + 'type' => 'string', + 'example' => '"5B3C1A2E053D763E1B002CC607C5****"', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CopyPartResult>\\n <LastModified>2014-07-17T06:27:54.000Z</LastModified>\\n <ETag>\\"5B3C1A2E053D763E1B002CC607C5****\\"</ETag>\\n</CopyPartResult>","type":"xml"}]', + 'title' => 'UploadPartCopy', + 'description' => '**Usage notes**'."\n" + .'<br>To copy an object larger than 1 GB, use UploadPartCopy. For more information about how to copy objects smaller than 1 GB, see [CopyObject](~~31979~~).'."\n" + ."\n" + .'When you use UploadPartCopy, take note of the following items:'."\n" + ."\n" + .'- You cannot call AppendObject to copy data from append objects.'."\n" + .'- When you call UploadPartCopy, the source and destination buckets must be located within the same region.'."\n" + .'- Before you call UploadPart to upload a part, you must call InitiateMultipartUpload to obtain an upload ID issued by the OSS server.'."\n" + .'- If the x-oss-server-side-encryption request header is specified when you call InitiateMultipartUpload, the uploaded part is encoded. The x-oss-server-side-encryption header is included in the response header of UploadPart, which indicates the server-side encryption method of the part. For more information, see [InitiateMultipartUpload](~~31992~~).'."\n" + .'- In the multipart upload mode, each part except the last part must be larger than 100 KB in size. The size of each part is not verified when you call UploadPart because not all parts are uploaded and the system does not know which part is the last part. The size of each part is verified only when you call CompleteMultipartUpload.'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'By default, UploadPartCopy is used to upload a part by copying data from an existing object of the current version. To copy data from an object of a specific version, include versionId in the x-oss-copy-source request header as a subcondition in the request. You can set x-oss-copy-source to x-oss-copy-source : /SourceBucketName/SourceObjectName? versionId=111111.'."\n" + .'>The name of the source object must be URL-encoded. x-oss-copy-source-version-id is returned in the response, indicating the version ID of the source object.'."\n" + ."\n\n" + .'If versionId is not specified and the current version of the source object is a delete marker, OSS returns 404 Not Found. If versionId is specified and the current version of the source object is a delete marker, OSS returns 400 Bad Request.', + ], + 'AbortMultipartUpload' => [ + 'summary' => 'You can call this operation to cancel a multipart upload task and delete the parts that are uploaded by the multipart upload task.', + 'path' => '/{key}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'oss-example', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object that you want to upload.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'uploadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the multipart upload task.', + 'type' => 'string', + 'required' => true, + 'example' => '0004B9895DBBB6E****', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Cancel a multipart upload task and delete the parts that are uploaded by the multipart upload task', + 'description' => '- You must provide the upload ID of the multipart upload task that you want to cancel.'."\n" + .'- When you cancel a multipart upload task, parts that are being uploaded cannot be deleted.'."\n" + .'- After a multipart upload task is canceled, you cannot use the upload ID of the task to perform any operations and the parts uploaded by the task are deleted.'."\n" + .'- We recommend that you complete or cancel multipart upload tasks that are not complete in a timely manner because parts that are uploaded by these tasks consume storage space and incur storage fees.'."\n", + ], + 'ListMultipartUploads' => [ + 'summary' => 'You can call this operation to list all ongoing multipart upload tasks.', + 'path' => '/?uploads', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'delimiter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The character used to group objects by name. Objects whose names contain the same string that ranges from the specified prefix to the delimiter that appears for the first time are grouped as a CommonPrefixes element.', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + ], + [ + 'name' => 'max-uploads', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximumnumber of multipart upload tasks that can be returned for the current request. Default value: 1000. Maximum value: 1000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'key-marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is used together with the upload-id-marker parameter to specify the position from which the next list begins.'."\n" + ."\n" + .'- If the upload-id-marker parameter is not set, Object Storage Service (OSS) returns all multipart upload tasks in which object names are alphabetically after the key-marker value.'."\n" + ."\n" + .'- If the upload-id-marker parameter is set, the response includes the following tasks:'."\n" + ."\n" + .' - Multipart upload tasks in which object names are alphabetically after the key-marker value in alphabetical order'."\n" + ."\n" + .' - Multipart upload tasks in which object names are the same as the key-marker parameter value but whose upload IDs are greater than the upload-id-marker parameter value', + 'type' => 'string', + 'required' => false, + 'example' => 'test1.avi', + ], + ], + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix that the returned object names must contain. If you specify a prefix in the request, the specified prefix is included in the response.'."\n" + ."\n" + .'>You can use prefixes to group and manage objects in buckets in the same way you manage a folder in a file system.', + 'type' => 'string', + 'required' => false, + 'example' => 'fun/', + ], + ], + [ + 'name' => 'upload-id-marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The upload ID of the multipart upload task after which the list begins. This parameter is used together with the key-marker parameter.'."\n" + ."\n" + .'- If the key-marker parameter is not set, OSS ignores the upload-id-marker parameter.'."\n" + ."\n" + .'- If the key-marker parameter is configured, the query result includes:'."\n" + ."\n" + .' - Multipart upload tasks in which object names are alphabetically after the key-marker value in alphabetical order'."\n" + ."\n" + .' - Multipart upload tasks in which object names are the same as the key-marker parameter value but whose upload IDs are greater than the upload-id-marker parameter value', + 'type' => 'string', + 'required' => false, + 'example' => '0004B99B8E707874FC2D692FA5D7****', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encoding type of the object name in the response. Values of Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key can be encoded in UTF-8. However, the XML 1.0 standard cannot be used to parse control characters such as characters with an American Standard Code for Information Interchange (ASCII) value from 0 to 10. You can set the encoding-type parameter to encode values of Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key in the response.'."\n" + ."\n" + .'Default value: null', + 'required' => false, + '$ref' => '#/components/schemas/EncodeType', + 'example' => 'The upload ID of the multipart upload task after which the list operation starts. This parameter is used together with the key-marker parameter. '."\r\n" + .' - If the key-marker parameter is not specified, OSS ignores the upload-id-marker parameter. '."\r\n" + .' - If the key-marker parameter is specified, the query result includes the following tasks:'."\r\n" + .' - Multipart upload tasks in which object names are alphabetically after the value of the key-marker parameter. '."\r\n" + .' - Multipart upload tasks in which object names are the same as the value of the key-marker parameter but whose upload IDs are greater than the value of the upload-id-marker parameter.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'ListMultipartUploadsResult' => [ + 'description' => 'The container that stores the response to the ListMultipartUpload request.', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'EncodingType' => [ + 'description' => 'The method used to encode the object name in the response. If encoding-type is specified in the request, values of those elements including Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key are encoded in the returned result.', + 'type' => 'string', + 'example' => 'url', + ], + 'KeyMarker' => [ + 'description' => 'The name of the object that corresponds to the multipart upload task after which the list begins.', + 'type' => 'string', + 'example' => 'abc', + ], + 'UploadIdMarker' => [ + 'description' => 'The upload ID of the multipart upload task after which the list begins.', + 'type' => 'string', + 'example' => '0004B999EF5A239BB9138C6227D6****', + ], + 'NextKeyMarker' => [ + 'description' => 'The object name marker in the response for the next request to return the remaining results.', + 'type' => 'string', + 'example' => 'oss.avi', + ], + 'NextUploadIdMarker' => [ + 'description' => 'The NextUploadMarker value that is used for the UploadMarker value in the next request if the response does not contain all required results.', + 'type' => 'string', + 'example' => '0004B99B8E707874FC2D692FA5D77D3F', + ], + 'MaxUploads' => [ + 'description' => 'The maximum number of multipart upload tasks returned by OSS.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'IsTruncated' => [ + 'description' => 'Indicates whether the list of multipart upload tasks returned in the response is truncated. Default value: false. Valid values:'."\n" + ."\n" + .'- true: Only part of the results are returned this time.'."\n" + ."\n" + .'- false: All results are returned.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Prefix' => [ + 'description' => 'The prefix that the returned object names must contain. If you specify a prefix in the request, the specified prefix is included in the response.', + 'type' => 'string', + 'example' => 'logs/', + ], + 'Delimiter' => [ + 'description' => 'The character used to group objects by name. If you specify the Delimiter parameter in the request, the response contains the CommonPrefixes element. Objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in', + 'type' => 'string', + 'example' => '/', + ], + 'Upload' => [ + 'description' => 'The ID list of the multipart upload tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the multipart upload task.', + '$ref' => '#/components/schemas/Upload', + ], + ], + 'CommonPrefixes' => [ + 'description' => 'If the delimiter parameter is specified in the request, the response contains the CommonPrefixes parameter. The objects whose names contain the same string from the prefix to the next occurrence of the delimiter are grouped as a single result element in the CommonPrefixes parameter.', + 'type' => 'array', + 'items' => [ + 'description' => 'The iterm of common prefixes.', + '$ref' => '#/components/schemas/CommonPrefix', + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListMultipartUploadsResult>\\n <Bucket>example-bucket</Bucket>\\n <EncodingType>url</EncodingType>\\n <KeyMarker>abc</KeyMarker>\\n <UploadIdMarker>0004B999EF5A239BB9138C6227D6****</UploadIdMarker>\\n <NextKeyMarker>oss.avi</NextKeyMarker>\\n <NextUploadIdMarker>0004B99B8E707874FC2D692FA5D77D3F</NextUploadIdMarker>\\n <MaxUploads>20</MaxUploads>\\n <IsTruncated>true</IsTruncated>\\n <Prefix>logs/</Prefix>\\n <Delimiter>/</Delimiter>\\n <Upload>\\n <Key/>\\n <UploadId/>\\n <Initiated/>\\n </Upload>\\n <CommonPrefixes>\\n <Prefix/>\\n </CommonPrefixes>\\n</ListMultipartUploadsResult>","type":"xml"}]', + 'title' => 'List ongoing multipart upload tasks', + 'description' => 'You can call the ListMultipartUploads operation to list all ongoing multipart upload tasks, which include tasks that have been initiated but are not completed or canceled.', + ], + 'ListParts' => [ + 'summary' => 'You can call this operation to list all parts that are uploaded by using a specified upload ID.', + 'path' => '/{key}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'uploadId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the multipart upload task.'."\n" + ."\n" + .'By default, this parameter is left empty.', + 'type' => 'string', + 'required' => true, + 'example' => '0004B999EF5A239BB9138C6227D69F95', + ], + ], + [ + 'name' => 'max-parts', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of parts that can be returned by OSS.'."\n" + ."\n" + .'Default value: 1000.'."\n" + ."\n" + .'Maximum value: 1000.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'part-number-marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The position from which the list starts. All parts whose part numbers are greater than the value of this parameter are listed.'."\n" + ."\n" + .'By default, this parameter is left empty.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'encoding-type', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The maximum number of parts that can be returned by OSS. '."\n" + ."\n" + .'Default value: 1000.'."\n" + ."\n" + .'Maximum value: 1000.', + 'required' => false, + '$ref' => '#/components/schemas/EncodeType', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'ListPartResult' => [ + 'description' => 'The container that stores the response of the ListParts request.', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'example' => 'example-bucket', + ], + 'Key' => [ + 'description' => 'The name of the object.', + 'type' => 'string', + 'example' => 'multipart.data', + ], + 'UploadId' => [ + 'description' => 'The ID of the upload task.', + 'type' => 'string', + 'example' => '0004B999EF5A239BB9138C6227D69F95', + ], + 'PartNumberMarker' => [ + 'description' => 'The position from which the list starts. All parts whose part numbers are greater than the value of this parameter are listed.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NextPartNumberMarker' => [ + 'description' => 'The NextPartNumberMarker value that is used for the PartNumberMarker value in a subsequent request when the response does not contain all required results.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'MaxParts' => [ + 'description' => 'The maximum number of parts in the response.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'IsTruncated' => [ + 'description' => 'Indicates whether the list of parts returned in the response has been truncated. A value of true indicates that the response does not contain all required results. A value of false indicates that the response contains all required results.'."\n" + ."\n" + .'Valid values: true and false.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Part' => [ + 'description' => 'The list of all parts.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the information about parts.', + '$ref' => '#/components/schemas/Part', + ], + ], + ], + ], + ], + ], + ], + '5xx' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListPartResult>\\n <Bucket>example-bucket</Bucket>\\n <Key>multipart.data</Key>\\n <UploadId>0004B999EF5A239BB9138C6227D69F95</UploadId>\\n <PartNumberMarker>10</PartNumberMarker>\\n <NextPartNumberMarker>5</NextPartNumberMarker>\\n <MaxParts>20</MaxParts>\\n <IsTruncated>true</IsTruncated>\\n <Part>\\n <ETag/>\\n <PartNumber>0</PartNumber>\\n <Size>0</Size>\\n <LastModified/>\\n </Part>\\n</ListPartResult>","type":"xml"}]', + 'title' => 'Lists all uploaded parts', + 'description' => '- The results returned by OSS are listed in ascending order of their part numbers.'."\n" + .'- Errors may occur during network transmission. Therefore, to generate the list of uploaded parts, we recommend that you do not use the results (part numbers and ETag values) of ListParts.'."\n", + ], + 'PutObjectAcl' => [ + 'summary' => 'You can call this operation to modify the ACL of an object.', + 'path' => '/{key}?acl', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'x-oss-object-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The access control list (ACL) of the object.', + 'required' => true, + '$ref' => '#/components/schemas/ObjectACL', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version id of the object.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQMhiBgIC3rpSD0BYiIDBjYTk5MmIzN2JlNjQxZTFiNGIzM2E3OTliODA0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-version-id' => [ + 'schema' => [ + 'title' => 'The version of a object', + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Modify the ACL of an object', + 'description' => '**Usage notes**'."\n" + .'<br>Only the owner of the bucket who has permissions to read and write objects in the bucket can call this operation to modify object ACLs. '."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'By default, when you call the PutObjectACL operation, you can only configure the access control list (ACL) of the current version of an object. You can specify a version ID in the request to configure the ACL of the specified version of the object. If the specified version is a delete marker, OSS returns 404 Not Found. '."\n" + ."\n" + .'**ACL description**'."\n" + .'<br>When you call the PutObjectACL operation, you can configure the ACL of an object by setting the `x-oss-object-acl` header in a PUT request. You can configure the following ACLs for a bucket: '."\n" + .'- private: The ACL of the object is private. Only the owner of this object has permissions to read and write this object. Other users cannot access the object. '."\n" + .'- public-read: The ACL of the object is public-read. Only the owner of this object has the permissions to read and write this object. Other users can only read the object. - public-read-write: The ACL of the object is public-read-write. All users have permissions to read and write this object. - default: The ACL of the object is the same as that of the bucket in which the object is stored. '."\n" + ."\n" + .'>- The ACL of an object takes precedence over the ACL of the bucket in which the object is stored. For example, if an object whose ACL is public-read-write is stored in a bucket whose ACL is private, all users can read and write the object. By default, if you do not configure the ACL of an object, the ACL of the object is the same as that of the bucket in which the object is stored. '."\n" + .'- Operations that read objects include GetObject, HeadObject, CopyObject, and UploadPartCopy, in which CopyObject and UploadPartCopy read the source object. Operations that write objects include PutObject, PostObject, AppendObject, DeleteObject, DeleteMultipleObjects, CompleteMultipartUpload, and CopyObject, in which CopyObject writes the destination object. '."\n" + .'- When you call operations to write an object, you can also include the x-oss-object-acl header in a request to configure the ACL of the object. For example, you can include the x-oss-object-acl header in a PutObject request to configure the ACL of the object that you want to upload.', + ], + 'GetObjectAcl' => [ + 'summary' => 'You can call this operation to query the ACL of an object in a bucket.', + 'path' => '/{key}?acl', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'The version of a object', + 'description' => 'The verison id of the target object.', + 'type' => 'string', + 'required' => false, + 'example' => 'list1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'AccessControlPolicy' => [ + 'description' => 'The container that stores the results of the GetObjectACL request.', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The container that stores the information about the bucket owner.', + '$ref' => '#/components/schemas/Owner', + ], + 'AccessControlList' => [ + 'description' => 'The container that stores the ACL information.', + 'type' => 'object', + 'properties' => [ + 'Grant' => [ + 'description' => 'The ACL of the object. Default value: default.', + '$ref' => '#/components/schemas/ObjectACL', + ], + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<AccessControlPolicy>\\n <Owner>\\n <ID/>\\n <DisplayName/>\\n </Owner>\\n <AccessControlList/>\\n</AccessControlPolicy>","type":"xml"}]', + 'title' => 'Query the ACL of an object', + 'description' => '**Versioning**'."\n" + ."\n" + .'By default, when you call GetObjectACL to query the ACL of an object, only the ACL of the current version of the object is returned. You can specify the versionId parameter in the request to query the ACL of a specified version of an object. If the specified version is a delete marker, OSS returns 404 Not Found.'."\n" + ."\n" + .'> If a GetObjectACL request is sent to query the ACL of an object for which ACL is not configured, OSS returns the default ACL for this object. In this case, the ACL of this object is the same as that of the bucket in which the object is stored. For example, if the ACL of the bucket in which the object is stored is private, the ACL of the object is also private. ', + ], + 'PutSymlink' => [ + 'summary' => 'You can create a symbolic link for a target object.', + 'path' => '/{key}?symlink', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'x-oss-symlink-target', + 'in' => 'header', + 'schema' => [ + 'description' => 'The target object to which the symbolic link points. '."\r\n" + .'The naming conventions for target objects are the same as those for objects.'."\r\n" + .' - Similar to ObjectName, TargetObjectName must be URL-encoded. '."\r\n" + .' - The target object to which a symbolic link points cannot be a symbolic link.', + 'type' => 'string', + 'required' => true, + 'example' => 'oss.jpg', + ], + ], + [ + 'name' => 'x-oss-object-acl', + 'in' => 'header', + 'schema' => [ + 'description' => 'The access control list (ACL) of the object. Default value: default. '."\r\n" + .'Valid values:'."\r\n" + ."\r\n" + .'- default: The ACL of the object is the same as that of the bucket in which the object is stored. '."\r\n" + .'- private: The ACL of the object is private. Only the owner of the object and authorized users can read and write this object. '."\r\n" + .'- public-read: The ACL of the object is public-read. Only the owner of the object and authorized users can read and write this object. Other users can only read the object. Exercise caution when you set the object ACL to this value. '."\r\n" + .'- public-read-write: The ACL of the object is public-read-write. All users can read and write this object. Exercise caution when you set the object ACL to this value. '."\r\n" + ."\r\n" + .'For more information about the ACL, see **[ACL](~~100676~~)**.', + 'required' => false, + '$ref' => '#/components/schemas/ObjectACL', + ], + ], + [ + 'name' => 'x-oss-storage-class', + 'in' => 'header', + 'schema' => [ + 'description' => 'The storage class of the bucket. Default value: Standard. Valid values:'."\r\n" + ."\r\n" + .'- Standard'."\r\n" + .'- IA'."\r\n" + .'- Archive'."\r\n" + .'- ColdArchive', + 'required' => false, + '$ref' => '#/components/schemas/StorageClass', + ], + ], + [ + 'name' => 'x-oss-forbid-overwrite', + 'in' => 'header', + 'schema' => [ + 'description' => 'Specifies whether the PutSymlink operation overwrites the object that has the same name as that of the symbolic link you want to create. '."\n" + .' - If the value of **x-oss-forbid-overwrite** is not specified or set to **false**, existing objects can be overwritten by objects that have the same names. '."\n" + .' - If the value of **x-oss-forbid-overwrite** is set to **true**, existing objects cannot be overwritten by objects that have the same names. '."\n" + ."\n" + .'If you specify the **x-oss-forbid-overwrite** request header, the queries per second (QPS) performance of OSS is degraded. If you want to use the **x-oss-forbid-overwrite** request header to perform a large number of operations (QPS greater than 1,000), contact technical support. '."\n" + .'> The **x-oss-forbid-overwrite** request header is invalid when versioning is enabled or suspended for the destination bucket. In this case, the object with the same name can be overwritten.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Create a symbolic link for an OSS object', + 'description' => '**Usage notes**'."\n" + ."\n" + .'* When you use the PutSymlink operation to create a symbolic link, OSS does not check whether the target object exists, whether the storage class of the target object is valid, or whether you can access the target object.'."\n" + .'* The ACL of a symbolic link and the ACL of the target object to which the symbolic link points are checked when API operations such as GetObject are called to access the target object.'."\n" + .'* If a PutSymlink request contains a parameter whose name is prefixed with x-oss-meta-, the parameter is considered the user metadata of the symbolic link. Example: x-oss-meta-location. An object can have multiple similar parameters. However, the total size of all user metadata of the object cannot exceed 8 KB.'."\n" + .'* By default, if the object that you want to create already exists and you have permissions to access the existing object, the new object overwrites the existing object, and OSS returns 200 OK.'."\n" + ."\n" + .'**Versioning**'."\n" + ."\n" + .'You can create a symbolic link for a target object and point the symbolic link to the current version of the target object. '."\r\n" + .'A symbolic link can have multiple versions. You can use the PutSymlink operation to point each version of a symbolic link to different target objects. In this case, the IDs of the versions are generated by OSS and are returned in the response as the x-oss-version-id header.', + ], + 'GetSymlink' => [ + 'summary' => 'You can call this operation to query a symbolic link of an object.', + 'path' => '/{key}?symlink', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the object to which the symbolic link points.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-symlink-target' => [ + 'schema' => [ + 'sdkPropertyName' => 'symlinkTargetKey', + 'type' => 'string', + ], + ], + 'x-oss-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Query a symbolic link', + 'description' => '**Versioning**'."\n" + ."\n" + .'By default, GetSymlink queries the current version of the symbolic link. You can specify the version ID in the request to obtain the specified version of a symbolic link. If the specified version of the target symbolic link is a delete marker, OSS returns the 404 Not Found error and includes oss-delete-marker = true and x-oss-version-id in the response header. A delete marker does not contain any data. Therefore, the information about the object to which the symbol link points is not included in the response.', + ], + 'PutObjectTagging' => [ + 'summary' => 'You can call this operation to add tags to or modify the tags of an object.', + 'path' => '/{key}?tagging', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject.txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version id of the target object.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'Tagging' => [ + 'description' => 'The container of the tag set.', + 'required' => false, + '$ref' => '#/components/schemas/Tagging', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-oss-version-id' => [ + 'schema' => [ + 'type' => 'string', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Set or update tags for an object', + 'description' => '**Usage notes**'."\n" + .'- The object tagging feature uses a key-value pair to tag an object. '."\n" + .'- You can add up to 10 tags to an object. The tags added to an object must have unique tag keys. '."\n" + .'- A tag key can be up to 128 characters in length. A tag value can be up to 256 characters in length. '."\n" + .'- Tag keys and tag values are case-sensitive. '."\n" + .'- The valid character set of a tag includes letters, digits, spaces, and the following special characters: +-=.\\_:/. If you set the tag by using HTTP headers and the tag contains one of the characters, you must encode the key and value of the tag by using URLs. '."\n" + .'- The Last-Modified value of an object is not updated when you change the object tags. '."\n" + .'<br>For more information about the object tagging feature, see [Object tagging](~~106678~~). '."\n" + ."\n" + .'**Versioning**'."\n" + .'<br>By default, when you call the PutObjectTagging operation, tags are added to the current version of the object, or tags configured for the current version of the object are updated. You can specify a version ID in the request to add tags to the specified version of an object or update tags configured for the specified version of an object. If the specified version is a delete marker, OSS returns 404 Not Found.', + ], + 'GetObjectTagging' => [ + 'summary' => 'You can call this operation to query the tags of an object.', + 'path' => '/{key}?tagging', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The versionID of the object that you want to query.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'Tagging' => [ + 'description' => 'The container that stores the returned tag of the bucket.', + 'type' => 'object', + 'properties' => [ + 'TagSet' => [ + 'description' => 'The tag set of the target object.', + '$ref' => '#/components/schemas/TagSet', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<Tagging>\\n <TagSet>\\n <Tag>\\n <Key/>\\n <Value/>\\n </Tag>\\n </TagSet>\\n</Tagging>","type":"xml"}]', + 'title' => 'Query the tags of an object', + 'description' => '**Versioning**'."\n" + ."\n" + .'By default, when you call GetObjectTagging to query the tags of an object, only the tags of the current version of the object are returned. You can specify the versionId parameter in the request to query the tags of a specified version of an object. If the specified version is a delete marker, OSS returns 404 Not Found.', + ], + 'DeleteObjectTagging' => [ + 'summary' => 'You can call this operation to delete the tags of a specified object.', + 'path' => '/{key}?tagging', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The full path of the object.', + 'type' => 'string', + 'required' => true, + 'example' => 'exampledir/exampleobject/txt', + ], + ], + [ + 'name' => 'versionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version ID of the object that you want to delete.', + 'type' => 'string', + 'required' => false, + 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Delete the tags configured for an object', + 'description' => '**Versioning**'."\n" + ."\n" + .'By default, when you call the DeleteObjectTagging operation to delete the tags configured for an object, the tags of the current version of the object are deleted. You can specify the versionId parameter in the request to delete the tags of a specified version of an object. If the specified version is a delete marker, OSS returns 404 Not Found.', + ], + 'PutLiveChannel' => [ + 'summary' => 'You can call this operation to create a LiveChannel. Before you can upload audio and video data by using the Real-Time Messaging Protocol (RTMP), you must call the PutLiveChannel operation to create a LiveChannel.', + 'path' => '/{channel}?live', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the LiveChannel. The name cannot contain forward slashes (/).', + 'type' => 'string', + 'required' => true, + 'example' => 'ChannelName', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'The request body schema.', + 'type' => 'object', + 'properties' => [ + 'LiveChannelConfiguration' => [ + 'description' => 'The container that stores the configurations of the LiveChannel.', + 'required' => false, + '$ref' => '#/components/schemas/LiveChannelConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The respones body schema.', + 'type' => 'object', + 'properties' => [ + 'CreateLiveChannelResult' => [ + 'description' => 'The container that stores the result of the CreateLiveChannel request.', + 'type' => 'object', + 'properties' => [ + 'PublishUrls' => [ + 'description' => '保存推流地址的容器。', + '$ref' => '#/components/schemas/LiveChannelPublishUrls', + ], + 'PlayUrls' => [ + 'description' => '保存播放地址的容器。', + '$ref' => '#/components/schemas/LiveChannelPlayUrls', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<CreateLiveChannelResult>\\n <PublishUrls>\\n <Url/>\\n </PublishUrls>\\n <PlayUrls>\\n <Url/>\\n </PlayUrls>\\n</CreateLiveChannelResult>","type":"xml"}]', + 'title' => 'Create a LiveChannel', + ], + 'ListLiveChannel' => [ + 'summary' => 'You can call this operation to list specified LiveChannels.', + 'path' => '/?live', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'marker', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the LiveChannel from which the list operation starts. LiveChannels whose names are alphabetically after the value of the marker parameter are returned.', + 'type' => 'string', + 'required' => false, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'max-keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of LiveChannels that can be returned for the current request. The value of max-keys cannot exceed 1000. '."\r\n" + .'Default value: 100.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'prefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix that the names of the LiveChannels that you want to return must contain. If you specify a prefix in the request, the specified prefix is included in the response.', + 'type' => 'string', + 'required' => false, + 'example' => 'fun/', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'ListLiveChannelResult' => [ + 'description' => 'The container that stores the results of the ListLiveChannel request.', + 'type' => 'object', + 'properties' => [ + 'Prefix' => [ + 'description' => 'The prefix that the names of the returned LiveChannels contain.', + 'type' => 'string', + 'example' => 'Channel', + ], + 'Marker' => [ + 'description' => 'The name of the LiveChannel after which the ListLiveChannel operation starts.', + 'type' => 'string', + 'example' => 'new', + ], + 'MaxKeys' => [ + 'description' => 'The maximum number of returned LiveChannels in the response.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'IsTruncated' => [ + 'description' => 'Indicates whether all results are returned.'."\n" + .'- true: All results are returned.'."\n" + .'- false: Not all results are returned.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NextMarker' => [ + 'description' => 'If not all results are returned, the NextMarker parameter is included in the response to indicate the Marker value of the next request.', + 'type' => 'string', + 'example' => 'channel-0', + ], + 'LiveChannel' => [ + 'description' => 'The container that stores the information about each returned LiveChannel.', + 'type' => 'array', + 'items' => [ + 'description' => 'The container that stores the information about a LiveChannel.', + '$ref' => '#/components/schemas/LiveChannel', + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ListLiveChannelResult>\\n <Prefix>Channel</Prefix>\\n <Marker>new</Marker>\\n <MaxKeys>20</MaxKeys>\\n <IsTruncated>true</IsTruncated>\\n <NextMarker>channel-0</NextMarker>\\n <LiveChannel>\\n <Name/>\\n <Description/>\\n <Status/>\\n <LastModified/>\\n <PublishUrls>\\n <Url/>\\n </PublishUrls>\\n <PlayUrls>\\n <Url/>\\n </PlayUrls>\\n </LiveChannel>\\n</ListLiveChannelResult>","type":"xml"}]', + 'title' => 'List specified LiveChannels', + ], + 'DeleteLiveChannel' => [ + 'summary' => 'You can call this operation to delete a specified LiveChannel.', + 'path' => '/{channel}?live', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of an existing LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplechannel', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Delete a specified LiveChannel', + 'description' => '- If you send a DeleteLiveChannel request to delete a LiveChannel to which a client is ingesting streams, the request fails.'."\n" + .'- When you call this operation to delete a LiveChannel, only the LiveChannel is deleted. Files generated during stream ingestion are not deleted.', + ], + 'PutLiveChannelStatus' => [ + 'summary' => 'You can call this operation to switch the status of a LiveChannel. A LiveChannel can be in one of the following states: enabled or disabled.', + 'path' => '/{channel}?live', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of an existing LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'exmplechannel', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the LiveChannel. '."\r\n" + .'Valid values:'."\r\n" + .'- enabled: enables the LiveChannel.'."\r\n" + .'- disabled: disables the LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'enabled', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Switch the status of a LiveChannel', + 'description' => '- If a LiveChannel is in the disabled state, OSS prohibits you from ingesting streams to the LiveChannel. If you are ingesting a stream to a LiveChannel whose state becomes disabled, your client is disconnected from the LiveChannel after approximately 10 seconds.'."\n" + .'- When no stream is ingested to a LiveChannel, you can also re-create the LiveChannel by calling PutLiveChannelStatus to change the status of the LiveChannel.'."\n" + .'- When a stream is being ingested to a LiveChannel, you can only call'."\n" + .' PutLiveChannelStatus to set the LiveChannel to the disabled state.', + ], + 'GetLiveChannelInfo' => [ + 'summary' => 'You can call this operation to query the configuration information about a LiveChannel.', + 'path' => '/{channel}?live', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'exsmplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the LiveChannel about which you want to query configuration information. The name cannot contain forward slashes (/).', + 'type' => 'string', + 'required' => true, + 'example' => 'channel_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'LiveChannelConfiguration' => [ + 'description' => 'The container that stores the returned results of the GetLiveChannelInfo request.', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The description of the LiveChannel.', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status of the LiveChannel.'."\n" + ."\n" + .'Valid values:'."\n" + .'- enabled: indicates that the LiveChannel is enabled.'."\n" + .'- disabled: indicates that the LiveChannel is disabled.', + 'type' => 'string', + 'example' => 'enabled', + ], + 'Target' => [ + 'description' => 'The container that stores the configurations used by the LiveChannel to store uploaded data.'."\n" + .'> FragDuration, FragCount, and PlaylistName are returned only when the value of Type is HLS.', + '$ref' => '#/components/schemas/LiveChannelTarget', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<LiveChannelConfiguration>\\n <Description>test</Description>\\n <Status>enabled</Status>\\n <Target>\\n <Type/>\\n <FragDuration>0</FragDuration>\\n <FragCount>0</FragCount>\\n <PlaylistName/>\\n </Target>\\n</LiveChannelConfiguration>","type":"xml"}]', + 'title' => 'Query the configuration information about a LiveChannel', + ], + 'GetLiveChannelHistory' => [ + 'summary' => 'You can call this operation to query the stream ingestion records of a LiveChannel.', + 'path' => '/{channel}?live&comp=history', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplechannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'LiveChannelHistory' => [ + 'description' => 'The container that stores the returned results of the GetLiveChannelHistory request.', + 'type' => 'object', + 'properties' => [ + 'LiveRecord' => [ + 'description' => 'The container that stores a list of stream pushing records.', + 'type' => 'array', + 'items' => [ + 'description' => 'Specifies the container that stores a stream pushing record.', + '$ref' => '#/components/schemas/LiveRecord', + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<LiveChannelHistory>\\n <LiveRecord>\\n <StartTime/>\\n <EndTime/>\\n <RemoteAddr/>\\n </LiveRecord>\\n</LiveChannelHistory>","type":"xml"}]', + 'title' => 'Query the stream ingestion records of a LiveChannel', + 'description' => 'You can call the GetLiveChannelHistory operation to query up to the 10 most recent stream ingestion records of the specified LiveChannel.', + ], + 'GetLiveChannelStat' => [ + 'summary' => 'You can call this operation to query the stream ingestion status of a LiveChannel.', + 'path' => '/{channel}?live&comp=stat', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplechannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response body schema.', + 'type' => 'object', + 'properties' => [ + 'LiveChannelStat' => [ + 'description' => 'The container that stores the returned results of the GetLiveChannelStat request.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The current stream ingestion status of the LiveChannel. Valid value: Disabled、Live、Idle。', + 'type' => 'string', + 'example' => 'Live', + ], + 'ConnectedTime' => [ + 'description' => 'If Status is set to Live, this element indicates the time when the current client starts to ingest streams. The value of the element is in the ISO 8601 format.', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2016-08-25T06:25:15.000Z', + ], + 'RemoteAddr' => [ + 'description' => 'If Status is set to Live, this element indicates the IP address of the current client that ingests streams.', + 'type' => 'string', + 'example' => '10.1.2.3:47745', + ], + 'Video' => [ + 'description' => 'The container that stores video stream information if Status is set to Live.'."\n" + ."\n" + .'>Video and audio containers can be returned only if Status is set to Live. However, these two containers may not necessarily be returned if Status is set to Live. For example, if the client has connected to the LiveChannel but no audio or video stream is sent, these two containers are not returned.', + '$ref' => '#/components/schemas/LiveChannelVideo', + ], + 'Audio' => [ + 'description' => 'The container that stores audio stream information if Status is set to Live.'."\n" + .'>Video and audio containers can be returned only if Status is set to Live. However, these two containers may not necessarily be returned if Status is set to Live. For example, if the client has connected to the LiveChannel but no audio or video stream is sent, these two containers are not returned.', + '$ref' => '#/components/schemas/LiveChannelAudio', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<LiveChannelStat>\\n <Status>Live</Status>\\n <ConnectedTime>2016-08-25T06:25:15.000Z</ConnectedTime>\\n <RemoteAddr>10.1.2.3:47745</RemoteAddr>\\n <Video>\\n <Width>0</Width>\\n <Height>0</Height>\\n <FrameRate>0</FrameRate>\\n <Bandwidth>0</Bandwidth>\\n <Codec/>\\n </Video>\\n <Audio>\\n <Bandwidth>0</Bandwidth>\\n <SampleRate>0</SampleRate>\\n <Codec/>\\n </Audio>\\n</LiveChannelStat>","type":"xml"}]', + 'title' => 'Query the stream ingestion status of a LiveChannel', + ], + 'GetVodPlaylist' => [ + 'summary' => 'You can call this operation to query the playlist that is generated by the streams ingested to the specified LiveChannel within the specified time range.', + 'path' => '/{channel}?vod', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of an existing LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplechannel', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the time range during which the TS files that you want to query are generated in the Unix timestamp format. '."\n" + .'> The value of EndTime must be greater than the value of StartTime. The duration between EndTime and StartTime must be less than one day.', + 'type' => 'string', + 'required' => true, + 'example' => '1636618271', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the time range during which the TS files that you want to query are generated in the Unix timestamp format.', + 'type' => 'string', + 'required' => true, + 'example' => '1636600271', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'An m3u8 playlist that contains the ts files that are generated by the streams ingested to the specified LiveChannel within the specified time period.', + 'type' => 'string', + 'format' => 'binary', + 'example' => '#EXTM3U'."\n" + .'#EXT-X-VERSION:3'."\n" + .'#EXT-X-MEDIA-SEQUENCE:0'."\n" + .'#EXT-X-TARGETDURATION:13'."\n" + .'#EXTINF:7.120,'."\n" + .'1543895706266.ts'."\n" + .'#EXTINF:5.840,'."\n" + .'1543895706323.ts'."\n" + .'#EXTINF:6.400,'."\n" + .'1543895706356.ts'."\n" + .'#EXTINF:5.520,'."\n" + .'1543895706389.ts'."\n" + .'#EXTINF:5.240,'."\n" + .'1543895706428.ts'."\n" + .'#EXTINF:13.320,'."\n" + .'1543895706468.ts'."\n" + .'#EXTINF:5.960,'."\n" + .'1543895706538.ts'."\n" + .'#EXTINF:6.520,'."\n" + .'1543895706561.ts'."\n" + .'#EXT-X-ENDLIST', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"#EXTM3U\\\\n#EXT-X-VERSION:3\\\\n#EXT-X-MEDIA-SEQUENCE:0\\\\n#EXT-X-TARGETDURATION:13\\\\n#EXTINF:7.120,\\\\n1543895706266.ts\\\\n#EXTINF:5.840,\\\\n1543895706323.ts\\\\n#EXTINF:6.400,\\\\n1543895706356.ts\\\\n#EXTINF:5.520,\\\\n1543895706389.ts\\\\n#EXTINF:5.240,\\\\n1543895706428.ts\\\\n#EXTINF:13.320,\\\\n1543895706468.ts\\\\n#EXTINF:5.960,\\\\n1543895706538.ts\\\\n#EXTINF:6.520,\\\\n1543895706561.ts\\\\n#EXT-X-ENDLIST\\"","type":"json"}]', + 'title' => 'Query the playlist that is generated by the streams ingested to the specified LiveChannel', + ], + 'PostVodPlaylist' => [ + 'summary' => 'You can call this operation to generate a VOD playlist for the specified LiveChannel.', + 'path' => '/{channel}/{playlist}?vod', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'description' => 'The name of the bucket.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplebucket', + ], + ], + [ + 'name' => 'channel', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of an existing LiveChannel.', + 'type' => 'string', + 'required' => true, + 'example' => 'examplechannel', + ], + ], + [ + 'name' => 'playlist', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the generated VOD playlist, which must end with ".m3u8".', + 'type' => 'string', + 'required' => true, + 'example' => 'playlist.m3u8', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the time range during which the TS files that you want to query are generated, '."\n" + .'which is a Unix timestamp.'."\n" + .'> The value of EndTime must be later than the value of StartTime. The duration between EndTime and StartTime must be shorter than one day.', + 'type' => 'string', + 'required' => true, + 'example' => '1636618271', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the time range during which the TS files that you want to query are generated, which is a Unix timestamp.', + 'type' => 'string', + 'required' => true, + 'example' => '1636600271', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Generate a VOD playlist for live stream ingest', + ], + 'PutChannel' => [ + 'summary' => 'Create and Modify Image Processing Channel', + 'path' => '/?img', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253195', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'Channel' => [ + 'title' => '保存图片处理频道配置的容器', + 'description' => 'Container for storing image processing channel configuration', + 'required' => false, + '$ref' => '#/components/schemas/Channel', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Create Image Processing Channel', + 'translator' => 'machine', + ], + 'PutBucketHash' => [ + 'summary' => 'Modify Object Hash Algorithm Configuration for a bucket.', + 'path' => '/?objectHash', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245781', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket Name', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体', + 'description' => 'Request Body', + 'type' => 'object', + 'properties' => [ + 'ObjectHashConfiguration' => [ + 'title' => '对象哈希算法配置', + 'description' => 'Object Hash Algorithm Configuration', + 'required' => false, + '$ref' => '#/components/schemas/ObjectHashConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Modify Bucket Hash Algorithm Configuration', + 'translator' => 'machine', + ], + 'PutBucketCommonHeader' => [ + 'summary' => 'Set User-Defined Response Headers Configuration for a Bucket', + 'path' => '/?x-oss-common-header', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245749', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体', + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'CommonHeaders' => [ + 'title' => '用户自定义响应头配置', + 'description' => 'User-defined response headers configuration', + 'required' => false, + '$ref' => '#/components/schemas/CommonHeaders', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Set User-Defined Response Headers Configuration for a Bucket', + 'translator' => 'machine', + ], + 'DeleteBucketCommonHeader' => [ + 'summary' => '删除存储空间的用户自定义响应头配置', + 'path' => '/?x-oss-common-header', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245751', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'DeleteBucketCommonHeader', + ], + 'PutProcessConfiguration' => [ + 'summary' => 'Modify bucket Image Processing Configuration', + 'path' => '/?processConfiguration', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253281', + 'abilityTreeNodes' => [ + 'FEATUREossEPZCYR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Bucket Name', + 'type' => 'string', + 'required' => true, + 'example' => 'test-bucket', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'description' => 'Request Body', + 'type' => 'object', + 'properties' => [ + 'BucketProcessConfiguration' => [ + 'title' => '存储空间图片处理配置', + 'description' => 'Bucket Image Processing Configuration', + 'required' => true, + '$ref' => '#/components/schemas/BucketProcessConfiguration', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]', + 'title' => 'Modify Bucket Media Processing Configuration', + 'translator' => 'machine', + ], + 'GetBucketEventNotification' => [ + 'summary' => 'Get Function Compute Service Notification Configuration for a Bucket.', + 'path' => '/?eventNotification', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246277', + 'abilityTreeNodes' => [ + 'FEATUREossAI8VDR', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'description' => 'Storage space name', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationConfiguration' => [ + 'title' => '存储空间函数计算服务配置', + 'description' => 'Function Compute service configuration for a bucket.', + '$ref' => '#/components/schemas/EventNotificationConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<NotificationConfiguration>\\n <FunctionComputeConfiguration>\\n <ID>1</ID>\\n <Event>ObjectCreated:PutObject</Event>\\n <Filter>\\n <Key>\\n <Prefix/>\\n <Suffix/>\\n </Key>\\n </Filter>\\n <Function>\\n <Arn/>\\n <AssumeRole/>\\n </Function>\\n </FunctionComputeConfiguration>\\n</NotificationConfiguration>","type":"xml"}]', + 'title' => 'Get Bucket Event Notification Configuration', + 'translator' => 'machine', + ], + 'PutDataLakeCachePrefetchJob' => [ + 'summary' => '配置OSS加速器异步预热规则', + 'path' => '/?x-oss-datalake-cache-prefetch-job', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246257', + 'abilityTreeNodes' => [ + 'FEATUREossRGUKNQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称'."\n", + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'x-oss-datalake-job-id', + 'in' => 'query', + 'schema' => [ + 'title' => '加速器预热任务ID', + 'type' => 'string', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'xml', + 'schema' => [ + 'title' => '接口请求体', + 'type' => 'object', + 'properties' => [ + 'CreateDataLakeCachePrefetchJob' => [ + 'title' => '加速器预热任务配置信息', + '$ref' => '#/components/schemas/CreateDataLakeCachePrefetchJob', + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'DataLakeCachePrefetchJobID' => [ + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '加速器异步预热任务ID', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + ], + 'StartDataLakeCachePrefetchJob' => [ + 'summary' => '启动OSS加速器异步预热任务', + 'path' => '/?x-oss-datalake-cache-prefetch-job&x-oss-datalake-job-start', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246318', + 'abilityTreeNodes' => [ + 'FEATUREossRGUKNQ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'x-oss-datalake-job-id', + 'in' => 'query', + 'schema' => [ + 'title' => '加速器异步预热配置ID', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => null, + ], + 'ListDataLakeStorageTransferJob' => [ + 'summary' => '列举数据湖元数据转换任务', + 'path' => '/?x-oss-datalake-storage-transfer-job', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/xml', + ], + 'produces' => [ + 'application/xml', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253259', + 'abilityTreeNodes' => [ + 'FEATUREoss05MSD2', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bucket', + 'in' => 'host', + 'schema' => [ + 'title' => '存储空间名称', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '接口响应内容', + 'type' => 'object', + 'properties' => [ + 'DataLakeStorageTransferJobs' => [ + '$ref' => '#/components/schemas/DataLakeStorageTransferJobs', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'oss-cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'oss-cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'oss-cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'oss-cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'oss-cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'oss-cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'oss-cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'oss-cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'oss-cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'oss-cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'oss-cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'oss-cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'oss-cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'oss-cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'oss-cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'oss-ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'oss-ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'oss-ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'oss-ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'oss-ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'oss-ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'oss-ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'oss-us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'oss-us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'oss-eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'oss-eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'oss-ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'oss-me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'oss-cn-hzjbp-b-console.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'oss-cn-shanghai-finance-1-internal.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'oss-cn-shenzhen-finance-1-internal.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'oss-ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'oss-cn-beijing-finance-1-internal.aliyuncs.com', + ], + ], +]; |