'1.0', 'info' => ['style' => 'ROA', 'product' => 'Oss', 'version' => '2019-05-17'], 'directories' => [ [ 'children' => ['ListBuckets'], 'type' => 'directory', 'title' => 'Service', ], [ 'children' => [ [ 'children' => ['GetBucketStat', 'PutBucket', 'DeleteBucket', 'ListObjects', 'ListObjectsV2', 'GetBucketInfo', 'GetBucketLocation'], 'type' => 'directory', 'title' => 'Basic operations', ], [ 'children' => ['ListAccessPoints', 'GetAccessPoint', 'GetAccessPointPolicy', 'DeleteAccessPointPolicy', 'PutAccessPointPolicy', 'DeleteAccessPoint', 'CreateAccessPoint'], 'type' => 'directory', 'title' => 'Access points', ], [ 'children' => ['InitiateBucketWorm', 'AbortBucketWorm', 'CompleteBucketWorm', 'ExtendBucketWorm', 'GetBucketWorm'], 'type' => 'directory', 'title' => 'Retention policy', ], [ 'children' => ['GetBucketObjectWormConfiguration', 'PutBucketObjectWormConfiguration', 'GetObjectRetention', 'PutObjectRetention', 'GetObjectLegalHold', 'PutObjectLegalHold'], 'type' => 'directory', 'title' => 'Object-level retention policy', ], [ 'children' => ['PutBucketAcl', 'GetBucketAcl'], 'type' => 'directory', 'title' => 'Permission control', ], [ 'children' => ['GetBucketLifecycle', 'DeleteBucketLifecycle'], 'type' => 'directory', 'title' => 'Lifecycle', ], [ 'children' => ['PutBucketTransferAcceleration', 'GetBucketTransferAcceleration'], 'type' => 'directory', 'title' => 'Transfer acceleration', ], [ 'children' => ['PutBucketVersioning', 'GetBucketVersioning', 'ListObjectVersions'], 'type' => 'directory', 'title' => 'Versioning', ], [ 'children' => ['PutBucketPolicy', 'GetBucketPolicy', 'DeleteBucketPolicy'], 'type' => 'directory', 'title' => 'Authorization policy', ], [ 'children' => ['PutBucketRtc', 'PutBucketReplication', 'GetBucketReplication', 'GetBucketReplicationLocation', 'GetBucketReplicationProgress', 'DeleteBucketReplication'], 'type' => 'directory', 'title' => 'Data replication', ], [ 'children' => ['PutBucketInventory', 'GetBucketInventory', 'ListBucketInventory', 'DeleteBucketInventory'], 'type' => 'directory', 'title' => 'Inventory', ], [ 'children' => ['PutBucketLogging', 'GetBucketLogging', 'DeleteBucketLogging'], 'type' => 'directory', 'title' => 'Log management', ], [ 'children' => ['GetBucketWebsite', 'PutBucketWebsite', 'DeleteBucketWebsite'], 'type' => 'directory', 'title' => 'Static website', ], [ 'children' => ['PutBucketReferer', 'GetBucketReferer'], 'type' => 'directory', 'title' => 'Hotlink protection', ], [ 'children' => ['PutBucketTags', 'GetBucketTags', 'DeleteBucketTags'], 'type' => 'directory', 'title' => 'Tags', ], [ 'children' => ['ListBucketDataRedundancyTransition', 'CreateBucketDataRedundancyTransition'], 'type' => 'directory', 'title' => 'Storage redundancy conversion', ], [ 'children' => ['PutBucketEncryption', 'GetBucketEncryption', 'DeleteBucketEncryption'], 'type' => 'directory', 'title' => 'Encryption', ], [ 'children' => ['PutBucketRequestPayment', 'GetBucketRequestPayment'], 'type' => 'directory', 'title' => 'Pay by requester', ], [ 'children' => ['PutBucketCors', 'GetBucketCors', 'DeleteBucketCors', 'OptionObject'], 'type' => 'directory', 'title' => 'Cross-resource sharing', ], [ 'children' => ['PutBucketAccessMonitor', 'GetBucketAccessMonitor'], 'type' => 'directory', 'title' => 'Access tracking', ], [ 'children' => ['GetMetaQueryStatus', 'CloseMetaQuery', 'DoMetaQuery', 'OpenMetaQuery'], 'type' => 'directory', 'title' => 'Data indexing', ], [ 'children' => ['UpdateUserAntiDDosInfo', 'UpdateBucketAntiDDosInfo', 'ListBucketAntiDDosInfo', 'InitUserAntiDDosInfo', 'InitBucketAntiDDosInfo', 'GetUserAntiDDosInfo'], 'type' => 'directory', 'title' => 'DDoS protection', ], [ 'children' => ['GetBucketResourceGroup', 'PutBucketResourceGroup'], 'type' => 'directory', 'title' => 'Resource group', ], [ 'children' => ['PutCname', 'ListCname', 'DeleteCname', 'GetCnameToken', 'CreateCnameToken'], 'type' => 'directory', 'title' => 'Custom domain name', ], [ 'children' => ['PutStyle', 'ListStyle', 'GetStyle', 'DeleteStyle'], 'type' => 'directory', 'title' => 'Image style', ], [ 'children' => ['GetBucketHttpsConfig', 'PutBucketHttpsConfig'], 'type' => 'directory', 'title' => 'Transport layer security (TLS)', ], [ 'children' => ['ListAccessPointsForObjectProcess'], 'type' => 'directory', 'title' => 'Object FC access point', ], [ 'children' => [ [ 'children' => ['GetPublicAccessBlock', 'PutPublicAccessBlock', 'DeletePublicAccessBlock'], 'type' => 'directory', 'title' => 'OSS global block public access', ], [ 'children' => ['PutAccessPointPublicAccessBlock'], 'type' => 'directory', 'title' => 'Access point-level block public access', ], ], 'type' => 'directory', 'title' => 'Block public access', ], ], 'type' => 'directory', 'title' => 'Bucket', ], [ 'children' => [ [ 'children' => ['PutObject', 'CopyObject', 'GetObject', 'AppendObject', 'SealAppendObject', 'DeleteObject', 'HeadObject', 'GetObjectMeta', 'RestoreObject', 'SelectObject', 'CreateSelectObjectMeta'], 'type' => 'directory', 'title' => 'Basic operations', ], [ 'children' => ['InitiateMultipartUpload', 'UploadPart', 'CompleteMultipartUpload', 'UploadPartCopy', 'AbortMultipartUpload', 'ListMultipartUploads', 'ListParts'], 'type' => 'directory', 'title' => 'Multipart upload', ], [ 'children' => ['PutObjectAcl', 'GetObjectAcl'], 'type' => 'directory', 'title' => 'Permission control', ], [ 'children' => ['PutSymlink', 'GetSymlink'], 'type' => 'directory', 'title' => 'Symbolic link', ], [ 'children' => ['PutObjectTagging', 'GetObjectTagging', 'DeleteObjectTagging'], 'type' => 'directory', 'title' => 'Tags', ], ], 'type' => 'directory', 'title' => 'Object', ], [ 'children' => ['PutLiveChannel', 'ListLiveChannel', 'DeleteLiveChannel', 'PutLiveChannelStatus', 'GetLiveChannelInfo', 'GetLiveChannelHistory', 'GetLiveChannelStat', 'GetVodPlaylist', 'PostVodPlaylist'], 'type' => 'directory', 'title' => 'Live streaming', ], [ 'children' => ['PutChannel', 'PutBucketHash', 'PutBucketCommonHeader', 'DeleteBucketCommonHeader', 'PutProcessConfiguration', 'GetBucketEventNotification', 'PutDataLakeCachePrefetchJob', 'StartDataLakeCachePrefetchJob', 'ListDataLakeStorageTransferJob', 'DescribeRegions', 'PostObject', 'PutBucketLifecycle'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'AcceleratePaths' => [ 'title' => '数据湖加速器加速路径集合', 'description' => '加速器加速路径集合', 'type' => 'object', 'properties' => [ 'DefaultCachePolicy' => ['title' => '默认缓存策略', 'type' => 'string', 'example' => 'sync-warmup'], 'Path' => [ 'title' => '保存缓存路径列表的容器', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['title' => '缓存路径', 'type' => 'string', 'example' => 'acc-path/'], 'CachePolicy' => ['title' => '缓存策略', 'type' => 'string', 'example' => 'sync-warmup'], ], ], ], ], ], 'AccessControlList' => [ 'title' => '', 'description' => 'The container that stores the access control list (ACL) information.', 'type' => 'object', 'properties' => [ 'Grant' => [ 'description' => 'The access control list (ACL) of the bucket.', 'enumValueTitles' => ['private' => 'private', 'public-read' => 'public-read', 'public-read-write' => 'public-read-write'], 'example' => 'public-read', '$ref' => '#/components/schemas/Grant', 'title' => '', ], ], 'example' => '', ], 'AccessControlPolicy' => [ 'title' => '', 'description' => 'The container that stores the result of the GetObjectACL operation.', 'type' => 'object', 'properties' => [ 'Owner' => ['description' => 'The container that stores the information about the bucket owner.', '$ref' => '#/components/schemas/Owner', 'title' => '', 'example' => ''], 'AccessControlList' => ['description' => 'The container that stores the ACL information.', '$ref' => '#/components/schemas/AccessControlList', 'title' => '', 'example' => ''], ], 'example' => '', ], 'AccessMonitorConfiguration' => [ 'title' => '', 'description' => 'The access tracking status configuration of the bucket.', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'The access tracking status of the bucket.', '$ref' => '#/components/schemas/AccessMonitorStatus', 'example' => ''], 'AllowCopy' => ['title' => '', 'type' => 'boolean', 'example' => 'true', 'description' => ''], ], 'example' => '', ], 'AccessMonitorStatus' => [ 'title' => '', 'description' => 'The access tracking status of the bucket. Valid values:'."\n" ."\n" .'- Enabled: enabled'."\n" .'- Disabled: disabled.', 'type' => 'string', 'example' => 'Enabled', 'enum' => ['Enabled', 'Disabled'], ], 'AccessPoint' => [ 'title' => '', 'description' => 'The container that stores the information about a single access point.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The name of the bucket for which the access point is configured.', 'type' => 'string', 'example' => 'oss-example'], 'AccessPointName' => ['title' => '', 'description' => 'The name of the access point.', '$ref' => '#/components/schemas/AccessPointName', 'example' => ''], 'Alias' => ['title' => '', 'description' => 'The alias of the access point.', '$ref' => '#/components/schemas/AccessPointAlias', 'example' => ''], 'NetworkOrigin' => ['description' => 'The network origin of the access point.', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', 'title' => '', 'example' => ''], 'VpcConfiguration' => ['description' => 'The container that stores the VPC network origin information.', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', 'title' => '', 'example' => ''], 'Status' => ['description' => 'The status of the access point.', '$ref' => '#/components/schemas/AccessPointStatus', 'title' => '', 'example' => ''], ], 'example' => '', ], 'AccessPointAlias' => ['title' => '', 'description' => 'The access point alias.', 'type' => 'string', 'example' => 'ap-01-45ee7945007a2f0bcb595f63e2215c****-ossalias'], 'AccessPointArn' => ['title' => '', 'description' => 'The access point ARN.', 'type' => 'string', 'example' => 'arn:acs:oss:ap-southeast-2:111933544165****:accesspoint/ap-01'], 'AccessPointName' => ['title' => '', 'description' => 'The access point name.', 'type' => 'string', 'example' => 'ap-01'], 'AccessPointNetworkOrigin' => ['title' => '', 'description' => 'The network source of the endpoint. Valid values:'."\n" .'- vpc: The endpoint can be accessed only through the specified VPC ID.'."\n" .'- internet: The endpoint can be accessed over both the Internet and internal network endpoints.', 'type' => 'string', 'example' => 'vpc'], 'AccessPointStatus' => ['title' => '', 'description' => 'The access point status. Valid values:'."\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.', 'type' => 'string', 'example' => 'enable'], 'AccessPointVpcConfiguration' => [ 'title' => '', 'description' => 'The container that stores VPC network source information.', 'type' => 'object', 'properties' => [ 'VpcId' => ['title' => '', 'description' => 'The VPC ID. This parameter is required only when NetworkOrigin is set to vpc.', 'type' => 'string', 'example' => 'vpc-t4nlw426y44rd3iq4****'], ], 'example' => '', ], 'ApplyServerSideEncryptionByDefault' => [ 'title' => '', 'description' => 'The container for the default server-side encryption method.', 'type' => 'object', 'properties' => [ 'SSEAlgorithm' => ['title' => '', 'description' => 'Sets the default server-side encryption method.'."\n" .'Valid values: KMS, AES256, SM4'."\n" .'Using the KMS key feature incurs a small amount of KMS key API call fees. For more information about fees, see **[KMS billing](~~52608~~)**.'."\n" .'When performing cross-region replication (CRR), if the destination bucket has default server-side encryption enabled and the replication rule is configured with ReplicaCMKID, the following two cases apply:'."\n" .' - If objects in the source bucket are not encrypted, the default encryption method of the destination bucket is used to encrypt the plaintext objects replicated from the source bucket.'."\n" .' - If objects in the source bucket are encrypted by using SSE-KMS or SSE-OSS, the destination bucket continues to use the original encryption method for these objects.'."\n" ."\n" .'For more information, see **[CRR combined with server-side encryption](~~177216~~)**.', 'type' => 'string', 'example' => 'AES256'], 'KMSMasterKeyID' => [ 'title' => '', 'description' => 'When SSEAlgorithm is set to KMS and a specified secret key encryption is used, you must enter KMSMasterKeyID. In other cases, this parameter must be left empty.', 'enumValueTitles' => [], 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], 'KMSDataEncryption' => [ 'title' => '', 'description' => 'Specifies the encryption algorithm for the object. If this parameter is not specified, the object is encrypted by using the AES256 encryption algorithm. This parameter is valid only when SSEAlgorithm is set to KMS.'."\n" .'Valid values: SM4.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'SM4', ], ], 'example' => '', ], 'ArchiveDirectReadConfiguration' => [ 'title' => '', 'description' => 'The container that stores the real-time access of Archive objects status.', 'type' => 'object', 'properties' => [ 'Enabled' => ['title' => '', 'description' => 'Specifies whether real-time access of Archive objects is enabled for the bucket. Valid values:'."\n" .'- true: Real-time access of Archive objects is enabled.'."\n" .'- false: Real-time access of Archive objects is disabled.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'AsyncFetchTaskConfiguration' => [ 'title' => '异步拉取任务配置', 'description' => '异步 Fetch 任务配置', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '源文件的url', 'type' => 'string', 'example' => 'www.test.com/abc.txt'], 'Object' => ['title' => '保存到OSS上的对象名称', 'type' => 'string', 'example' => 'abc.txt'], 'Host' => ['title' => '拉取请求到源站时的host头的内容', 'type' => 'string', 'example' => 'www.test.com'], 'ContentMD5' => ['title' => '指定校验源文件的 md5', 'type' => 'string', 'example' => 'v23MlMRM/EgJczOs2yHTcA=='], 'Callback' => ['title' => '指定拉取成功后回调到用户的应用服务器', 'type' => 'string', 'example' => 'eyJjYWxsYmFja1VybCI6Ind3dy5hYmMuY29tL2NhbGxiYWNrIiwiY2FsbGJhY2tCb2R5IjoiJHtldGFnfSJ9'], 'StorageClass' => ['title' => '指定拉取的文件要保存的存储类型', 'type' => 'string', 'example' => 'Standard'], 'IgnoreSameKey' => ['title' => '文件存在时是否忽略本次任务', 'type' => 'boolean', 'example' => 'True'], ], ], 'AsyncFetchTaskInfo' => [ 'title' => '异步拉取任务信息', 'description' => '异步 fetch 任务信息', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'abc'], 'State' => ['title' => '任务状态,可能的取值及意义如下 Running:任务执行中 Retry:文件拉取失败过并处于重试中 FetchSuccessCallbackFailed:文件拉取成功但是回调失败 Failed:文件拉取失败 Success:任务成功', 'type' => 'string', 'example' => 'Success'], 'ErrorMsg' => ['title' => '任务失败的原因', 'type' => 'string', 'example' => 'FileNotFound'], 'TaskInfo' => ['title' => '异步拉取任务的配置信息', '$ref' => '#/components/schemas/AsyncFetchTaskConfiguration'], ], ], 'AsyncFetchTaskResult' => [ 'title' => '异步 fetch 任务返回结果', 'description' => '异步 Fetch 任务返回结果', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '异步 fetch 任务 ID', 'type' => 'string', 'example' => 'abc'], ], ], 'Bucket' => [ 'title' => '', 'description' => 'The container that stores bucket information.', 'type' => 'object', 'properties' => [ 'CreationDate' => ['title' => '', 'description' => 'The time when the bucket was created. The value is in the `yyyy-mm-ddThh:mm:ss.timezone` format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2014-05-15T11:18:32.000Z'], 'ExtranetEndpoint' => ['title' => '', 'description' => 'The public endpoint used to access the bucket.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com'], 'IntranetEndpoint' => ['title' => '', 'description' => 'The internal endpoint used by ECS instances in the same region to access the bucket.', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'], 'Location' => ['title' => '', 'description' => 'The data center in which the bucket is located.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'Name' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'mybucket01'], 'StorageClass' => ['title' => '', 'description' => 'The storage class of the bucket. Valid values: Standard, IA, Archive, and ColdArchive.', 'example' => 'Standard', '$ref' => '#/components/schemas/StorageClass'], 'Region' => ['title' => '', 'description' => 'The region in which the bucket is located.', 'type' => 'string', 'example' => 'cn-hangzhou'], ], 'example' => 'examplebucket', ], 'BucketACL' => [ 'title' => '', 'description' => 'The access permissions of the bucket. Valid values:'."\n" .'- public-read-write: public-read-write'."\n" .'- public-read: public-read'."\n" .'- private (default): private'."\n" ."\n" .'For more information about bucket ACLs, see [Settings for bucket access permissions](~~31843~~).', 'type' => 'string', 'example' => 'private', 'default' => 'private', 'enum' => ['private', 'public-read', 'public-read-write'], ], 'BucketAntiDDOSConfiguration' => [ 'title' => '', 'description' => 'The container that stores the configuration information of the Anti-DDoS instance.', 'type' => 'object', 'properties' => [ 'Cnames' => [ 'title' => '', 'description' => 'The container that stores the list of domain name information.', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '', 'description' => 'The custom domain name to be protected.', 'type' => 'array', 'items' => ['description' => 'The custom domain name to be protected. Each bucket supports up to 5 custom domain names to be protected.', 'type' => 'string', 'example' => 'abc1.example.cn', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'BucketAntiDDOSInfo' => [ 'title' => '', 'description' => 'The container that stores Anti-DDoS instance information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '', 'description' => 'The Anti-DDoS instance ID.', 'type' => 'string', 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****'], 'Owner' => ['title' => '', 'description' => 'The UID of the bucket owner.', 'type' => 'string', 'example' => '114893010724****'], 'Bucket' => ['title' => '', 'description' => 'The name of the protected bucket.', 'type' => 'string', 'example' => 'examplebucket'], 'Ctime' => ['title' => '', 'description' => 'The time when the Anti-DDoS instance was created, in the timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769503'], 'Mtime' => ['title' => '', 'description' => 'The time when the Anti-DDoS instance was updated, in the timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769840'], 'ActiveTime' => ['title' => '', 'description' => 'The time when the Anti-DDoS instance was activated, in the timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769845'], 'Status' => ['title' => '', 'description' => 'The status of the Anti-DDoS instance. Valid values:'."\n" ."\n" .'- Init: The protection is being initialized.'."\n" ."\n" .'- Defending: The protection is active.'."\n" ."\n" .'- HaltDefending: The protection is deactivated.', 'type' => 'string', 'example' => 'Defending'], 'Type' => ['title' => '', 'description' => 'The type of the Anti-DDoS instance. The value is fixed as AntiDDosPremimum.', 'type' => 'string', 'example' => 'AntiDDosPremimum'], 'Cnames' => [ 'title' => '', 'description' => 'The container that stores custom domain names.', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '', 'description' => 'The custom domain name.', 'type' => 'array', 'items' => ['description' => 'The custom domain name.', 'type' => 'string', 'example' => 'abc1.example.cn', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'BucketChannelConfig' => [ 'title' => '', 'description' => 'The bucket image processing channel configuration.', 'type' => 'object', 'properties' => [ 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'DebugInfo' => ['title' => '', 'description' => 'The debug information.', 'type' => 'string', 'example' => 'testinfo'], 'RuleList' => [ 'title' => '', 'description' => 'The rule list.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '', 'description' => '保存规则的容器', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleName' => ['title' => '', 'description' => '规则名称', 'type' => 'string', 'example' => 'rule1'], 'RuleRegex' => ['title' => '', 'description' => '规则匹配正则', 'type' => 'string', 'example' => '\\\\.webp$'], 'FrontContent' => ['title' => '', 'description' => '规则内容', 'type' => 'string', 'example' => 'a'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'BucketCnameConfiguration' => [ 'title' => '', 'description' => 'The container for CNAME configurations.', 'type' => 'object', 'properties' => [ 'Cname' => [ 'title' => '', 'description' => 'The container for CNAME information.', 'type' => 'object', 'properties' => [ 'Domain' => ['title' => '', 'description' => '自定义域名。', 'type' => 'string', 'example' => 'example.com'], ], 'example' => '', ], ], 'example' => '', ], 'BucketDataRedundancyTransition' => [ 'title' => '', 'description' => 'The details of a bucket storage redundancy conversion task.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket'], 'TaskId' => ['title' => '', 'description' => 'The ID of the storage redundancy conversion task.', 'type' => 'string', 'example' => '751f5243f8ac4ae89f34726534d1****'], 'Status' => ['title' => '', 'description' => 'The status of the storage redundancy conversion task. Valid values:'."\n" ."\n" .'- Queueing: queued'."\n" .'- Processing: in progress'."\n" .'- Finished: completed.', 'type' => 'string', 'example' => 'Queueing'], 'CreateTime' => ['title' => '', 'description' => 'The time when the storage redundancy conversion task was created.', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z'], 'StartTime' => ['title' => '', 'description' => 'The time when the storage redundancy conversion task started.', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z'], 'EndTime' => ['title' => '', 'description' => 'The time when the storage redundancy conversion task was completed.', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z'], 'ProcessPercentage' => ['title' => '', 'description' => 'The progress percentage of the storage redundancy conversion task. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '88'], 'EstimatedRemainingTime' => ['title' => '', 'description' => 'The estimated remaining time for the storage redundancy conversion task. Unit: hours.', 'type' => 'string', 'example' => '10'], ], 'example' => '', ], 'BucketInfo' => [ 'title' => '', 'description' => 'The container that stores bucket information.', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '', 'description' => 'The container that stores bucket information.', 'type' => 'object', 'properties' => [ 'AccessMonitor' => [ 'title' => '', 'description' => 'Bucket是否开启访问追踪', 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'], 'type' => 'string', 'example' => 'Disabled', ], 'CreationDate' => ['title' => '', 'description' => 'Bucket的创建时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-01-06T08:20:09.000Z'], 'CrossRegionReplication' => [ 'title' => '', 'description' => 'Bucket是否开启跨区域复制', 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'], 'type' => 'string', 'example' => 'Disabled', ], 'DataRedundancyType' => ['description' => 'Bucket的数据容灾类型', '$ref' => '#/components/schemas/DataRedundancyType', 'title' => '', 'example' => ''], 'ExtranetEndpoint' => ['title' => '', 'description' => 'Bucket外网访问域名', '$ref' => '#/components/schemas/Endpoint', 'example' => ''], 'IntranetEndpoint' => ['title' => '', 'description' => 'Bucket内网访问域名', '$ref' => '#/components/schemas/Endpoint', 'example' => ''], 'Location' => ['title' => '', 'description' => 'Bucket所在地域', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'Name' => ['title' => '', 'description' => 'Bucket名称', 'type' => 'string', 'example' => 'test-bucket'], 'ResourceGroupId' => ['title' => '', 'description' => 'Bucket所在的资源组ID', '$ref' => '#/components/schemas/ResourceGroupId', 'example' => ''], 'StorageClass' => ['title' => '', 'description' => 'Bucket的存储类型', '$ref' => '#/components/schemas/StorageClass', 'example' => ''], 'TransferAcceleration' => [ 'title' => '', 'description' => 'Bucket传输', 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'], 'type' => 'string', 'example' => 'Disabled', ], 'Versioning' => ['title' => '', 'description' => 'Bucket多版本状态', '$ref' => '#/components/schemas/BucketVersioningStatus', 'example' => ''], 'Owner' => ['title' => '', 'description' => 'Bucket所有者', '$ref' => '#/components/schemas/Owner', 'example' => ''], 'AccessControlList' => ['title' => '', 'description' => 'Bucket权限', '$ref' => '#/components/schemas/AccessControlList', 'example' => ''], 'ServerSideEncryptionRule' => [ 'title' => '', 'description' => 'Bucket服务端加密配置', 'type' => 'object', 'properties' => [ 'SSEAlgorithm' => ['title' => '', 'description' => '设置服务器端默认加密方式。'."\n" ."\n" .'取值:KMS、AES256、SM4。', 'type' => 'string', 'example' => 'KMS'], 'KMSMasterKeyID' => ['title' => '', 'description' => '服务端加密KMS密钥', 'type' => 'string', 'example' => ' '."\n" .'9468da86-3509-4f8d-a61e-6eab1eac****'], 'KMSDataEncryption' => ['title' => '', 'description' => '指定Object的加密算法。如果未指定此选项,表明Object使用AES256加密算法。此选项仅当SSEAlgorithm取值为KMS有效。'."\n" ."\n" .'取值:SM4', 'type' => 'string', 'example' => 'SM4'], ], 'example' => '', ], 'BucketPolicy' => [ 'title' => '', 'description' => 'Bucket日志配置', 'type' => 'object', 'properties' => [ 'LogBucket' => ['title' => '', 'description' => '存储日志记录的Bucket名称。', 'type' => 'string', 'example' => 'example-bucket'], 'LogPrefix' => ['title' => '', 'description' => '存储日志文件的目录。', 'type' => 'string', 'example' => 'log/'], ], 'example' => '', '$ref' => '#/components/schemas/LoggingEnabled', ], ], 'example' => '', ], ], 'example' => '', ], 'BucketLoggingStatus' => [ 'title' => '', 'description' => 'The container that stores the access logging status information.', 'type' => 'object', 'properties' => [ 'LoggingEnabled' => ['description' => 'The container for access logging information.', 'required' => true, '$ref' => '#/components/schemas/LoggingEnabled', 'title' => '', 'example' => ''], ], 'example' => '', ], 'BucketProcessConfiguration' => [ 'title' => '', 'description' => 'The image processing configuration of a bucket.', 'type' => 'object', 'properties' => [ 'CompliedHost' => ['title' => '', 'description' => 'The domain name.', 'type' => 'string', 'example' => 'Img'], 'OssDomainSupportAtProcess' => ['title' => '', 'description' => 'Indicates whether the OSS domain name is supported.', 'type' => 'string', 'example' => 'disabled'], 'SourceFileProtect' => ['title' => '', 'description' => 'The source image protection.', 'type' => 'string', 'example' => 'disabled'], 'SourceFileProtectSuffix' => ['title' => '', 'description' => 'The source image protection suffix.', 'type' => 'string', 'example' => 'gif'], 'BucketChannelConfig' => ['title' => '', 'description' => 'The image processing channel configuration.', '$ref' => '#/components/schemas/BucketChannelConfig', 'example' => ''], 'StyleDelimiters' => ['title' => '', 'description' => 'The style delimiter.', 'type' => 'string', 'example' => '-,|'], ], 'example' => '', ], 'BucketQoSConfiguration' => [ 'title' => '', 'description' => 'The bucket-level QoS configuration information.', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => ['title' => '', 'description' => 'The total upstream bandwidth. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'IntranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the internal network. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ExtranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the public network. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalDownloadBandwidth' => ['title' => '', 'description' => 'The total downstream bandwidth. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'IntranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the internal network. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'ExtranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the public network. Unit: Gbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalQps' => ['title' => '', 'description' => 'The total QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'IntranetQps' => ['title' => '', 'description' => 'The QPS over the internal network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'ExtranetQps' => ['title' => '', 'description' => 'The QPS over the public network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'Exclusive' => ['title' => '', 'description' => 'Indicates whether the bucket-level QoS configuration is independent of the user-level QoS configuration.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'BucketResourceGroupConfiguration' => [ 'title' => '', 'description' => 'The bucket resource group configuration.', 'type' => 'object', 'properties' => [ 'ResourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the bucket belongs.', '$ref' => '#/components/schemas/ResourceGroupId', 'example' => ''], ], 'example' => '', ], 'BucketStat' => [ 'title' => '', 'description' => 'The container for the BucketStat structure.', 'type' => 'object', 'properties' => [ 'StandardStorage' => ['title' => '', 'description' => 'The storage size of the Standard storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600'], 'ColdArchiveObjectCount' => ['title' => '', 'description' => 'The number of objects of the Cold Archive storage class.', 'type' => 'integer', 'format' => 'int64', 'example' => '230'], 'ArchiveObjectCount' => ['title' => '', 'description' => 'The number of objects of the Archive storage class.', 'type' => 'integer', 'format' => 'int64', 'example' => '40'], 'InfrequentAccessStorage' => ['title' => '', 'description' => 'The billed storage size of the Infrequent Access (IA) storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1250'], 'ArchiveRealStorage' => ['title' => '', 'description' => 'The actual storage size of the Archive storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '5990'], 'StandardObjectCount' => ['title' => '', 'description' => 'The number of objects of the Standard storage class.', 'type' => 'integer', 'format' => 'int64', 'example' => '12323'], 'ObjectCount' => ['title' => '', 'description' => 'The total number of objects in the bucket.', 'type' => 'integer', 'format' => 'int64', 'example' => '2034903'], 'Storage' => ['title' => '', 'description' => 'The total storage size of the bucket, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '39182324'], 'ArchiveStorage' => ['title' => '', 'description' => 'The billed storage size of the Archive storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '30423'], 'LastModifiedTime' => ['title' => '', 'description' => 'The point in time when the storage information was obtained. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1643341269'], 'MultipartUploadCount' => ['title' => '', 'description' => 'The number of multipart upload tasks that have been initiated but not completed or aborted in the bucket.', 'type' => 'integer', 'format' => 'int64', 'example' => '223'], 'LiveChannelCount' => ['title' => '', 'description' => 'The number of LiveChannels in the bucket.', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'ColdArchiveRealStorage' => ['title' => '', 'description' => 'The actual storage size of the Cold Archive storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2312'], 'InfrequentAccessObjectCount' => ['title' => '', 'description' => 'The number of objects of the Infrequent Access (IA) storage class.', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], 'ColdArchiveStorage' => ['title' => '', 'description' => 'The billed storage size of the Cold Archive storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '342'], 'InfrequentAccessRealStorage' => ['title' => '', 'description' => 'The actual storage size of the Infrequent Access (IA) storage class, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '65754'], ], 'example' => '', ], 'BucketVersioningStatus' => [ 'description' => 'The versioning status. Valid values:'."\n" .'- Enabled: The versioning status is enabled.'."\n" .'- Suspended: The versioning status is suspended.', 'type' => 'string', 'example' => 'Enabled', 'enum' => ['Enabled', 'Suspended'], 'title' => '', ], 'BucketWormState' => [ 'title' => '', 'description' => 'The status of data retention policy.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- InProgress: After a retention policy is created, the policy is in the InProgress state by default. This state has a validity period of 24 hours.'."\n" .'- Locked: Data retention policy is locked.', 'type' => 'string', 'example' => 'Locked', 'enum' => ['InProgress', 'Locked'], ], 'CacheBaseInfo' => [ 'title' => '加速器基本信息', 'description' => '加速器基本信息', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '加速器名称', 'type' => 'string', 'example' => 'cache1'], 'AvailableZone' => ['title' => '加速器所在可用区', 'type' => 'string', 'example' => 'cn-hangzhou-j'], 'QuotaConfiguration' => ['title' => '加速器容量信息', '$ref' => '#/components/schemas/CacheQuotaConfiguration'], 'CreationDate' => ['title' => '加速器创建时间', 'type' => 'string', 'example' => '2023-09-12T15:26:29.000Z'], ], ], 'CacheBucketInfo' => [ 'title' => '加速器关联存储空间信息', 'description' => '加速器关联存储空间信息', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '存储空间名称', 'type' => 'string', 'example' => 'test-bucket'], 'CachePolicy' => ['title' => '加速策略', 'type' => 'string', 'example' => 'sync-warmup'], 'AcceleratePaths' => ['title' => '加速路径配置', '$ref' => '#/components/schemas/AcceleratePaths'], ], ], 'CacheConfiguration' => [ 'title' => '存储空间加速器配置', 'description' => '存储空间加速器配置信息', 'type' => 'object', 'properties' => [ 'Caches' => [ 'title' => '保存加速器配置列表的容器', 'type' => 'object', 'properties' => [ 'Cache' => [ 'title' => '保存加速器配置', 'type' => 'object', 'properties' => [ 'AvailableZone' => ['title' => '加速器所属可用区', 'type' => 'string', 'example' => 'cn-hangzhou-j'], 'CacheName' => ['title' => '加速器名称', 'type' => 'string', 'example' => 'data-acc-test_data-acc'], 'CachePolicy' => ['title' => '加速器策略', 'type' => 'string', 'example' => 'sync-warmup'], 'AcceleratePaths' => ['title' => '加速路径配置', '$ref' => '#/components/schemas/AcceleratePaths'], ], ], ], ], ], ], 'CacheDetailInfo' => [ 'title' => '加速器详细信息', 'description' => '加速器详细信息', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '加速器名称', 'type' => 'string', 'example' => 'test-acc'], 'AvailableZone' => ['title' => '加速器可用区', 'type' => 'string', 'example' => 'cn-hangzhou-j'], 'QuotaConfiguration' => ['title' => '加速器容量配置', '$ref' => '#/components/schemas/CacheQuotaConfiguration'], 'CreationDate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2023-09-12T15:26:29.000Z'], 'Buckets' => [ 'title' => '保存加速器关联存储空间列表的容器', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '加速器关联存储空间配置', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/CacheBucketInfo'], ], ], ], ], ], 'CacheQuotaConfiguration' => [ 'title' => '加速器容量配置', 'description' => '加速器容量配置', 'type' => 'object', 'properties' => [ 'QuotaDesc' => [ 'title' => '容量配置', 'type' => 'object', 'properties' => [ 'Quota' => ['title' => '容量大小', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], ], ], ], ], 'CallbackPolicy' => [ 'title' => '', 'description' => 'The CNAME information overview.', 'type' => 'object', 'properties' => [ 'PolicyItem' => [ 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyName' => ['title' => '', 'type' => 'string', 'example' => 'first', 'description' => ''], 'Callback' => ['title' => '', 'type' => 'string', 'example' => 'e1wiY2Fsb...9keVwiOlwiYnVja2V0PSR7YnU=', 'description' => ''], 'CallbackVar' => ['title' => '', 'type' => 'string', 'example' => 'Q2Fs...FcIiwgXCJ4OmJcIjpcImJcIn0=', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'example' => '', ], ], 'example' => '', ], 'CertificateConfiguration' => [ 'title' => '', 'description' => 'The container that stores the certificate configuration information for the CNAME.', 'type' => 'object', 'properties' => [ 'CertId' => ['title' => '', 'description' => 'The certificate ID.', 'type' => 'string', 'example' => '493****-cn-hangzhou'], 'Certificate' => ['title' => '', 'description' => 'The certificate public key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----'], 'PrivateKey' => ['title' => '', 'description' => 'The certificate private key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----'], 'PreviousCertId' => ['title' => '', 'description' => 'The current certificate ID. If Force is not set to true, OSS checks whether this value matches the current certificate ID. If the values do not match, an error is returned.', 'type' => 'string', 'example' => '493****-cn-hangzhou'], 'Force' => ['title' => '', 'description' => 'Specifies whether to forcibly overwrite the certificate.', 'type' => 'boolean', 'example' => 'true'], 'DeleteCertificate' => ['title' => '', 'description' => 'Specifies whether to delete the certificate.', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], 'Channel' => [ 'title' => '', 'description' => 'The container that stores the configuration information of the image processing channel.', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'The status of the image processing channel.', 'type' => 'string', 'example' => 'enable'], 'OrigPicForbidden' => ['title' => '', 'description' => 'Indicates whether access to the original image is prohibited.', 'type' => 'boolean', 'example' => 'true'], 'UseStyleOnly' => ['title' => '', 'description' => 'Indicates whether only styles are allowed for image processing.', 'type' => 'boolean', 'example' => 'false'], 'AutoSetContentType' => ['title' => '', 'description' => 'Indicates whether Content-Type is automatically set.', 'type' => 'boolean', 'example' => 'true'], 'UseSrcFormat' => ['title' => '', 'description' => 'Indicates whether the source format is used.', 'type' => 'boolean', 'example' => 'true'], 'SetAttachName' => ['title' => '', 'description' => 'Indicates whether the Content-Disposition: attachment response header is set.', 'type' => 'boolean', 'example' => 'false'], 'Default404Pic' => ['title' => '', 'description' => 'The default 404 image.', 'type' => 'string', 'example' => '404.jpg'], 'StyleDelimiters' => ['title' => '', 'description' => 'The style delimiter.', 'type' => 'string', 'example' => '-,|'], ], 'example' => '', ], 'CnameCertificate' => [ 'title' => '', 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'The certificate source.', 'enumValueTitles' => ['CAS' => '证书中心', 'Upload' => '旧版证书托管中用户自主上传的证书'], 'type' => 'string', 'example' => 'CAS', ], 'CertId' => ['title' => '', 'description' => 'The certificate ID.', 'type' => 'string', 'example' => '493****-cn-hangzhou'], 'Status' => [ 'title' => '', 'description' => 'The certificate status.', 'enumValueTitles' => ['Enabled' => '使用证书', 'Disabled' => '未使用证书'], 'type' => 'string', 'example' => 'Enabled', ], 'CreationDate' => ['title' => '', 'description' => 'The time when the certificate was associated.', 'type' => 'string', 'example' => 'Wed, 15 Sep 2021 02:35:06 GMT'], 'Fingerprint' => ['title' => '', 'description' => 'The certificate signature.', '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 start time of the certificate validity period.', 'type' => 'string', 'example' => 'Wed, 12 Apr 2023 10:14:51 GMT'], 'ValidEndDate' => ['title' => '', 'description' => 'The end time of the certificate validity period.', 'type' => 'string', 'example' => 'Mon, 4 May 2048 10:14:51 GMT'], ], 'example' => '', ], 'CnameInfo' => [ 'title' => '', 'description' => 'The CNAME information overview.', 'type' => 'object', 'properties' => [ 'Domain' => ['title' => '', 'description' => 'The custom domain name.', 'type' => 'string', 'example' => 'example.com'], 'LastModified' => ['title' => '', 'description' => 'The time when the custom domain name was bound.', 'type' => 'string', 'example' => '2021-09-15T02:35:07.000Z'], 'Status' => ['title' => '', 'description' => 'The status of the domain name. Valid values:'."\n" ."\n" .'- Enabled: The domain name is enabled.'."\n" ."\n" .'- Disabled: The domain name is disabled.', 'type' => 'string', 'example' => 'Enabled'], 'Certificate' => ['description' => 'The container for certificate information.', '$ref' => '#/components/schemas/CnameCertificate', 'title' => '', 'example' => ''], ], 'example' => '', ], 'CnameSummary' => [ 'title' => '', 'description' => 'The CNAME information overview.', 'type' => 'object', 'properties' => [ 'Domain' => ['title' => '', 'description' => 'The custom domain name.', 'type' => 'string', 'example' => 'example.com'], 'LastModified' => ['title' => '', 'description' => 'The time when the custom domain name was bound.', 'type' => 'string', 'example' => '2021-09-15T02:35:07.000Z'], 'Status' => [ 'title' => '', 'description' => 'The status of the domain name. Valid values:'."\n" .'- Enabled: The domain name is enabled.'."\n" .'- Disabled: The domain name is disabled.', 'enumValueTitles' => ['Enabled' => '启用该域名', 'Disabled' => '禁用该域名'], 'type' => 'string', 'example' => 'Enabled', ], 'Certificate' => ['description' => 'The container for the certificate information.', '$ref' => '#/components/schemas/CnameCertificate', 'title' => '', 'example' => ''], ], 'example' => '', ], 'CnameToken' => [ 'title' => '', 'description' => 'The container for CnameToken information.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The name of the bucket to which the CNAME is mapped.', 'type' => 'string', 'example' => 'examplebucket'], 'Cname' => ['title' => '', 'description' => 'The CNAME that is mapped to the bucket.', 'type' => 'string', 'example' => 'example.com'], 'Token' => ['title' => '', 'description' => 'The CnameToken returned by OSS.', 'type' => 'string', 'example' => 'be1d49d863dea9ffeff3df7d6455****'], 'ExpireTime' => ['title' => '', 'description' => 'The expiration time of the CnameToken.', 'type' => 'string', 'example' => 'Wed, 23 Feb 2022 21:16:37 GMT'], ], 'example' => '', ], 'CommentConfiguration' => [ 'title' => 'bucket备注内容的容器', 'description' => '存放bucket备注内容的容器', 'type' => 'object', 'properties' => [ 'Comment' => ['title' => 'bucket的备注内容', 'type' => 'string', 'example' => 'comments'], ], ], 'CommonHeaders' => [ 'title' => '', 'description' => 'The container that stores custom HTTP header configurations.', 'type' => 'object', 'properties' => [ 'Header' => [ 'title' => '', 'description' => 'The container that stores the list of custom HTTP headers.', 'type' => 'array', 'items' => [ 'description' => 'The container that stores a custom HTTP header.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the HTTP header.', 'type' => 'string', 'example' => 'X-Content-Type-Options'], 'Value' => ['title' => '', 'description' => 'The value of the HTTP header.', 'type' => 'string', 'example' => 'nosniff'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'CommonPrefix' => [ 'title' => '', 'description' => 'If the delimiter parameter is specified in the request, the response from OSS contains the CommonPrefixes element. This element indicates a set of object names that end with the delimiter and share a common prefix.', 'type' => 'object', 'properties' => [ 'Prefix' => ['title' => '', 'description' => 'The common prefix of the query results.', 'type' => 'string', 'example' => 'fun/'], ], 'example' => '', ], 'CompleteMultipartUpload' => [ 'title' => '', 'description' => 'The container that stores the content of the CompleteMultipartUpload request.', 'type' => 'object', 'properties' => [ 'Part' => [ 'title' => '', 'description' => 'The container that stores information about uploaded parts.', 'type' => 'array', 'items' => [ 'description' => 'The container that stores information about uploaded parts.', 'type' => 'object', 'properties' => [ 'PartNumber' => ['title' => '', 'description' => 'The part number.', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], 'ETag' => ['title' => '', 'description' => 'An ETag is created for an object when it is generated. ETags are used to identify the content of an object.'."\n" ."\n" .'For an object created by a CompleteMultipartUpload request, the ETag value is a unique value generated based on specific calculation rules, but it is not the MD5 hash of the object content.'."\n" ."\n" .'> ETag values can be used to check whether the content of an object has changed. Do not use ETags as MD5 hashes of object content to verify data integrity.', 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'CompressionType' => [ 'title' => '', 'description' => 'The file compression type (optional).', 'type' => 'string', 'example' => 'None', 'enum' => ['None', 'GZIP'], ], 'CopyObjectResult' => [ 'title' => '', 'description' => 'The result of CopyObject.', 'type' => 'object', 'properties' => [ 'ETag' => ['title' => '', 'description' => 'The ETag that is generated when an object is created. ETags are used to identify the content of an object.'."\n" .' - For an object that is created by a PutObject request, the ETag value is the MD5 hash of the object content.'."\n" .' - For an object that is created by using other methods, the ETag value is a unique value calculated based on specific rules, but it is not the MD5 hash of the object content.'."\n" ."\n" .'>You can use the ETag value to check whether the object content has changed. Do not use the ETag as the MD5 hash of the object content to verify data integrity.'."\n" .'Default value: null.', 'type' => 'string', 'example' => ' '."\n" .'5B3C1A2E053D763E1B002CC607C5****'], 'LastModified' => ['title' => '', 'description' => 'The time when the object was last modified.', 'type' => 'string', 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT'], ], 'example' => '', ], 'CopyPartResult' => [ 'title' => '', 'description' => 'The result of the CopyObject operation.', 'type' => 'object', 'properties' => [ 'ETag' => ['title' => '', 'description' => 'The ETag that is created when an object is generated. ETags are used to identify the content of an object.'."\n" .'For an object created by calling the CompleteMultipartUpload operation, the ETag value is a unique value calculated based on specific rules, but it is not the MD5 hash of the object content.'."\n" ."\n" .'> You can use the ETag value to check whether the object content has changed. Do not use the ETag as the MD5 hash of the object content to verify data integrity.', 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****'], 'LastModified' => ['title' => '', 'description' => 'The time when the part was uploaded.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T07:01:34.000Z'], ], 'example' => '', ], 'CORSConfiguration' => [ 'title' => '', 'description' => 'The container for CORS rules of a bucket.', 'type' => 'object', 'properties' => [ 'CORSRule' => [ 'title' => '', 'description' => 'The container for CORS rules.'."\n" ."\n" .'A maximum of 10 CORS rules can be configured for each bucket. The uploaded XML document can be up to 16 KB in size.', 'type' => 'array', 'items' => ['description' => 'The information about the CORS rule.', '$ref' => '#/components/schemas/CORSRule', 'title' => '', 'example' => ''], 'example' => '', ], 'ResponseVary' => [ 'title' => '', 'description' => 'Specifies whether to return the Vary: Origin header. 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 in any case.'."\n" ."\n" .'> This field cannot be configured independently. At least one cross-origin rule must be configured for this field to take effect.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], ], 'example' => '', ], 'CORSRule' => [ 'title' => '', 'description' => 'The container for a CORS rule.'."\n" ."\n" .'Each bucket allows a maximum of 10 CORS rules. The maximum size of the uploaded XML document is 16 KB.', 'type' => 'object', 'properties' => [ 'AllowedOrigin' => [ 'title' => '', 'description' => 'The allowed origins for cross-origin requests.', 'type' => 'array', 'items' => ['description' => '指定允许的跨域请求来源。'."\n" ."\n" .'OSS允许使用多个元素来指定多个允许的来源。多个元素之间用英文逗号(,)分隔。'."\n" ."\n" .'OSS仅允许使用一个星号(\\*)通配符。如果指定为星号(\\*),则表示允许所有来源的跨域请求。', 'type' => 'string', 'example' => '*', 'title' => ''], 'example' => '', ], 'AllowedMethod' => [ 'title' => '', 'description' => 'The allowed methods for cross-origin requests.', 'type' => 'array', 'items' => ['description' => '指定允许的跨域请求方法。'."\n" ."\n" .'取值范围为GET、PUT、DELETE、POST、HEAD。', 'type' => 'string', 'example' => 'GET', 'title' => ''], 'example' => '', ], 'AllowedHeader' => [ 'title' => '', 'description' => 'Specifies whether the headers specified in Access-Control-Request-Headers in an OPTIONS preflight request are allowed. Each header specified in Access-Control-Request-Headers must have a corresponding entry in AllowedHeader.'."\n" ."\n" .'> Only one asterisk (\\*) wildcard character is allowed.', 'type' => 'string', 'items' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'x-oss-*', 'extendType' => 'true'], 'example' => 'Authorization', ], 'ExposeHeader' => [ 'title' => '', 'description' => 'The response headers that users are allowed to access from an application, such as a JavaScript XMLHttpRequest object.'."\n" ."\n" .'> The asterisk (\\*) wildcard character is not allowed.', 'type' => 'array', 'items' => ['description' => '指定允许用户从应用程序中访问的响应头。例如一个JavaScript的XMLHttpRequest对象。'."\n" ."\n" .'> 不允许使用星号(*)通配符。', 'type' => 'string', 'example' => 'x-oss-test', 'title' => ''], 'example' => '', ], 'MaxAgeSeconds' => ['title' => '', 'description' => 'The cache duration for the browser to cache the response of an OPTIONS preflight request for a specific resource. Unit: seconds.'."\n" ."\n" .'Only one MaxAgeSeconds is allowed per CORS rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], 'example' => '', ], 'CreateAccessPointConfiguration' => [ 'title' => '', 'description' => 'The container that stores access point information.', 'type' => 'object', 'properties' => [ 'AccessPointName' => ['title' => '', 'description' => 'The name of the access point. The naming conventions are as follows:'."\n" ."\n" .'- The access point name must be unique within a single region under the current Alibaba Cloud account.'."\n" ."\n" .'- The name cannot end with -ossalias.'."\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 3 to 19 characters in length.', 'type' => 'string', 'example' => 'ap-01'], 'NetworkOrigin' => ['title' => '', 'description' => 'The network origin of the access point.', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', 'example' => ''], 'VpcConfiguration' => ['title' => '', 'description' => 'The container that stores VPC network origin information.', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', 'example' => ''], ], 'example' => '', ], 'CreateAccessPointResult' => [ 'title' => '', 'description' => 'The container that stores access point information.', 'type' => 'object', 'properties' => [ 'AccessPointArn' => ['title' => '', 'description' => 'The ARN of the access point.', '$ref' => '#/components/schemas/AccessPointArn', 'example' => ''], 'Alias' => ['title' => '', 'description' => 'The alias of the access point.', '$ref' => '#/components/schemas/AccessPointAlias', 'example' => ''], ], 'example' => '', ], 'CreateBucketConfiguration' => [ 'title' => '', 'description' => 'The storage class and data redundancy configuration of a bucket.', 'type' => 'object', 'properties' => [ 'StorageClass' => [ 'description' => 'The storage class of the bucket. Valid values:'."\n" ."\n" .'- Standard (default): Standard'."\n" .'- IA: Infrequent Access'."\n" .'- Archive: Archive'."\n" .'- ColdArchive: Cold Archive.', 'enumValueTitles' => [], '$ref' => '#/components/schemas/StorageClass', 'title' => '', 'example' => '', ], 'DataRedundancyType' => [ 'description' => 'The data redundancy type of the bucket.'."\n" ."\n" .'- LRS (default)'."\n" .'
Locally redundant storage (LRS) stores your data redundantly across different storage devices within the same zone. LRS ensures that your data remains accessible and undamaged even if two storage devices fail simultaneously.'."\n" ."\n" .'- ZRS'."\n" .'
Zone-redundant storage (ZRS) uses a multi-zone mechanism to store your data redundantly across three zones in the same region. Even if an entire zone becomes unavailable due to failures such as power outages or fires, your data remains accessible.'."\n" .'> Buckets of the Archive storage class do not support zone-redundant storage..', 'enumValueTitles' => [], '$ref' => '#/components/schemas/DataRedundancyType', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'CreateCacheConfiguration' => [ 'title' => '加速器创建参数', 'description' => '加速器创建参数', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '加速器名称', 'type' => 'string', 'example' => 'cache2'], 'AvailableZone' => ['title' => '加速器可用区', 'type' => 'string', 'example' => 'cn-hangzhou-j'], 'QuotaConfiguration' => ['title' => '加速器容量配置', '$ref' => '#/components/schemas/CacheQuotaConfiguration'], ], ], 'CreateDataLakeCachePrefetchJob' => [ 'title' => 'oss加速器异步预热配置', 'description' => 'oss cache异步预热规则', 'type' => 'object', 'properties' => [ 'Includes' => [ 'title' => '需要预热的文件前缀列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/def'], ], 'Tag' => ['title' => '配置标签', 'type' => 'string', 'example' => 'Jobxxx'], 'Excludes' => [ 'title' => '不需要预热的文件前缀列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'not-prefetch/'], ], ], ], 'CreateDataLakeStorageTransferJob' => [ 'title' => '', 'description' => '数据湖元数据转换任务配置', 'type' => 'object', 'properties' => [ 'Includes' => [ 'title' => '待转换的文件前缀列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/'], ], 'ExecutorRoleId' => ['title' => '授权角色', 'type' => 'string', 'example' => 'AliyunOSSRole'], 'LogBaseDir' => ['title' => '日志存放路径', 'type' => 'string', 'example' => 'log'], 'Tag' => ['title' => '标签', 'type' => 'string', 'example' => 'tag'], 'NeedVerify' => ['title' => '是否开启校验', 'type' => 'boolean', 'example' => 'false'], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'CreateDataLakeStorageTransferJob' => [ 'title' => '数据湖元数据转换任务配置', 'description' => '数据湖元数据转换任务配置', 'type' => 'object', 'properties' => [ 'Includes' => [ 'title' => '待转换的文件前缀列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/'], ], 'ExecutorRoleId' => ['title' => '授权角色', 'type' => 'string', 'example' => 'AliyunOSSRole'], 'LogBaseDir' => ['title' => '日志存放路径', 'type' => 'string', 'example' => 'log'], 'Tag' => ['title' => '标签', 'type' => 'string', 'example' => 'tag'], 'NeedVerify' => ['title' => '是否开启校验', 'type' => 'boolean', 'example' => 'false'], ], ], ], ], 'example' => '', ], 'CreateFileGroup' => [ 'title' => '创建FileGroup类型文件的请求体', 'description' => '创建FileGroup类型文件的请求', 'type' => 'object', 'properties' => [ 'Part' => [ 'title' => 'FileGroup文件每个Part的信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PartNumber' => ['title' => 'Part的序号', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'PartName' => ['title' => 'Part的文件名', 'type' => 'string', 'example' => 'test.txt'], 'ETag' => ['title' => 'Part的ETag', 'type' => 'string', 'example' => '"EB327B57BB20D17C293A966115FE27BD"'], ], ], ], ], ], 'CreateFileGroupResult' => [ 'title' => '创建FileGroup类型文件的结果', 'description' => '创建FileGroup类型文件的结果', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '文件所属的存储空间', 'type' => 'string', 'example' => 'test-bucket'], 'Key' => ['title' => '文件名称', 'type' => 'string', 'example' => 'test.txt'], 'ETag' => ['title' => '文件ETag', 'type' => 'string', 'example' => '"06A4DDABDD5F65868B8C5919E76487D6"'], 'Size' => ['title' => '文件大小', 'type' => 'integer', 'format' => 'int64', 'example' => '384'], ], ], 'CreateLargeReservedCapacityResult' => [ 'title' => '创建预留空间的结果', 'description' => '创建预留空间的结果', 'type' => 'object', 'properties' => [ 'Owner' => ['title' => '预留空间所有者信息', '$ref' => '#/components/schemas/Owner'], 'Name' => ['title' => '预留空间名称', 'type' => 'string', 'example' => 'test-rc-01'], 'Region' => ['title' => '预留空间所属地域', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'ID' => ['title' => '预留空间ID', 'type' => 'string', 'example' => 'c99797e7-510d-41e3-ac82-e851c17e1f5c'], ], ], 'CreateObjectLinkResult' => [ 'title' => 'ObjectLink类型文件创建结果', 'description' => 'ObjectLink类型文件创建结果', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '文件所属存储空间名称', 'type' => 'string', 'example' => 'test-bucket'], 'Key' => ['title' => '文件名称', 'type' => 'string', 'example' => 'ink-object'], 'ETag' => ['title' => '文件的ETag', 'type' => 'string', 'example' => '"5D3D4F3D1E6C690977E79E413C5F951D"'], ], ], 'CreateSelectMetaProcess' => ['description' => 'The optional x-oss-process parameter for CreateSelectMeta.', 'type' => 'string', 'example' => 'csv/meta', 'title' => ''], 'CSVInput' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'FileHeaderInfo' => [ 'description' => 'The header information of the CSV file. Valid values:'."\n" ."\n" .'- Use: The CSV file has header information. You can use CSV column names as column names in the Select statement.'."\n" ."\n" .'- Ignore: The CSV file has header information, but you cannot use CSV column names as column names in the Select statement.'."\n" ."\n" .'- None: The file has no header information. This is the default value.', 'enumValueTitles' => ['Ignore' => 'Ignore', 'Use' => 'Use', 'None' => 'None'], 'example' => 'Use', '$ref' => '#/components/schemas/FileHeaderInfo', 'title' => '', ], 'RecordDelimiter' => ['title' => '', 'description' => 'The line feed, which is Base64-encoded. Default value: '."\n" .' (optional). The value before encoding can contain up to two characters, represented by the ANSI value of the character. For example, '."\n" .' is used in Java to represent a line feed.', 'type' => 'string', 'example' => '\\n'], 'FieldDelimiter' => ['title' => '', 'description' => 'The CSV column separator, which is Base64-encoded. Default value: `,` (optional). The value before encoding must be a single character, represented by the ANSI value of the character. For example, `,` is used in Java to represent a comma.', 'type' => 'string', 'example' => ','], 'QuoteCharacter' => ['title' => '', 'description' => 'The quote character of the CSV file, which is Base64-encoded. Default value: `\\"` (optional). In CSV, line feeds and column separators within quotes are treated as regular characters. The value before encoding must be a single character, represented by the ANSI value of the character. For example, `\\"` is used in Java to represent a quote character.', 'type' => 'string', 'example' => '\\”'], 'CommentCharacter' => ['title' => '', 'description' => 'The comment symbol of the CSV file, which is Base64-encoded. Default value: empty (no comment symbol).', 'type' => 'string', 'example' => '#'], 'Range' => [ 'title' => '', 'description' => 'The range of the file to query (optional). Two formats are supported:'."\n" ."\n" .'> The file queried by using the Range parameter query must have select meta. For more information about select meta, see [CreateSelectObjectMeta](~~74054~~).'."\n" ."\n" .'- Query by row: line-range=start-end. For example, line-range=10-20 scans rows 10 through 20.'."\n" ."\n" .'- Query by split: split-range=start-end. For example, split-range=10-20 scans splits 10 through 20.'."\n" ."\n" .'
Both start and end are inclusive. The format is consistent with the range parameter in range download.'."\n" .'
This parameter is used only when the document is CSV or the JSON Type is LINES.', 'enumValueTitles' => ['line-range=start-end' => 'line-range=start-end', 'split-range=start-end' => 'split-range=start-end'], 'type' => 'string', 'example' => 'line-range=start-end', ], 'AllowQuotedRecordDelimiter' => [ 'title' => '', 'description' => 'Specifies whether the CSV content contains line feeds within quotes.'."\n" .'
For example, if a column value is `"abc'."\n" .'def"` (where `'."\n" .'` is a line feed), set this parameter to true. If this parameter is set to false, Select supports the header range semantics, which enables more efficient shard-based queries.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '', ], 'CSVOutput' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'RecordDelimiter' => ['title' => '', 'description' => 'The line feed in Base64 encoding. The value before encoding can contain up to two characters, represented by the ANSI value of the character. For example, `'."\n" .'` is used in Java to represent a line feed.'."\n" .'
Default value: `'."\n" .'`.', 'type' => 'string', 'example' => '\\n'], 'FieldDelimiter' => ['title' => '', 'description' => 'The CSV column delimiter in Base64 encoding. The value before encoding must be a single character, represented by the ANSI value of the character. For example, `,` is used in Java to represent a comma.'."\n" .'
Default value: `,`.', 'type' => 'string', 'example' => ','], ], 'example' => '', ], 'DataAccelerator' => [ 'title' => '', 'description' => '数据湖加速器信息', 'type' => 'object', 'properties' => [ 'BasicInfomation' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'AcceleratePaths' => ['title' => '', '$ref' => '#/components/schemas/AcceleratePaths', 'description' => '', 'example' => ''], 'CreationDate' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1731394193189', 'description' => ''], 'Quota' => ['title' => '', 'type' => 'string', 'example' => '1024000', 'description' => ''], 'AvailableZone' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'description' => ''], 'QuotaFrozenUtil' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1731394193189', 'description' => ''], ], 'description' => '', 'example' => '', ], 'BucketName' => ['title' => '', 'type' => 'string', 'example' => 'test-acc-bucket', 'description' => ''], 'Name' => ['title' => '', 'type' => 'string', 'example' => 'test-acc-bucket_data-acc', 'description' => ''], ], 'example' => '', ], 'DataAcceleratorConfiguration' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Quota' => ['title' => '', 'type' => 'string', 'example' => '102400', 'description' => ''], 'AcceleratePaths' => ['title' => '', '$ref' => '#/components/schemas/AcceleratePaths', 'description' => '', 'example' => ''], ], 'description' => '', 'example' => '', ], 'DataLakeCachePrefetchJob' => [ 'title' => '加速器异步预热任务配置信息', 'description' => 'oss加速器异步预热配置', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '加速器异步预热配置ID', 'type' => 'string', 'example' => '84dcbfa10wdp488211dc6cb287f4d804'], 'HistoryId' => ['title' => '上一次触发的历史任务id', 'type' => 'string', 'example' => '84dcbfa10wdp488211dc6cb287f4d804'], 'Bucket' => ['title' => '存储空间名称', 'type' => 'string', 'example' => 'bucket-example'], 'Type' => ['title' => '复制任务类型', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Status' => ['title' => '复制任务状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_IDLE'], 'CreateTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727162332'], 'LastModifyTime' => ['title' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727164655'], 'Rule' => ['title' => '加速器异步预热任务规则', '$ref' => '#/components/schemas/DataLakeCachePrefetchJobRule'], ], ], 'DataLakeCachePrefetchJobHistory' => [ 'title' => 'oss加速器异步预热任务执行记录', 'description' => 'oss加速器异步预热任务执行记录', 'type' => 'object', 'properties' => [ 'JobId' => ['title' => 'oss加速器异步预热配置ID', 'type' => 'string', 'example' => '345sdf60df1329d88482912343ea74g2'], 'Id' => ['title' => '异步预热任务执行记录Id', 'type' => 'string', 'example' => '8w643e67a54c4670b5ed321511234567'], 'Status' => ['title' => '任务执行状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_SUCCESS'], 'StartTime' => ['title' => '任务执行开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727176463'], 'EndTime' => ['title' => '任务执行结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727176823'], 'TotalCount' => ['title' => '需要预热的总文件数目', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'SucceedCount' => ['title' => '成功预热的文件数目', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'DataLakeCachePrefetchJobRule' => [ 'title' => 'oss加速器异步预热规则', 'description' => 'oss加速器异步预热规则', 'type' => 'object', 'properties' => [ 'PrefixFilter' => [ 'title' => '文件前缀过滤规则', 'type' => 'object', 'properties' => [ 'Includes' => [ 'title' => '需要异步预热的文件前缀列表', 'type' => 'object', 'properties' => [ 'Include' => [ 'title' => '需要异步预热的文件前缀', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/def'], ], ], ], 'Excludes' => [ 'title' => '不需要异步预热的文件前缀列表', 'type' => 'object', 'properties' => [ 'Exclude' => [ 'title' => '不需要异步预热的文件前缀', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/def'], ], ], ], ], ], 'Tag' => ['title' => '规则标签', 'type' => 'string'], ], ], 'DataLakeStorageTransferJob' => [ 'title' => '', 'description' => '数据湖元数据转换任务配置信息', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '任务ID', 'type' => 'string', 'example' => 'abcdef87e3c04af2af290ec52d123456'], 'HistoryId' => ['title' => '上一次触发的历史任务ID', 'type' => 'string', 'example' => 'abcdef87e3c04af2af290ec52d123456'], 'Bucket' => ['title' => 'Bucket名称', 'type' => 'string', 'example' => 'bucket1'], 'Type' => ['title' => '复制任务类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Status' => ['title' => '复制任务状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_IDLE'], 'CreateTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727162332'], 'LastModifyTime' => ['title' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727164655'], 'Rule' => ['title' => '数据湖元数据转换规则', '$ref' => '#/components/schemas/DataLakeStorageTransferJobRule'], 'ProgressInfo' => [ 'title' => '任务进度', 'type' => 'object', 'properties' => [ 'Percent' => ['title' => '任务进度百分比', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], ], ], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'DataLakeStorageTransferJob' => [ 'title' => '数据湖元数据转换任务配置信息', 'description' => '数据湖元数据转换任务配置信息', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '任务ID', 'type' => 'string', 'example' => 'abcdef87e3c04af2af290ec52d123456'], 'HistoryId' => ['title' => '上一次触发的历史任务ID', 'type' => 'string', 'example' => 'abcdef87e3c04af2af290ec52d123456'], 'Bucket' => ['title' => 'Bucket名称', 'type' => 'string', 'example' => 'bucket1'], 'Type' => ['title' => '复制任务类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Status' => ['title' => '复制任务状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_IDLE'], 'CreateTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727162332'], 'LastModifyTime' => ['title' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1727164655'], 'Rule' => ['title' => '数据湖元数据转换规则', '$ref' => '#/components/schemas/DataLakeStorageTransferJobRule'], 'ProgressInfo' => [ 'title' => '任务进度', 'type' => 'object', 'properties' => [ 'Percent' => ['title' => '任务进度百分比', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], ], ], ], ], ], ], 'example' => '', ], 'DataLakeStorageTransferJobHistory' => [ 'title' => '', 'description' => '数据湖元数据转换历史任务', 'type' => 'object', 'properties' => [ 'JobId' => ['title' => '历史任务ID', 'type' => 'string', 'example' => '43452'], 'Id' => ['title' => '数据湖元数据转换任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'Status' => ['title' => '任务状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_SUCCESS'], 'StartTime' => ['title' => '任务开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1731830653'], 'EndTime' => ['title' => '任务结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1731830653'], 'TotalCount' => ['title' => '待转换的文件总数', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'SucceedCount' => ['title' => '转换成功的文件数', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], 'DetailInfo' => [ 'title' => '详细信息', 'type' => 'object', 'properties' => [ 'HDFSTransferJobId' => ['title' => 'HDFS转化任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'HDFSTransferDataDir' => ['title' => 'HDFS数据路径', 'type' => 'string', 'example' => 'abc/'], 'HDFSTransferImportMetaDir' => ['title' => 'HDFS元数据路径', 'type' => 'string', 'example' => 'meta-dta/'], 'HDFSTransferErrInfoDir' => ['title' => 'HDFS错误信息路径', 'type' => 'string', 'example' => 'hdfs-error/'], 'LogBaseDir' => ['title' => '日志存放路径', 'type' => 'string', 'example' => 'hdfs-logs/'], 'HDFSFailedCount' => ['title' => '失败文件个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'ErrorMsg' => ['title' => '错误信息', 'type' => 'string', 'example' => 'NotSupported'], 'VerifyTotalCount' => ['title' => '校验总数', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], 'VerifyStatus' => ['title' => '当前校验状态', 'type' => 'string', 'example' => 'VERIFY_SUCCEED'], 'VerifyErrInfoDir' => ['title' => '校验错误信息路径', 'type' => 'string', 'example' => 'verify-error/'], ], ], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'DataLakeStorageTransferJobHistory' => [ 'title' => '数据湖元数据转换任务', 'description' => '数据湖元数据转换历史任务', 'type' => 'object', 'properties' => [ 'JobId' => ['title' => '历史任务ID', 'type' => 'string', 'example' => '43452'], 'Id' => ['title' => '数据湖元数据转换任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'Status' => ['title' => '任务状态', 'type' => 'string', 'example' => 'REPLICATION_JOB_SUCCESS'], 'StartTime' => ['title' => '任务开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1731830653'], 'EndTime' => ['title' => '任务结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1731830653'], 'TotalCount' => ['title' => '待转换的文件总数', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'SucceedCount' => ['title' => '转换成功的文件数', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], 'DetailInfo' => [ 'title' => '详细信息', 'type' => 'object', 'properties' => [ 'HDFSTransferJobId' => ['title' => 'HDFS转化任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'HDFSTransferDataDir' => ['title' => 'HDFS数据路径', 'type' => 'string', 'example' => 'abc/'], 'HDFSTransferImportMetaDir' => ['title' => 'HDFS元数据路径', 'type' => 'string', 'example' => 'meta-dta/'], 'HDFSTransferErrInfoDir' => ['title' => 'HDFS错误信息路径', 'type' => 'string', 'example' => 'hdfs-error/'], 'LogBaseDir' => ['title' => '日志存放路径', 'type' => 'string', 'example' => 'hdfs-logs/'], 'HDFSFailedCount' => ['title' => '失败文件个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'ErrorMsg' => ['title' => '错误信息', 'type' => 'string', 'example' => 'NotSupported'], 'VerifyTotalCount' => ['title' => '校验总数', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], 'VerifyStatus' => ['title' => '当前校验状态', 'type' => 'string', 'example' => 'VERIFY_SUCCEED'], 'VerifyErrInfoDir' => ['title' => '校验错误信息路径', 'type' => 'string', 'example' => 'verify-error/'], ], ], ], 'parseType' => 'struct', ], ], ], 'example' => '', ], 'DataLakeStorageTransferJobHistoryId' => [ 'title' => '', 'description' => '数据湖元数据转换历史任务ID', 'type' => 'object', 'properties' => [ 'HistoryId' => ['title' => '数据湖元数据转换历史任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'DataLakeStorageTransferJobHistoryId' => [ 'title' => '数据湖元数据转换历史任务ID', 'description' => '数据湖元数据转换历史任务ID', 'type' => 'object', 'properties' => [ 'HistoryId' => ['title' => '数据湖元数据转换历史任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], ], ], ], ], 'example' => '', ], 'DataLakeStorageTransferJobId' => [ 'title' => '', 'description' => '数据湖元数据转换任务ID', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '数据湖元数据转换任务ID', 'type' => 'string', 'example' => 'abcde787e3c04af2af290ec52d123456'], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'DataLakeStorageTransferJobId' => [ 'title' => '数据湖元数据转换任务ID', 'description' => '数据湖元数据转换任务ID', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '数据湖元数据转换任务ID', 'type' => 'string', 'example' => 'abcde787e3c04af2af290ec52d123456'], ], ], ], ], 'example' => '', ], 'DataLakeStorageTransferJobRule' => [ 'title' => '数据湖元数据转换规则', 'description' => '数据湖元数据转换任务规则', 'type' => 'object', 'properties' => [ 'PrefixFilter' => [ 'title' => '文件前缀过滤规则', 'type' => 'object', 'properties' => [ 'Includes' => [ 'title' => '待转换的文件前缀列表', 'type' => 'object', 'properties' => [ 'Include' => [ 'title' => '待转换的文件前缀列表', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'abc/'], ], ], ], ], ], 'Tag' => ['title' => '规则标签', 'type' => 'string', 'example' => 'tag'], 'ExecutorRoleId' => ['title' => '授权角色', 'type' => 'string', 'example' => 'AliyunOSSRole'], 'LogBaseDir' => ['title' => '日志存放路径', 'type' => 'string', 'example' => 'log/'], 'NeedVerify' => ['title' => '是否开启校验', 'type' => 'boolean', 'example' => 'false'], ], ], 'DataLakeStorageTransferJobs' => [ 'title' => '', 'description' => '数据湖元数据转换任务列表', 'type' => 'object', 'properties' => [ 'Truncated' => ['title' => '结果是否有截断', 'type' => 'string', 'example' => 'false'], 'NextMarkerBucket' => ['title' => '结果的下一个Bucket标记', 'type' => 'string', 'example' => 'test-bucket'], 'NextMarkerJobId' => ['title' => '结果的下一个任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'DataLakeStorageTransferJob' => [ 'title' => '数据湖元数据转换任务列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/DataLakeStorageTransferJob'], ], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'DataLakeStorageTransferJobs' => [ 'title' => '数据湖元数据转换任务列表', 'description' => '数据湖元数据转换任务列表', 'type' => 'object', 'properties' => [ 'Truncated' => ['title' => '结果是否有截断', 'type' => 'string', 'example' => 'false'], 'NextMarkerBucket' => ['title' => '结果的下一个Bucket标记', 'type' => 'string', 'example' => 'test-bucket'], 'NextMarkerJobId' => ['title' => '结果的下一个任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456'], 'DataLakeStorageTransferJob' => [ 'title' => '数据湖元数据转换任务列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/DataLakeStorageTransferJob'], ], ], ], ], ], 'example' => '', ], 'DataRedundancyType' => [ 'title' => '', 'description' => 'The data redundancy type of the bucket. Valid values:'."\n" ."\n" .'- LRS (default): locally redundant storage. Your data is redundantly stored on different storage devices within the same zone. Data remains accessible even if two storage devices fail simultaneously.'."\n" .'- ZRS: zone-redundant storage. Your data is redundantly stored across three zones within the same region using a multi-zone mechanism. Data remains accessible even if an entire zone (data center) becomes unavailable due to events such as power outages or fires.'."\n" .'> Archive buckets do not support zone-redundant storage.', 'type' => 'string', 'example' => 'LRS', 'default' => 'LRS', 'enum' => ['LRS', 'ZRS'], ], 'Delete' => [ 'title' => '', 'description' => 'The container that stores the DeleteMultipleObjects request.', 'type' => 'object', 'properties' => [ 'Quiet' => ['title' => '', 'description' => 'Specifies whether to enable the quiet response mode.'."\n" .'DeleteMultipleObjects provides the following two response modes:'."\n" .' - Quiet mode: OSS does not return a message body.'."\n" .' - Verbose mode: The message body returned by OSS contains the results of all deleted objects. Verbose mode is used by default.'."\n" ."\n" .'Valid values: **true** (enables quiet mode), **false** (enables Verbose mode).'."\n" .'Default value: **false**.', 'type' => 'boolean', 'example' => 'false'], 'Object' => [ 'title' => '', 'description' => 'The container that stores the information about an object.', 'type' => 'array', 'items' => ['description' => '对象标识符。', '$ref' => '#/components/schemas/ObjectIdentifier', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'DeletedObject' => [ 'title' => '', 'description' => 'The container for Objects that were successfully deleted.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The name of the deleted Object.', 'type' => 'string', 'example' => 'multipart.data'], 'DeleteMarker' => [ 'title' => '', 'description' => 'Indicates whether the version is a delete marker. Valid values:'."\n" .'- true: The version is a delete marker.'."\n" .'- false: The version is not a delete marker.'."\n" .'> This element is returned only when a delete marker is created or permanently deleted, and the value is true.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'DeleteMarkerVersionId' => ['title' => '', 'description' => 'The version ID of the delete marker.', 'type' => 'string', 'example' => 'CAEQMhiBgIDB3aWB0BYiIGUzYTA3YzliMzVmNzRkZGM5NjllYTVlMjYyYWEy****'], 'VersionId' => ['title' => '', 'description' => 'The version ID of the Object.', 'type' => 'string', 'example' => 'CAEQNRiBgIDyz.6C0BYiIGQ2NWEwNmVhNTA3ZTQ3MzM5ODliYjM1ZTdjYjA4****'], ], 'example' => '', ], 'DeleteMarkerEntry' => [ 'title' => '', 'description' => 'The container that stores information about the delete marker.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The name of the object.', 'type' => 'string', 'example' => 'example'], 'VersionId' => ['title' => '', 'description' => 'The version ID of the object.', 'type' => 'string', 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****'], 'IsLatest' => [ 'title' => '', 'description' => 'Indicates whether the object is the current version. Valid values:'."\n" ."\n" .'- true: The object is the current version.'."\n" ."\n" .'- false: The object is not the current version.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', 'default' => 'false', ], 'LastModified' => ['title' => '', 'description' => 'The time when the object was last modified.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-04-09T07:27:28.000Z'], 'Owner' => ['description' => 'The container that stores the information about the bucket owner.', '$ref' => '#/components/schemas/Owner', 'title' => '', 'example' => ''], ], 'example' => '', ], 'EncodeType' => [ 'title' => '', 'description' => 'Specifies the encoding type used in the response. If the encoding-type parameter is specified in the request, the Key values in the response are encoded.', 'type' => 'string', 'example' => 'url', 'enum' => ['url'], ], 'Endpoint' => ['title' => '', 'description' => 'The endpoint.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com'], 'Error' => [ 'title' => '', 'description' => 'The error responses.', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'AccessDenied'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Anonymous user has no right to access this bucket.'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '654D97A16F8C26383287EAAF'], 'HostId' => ['title' => '', 'description' => 'The OSS domain name used to access the service.', 'type' => 'string', 'example' => 'example-bucket.oss-cn-hangzhou.aliyuncs.com'], ], 'example' => '', ], 'ErrorDocument' => [ 'title' => '', 'description' => 'The container for the 404 page.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The error page.', 'type' => 'string', 'example' => 'error.html'], 'HttpStatus' => ['title' => '', 'description' => 'The HTTP status code returned with the error page.', 'type' => 'integer', 'format' => 'int64', 'example' => '404'], ], 'example' => '', ], 'EventNotificationConfiguration' => [ 'title' => '', 'description' => 'The bucket event notification configuration.', 'type' => 'object', 'properties' => [ 'FunctionComputeConfiguration' => [ 'title' => '', 'description' => 'The Function Compute event notification configuration of the bucket.', 'type' => 'array', 'items' => ['description' => '函数计算配置', '$ref' => '#/components/schemas/FunctionComputeConfiguration', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ExtendWormConfiguration' => [ 'title' => '', 'description' => 'The root node.', 'type' => 'object', 'properties' => [ 'RetentionPeriodInDays' => ['title' => '', 'description' => 'The retention period of the object, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '366'], ], 'example' => '', ], 'FileGroupInfo' => [ 'title' => 'FileGroup文件类型的信息', 'description' => 'FileGroup类型文件的信息', 'type' => 'object', 'properties' => [ 'FilePart' => [ 'title' => '保存文件中每个Part信息的容器', 'description' => 'FileGroup类型文件的信息', 'type' => 'object', 'properties' => [ 'Part' => [ 'title' => 'FileGroup文件每个Part的信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PartNumber' => ['title' => 'Part的序号', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'PartName' => ['title' => 'Part的文件名', 'type' => 'string', 'example' => 'test.txt'], 'ETag' => ['title' => 'Part的ETag', 'type' => 'string', 'example' => '"EB327B57BB20D17C293A966115FE27BD"'], 'PartSize' => ['title' => 'Part的大小', 'type' => 'integer', 'format' => 'int64', 'example' => '38'], ], ], ], ], ], 'Bucket' => ['title' => '所属存储空间的名称', 'type' => 'string', 'example' => 'test-bucket'], 'Key' => ['title' => '文件的名称', 'type' => 'string', 'example' => 'file-goup-example'], 'ETag' => ['title' => '文件的ETag', 'type' => 'string', 'example' => '"06A4DDABDD5F65868B8C5919E76487D6"'], 'FileLength' => ['title' => '文件的大小', 'type' => 'integer', 'format' => 'int64', 'example' => '284'], ], ], 'FileHeaderInfo' => [ 'title' => '', 'description' => 'The file header of the CSV file (optional). Valid values:'."\n" .'- Use: The CSV file has a file header, and you can use CSV column names as column names in Select.'."\n" .'- Ignore: The CSV file has a file header, but CSV column names are not active as column names in Select.'."\n" .'- None: The file has no file header. This is the default value.'."\n" ."\n", 'type' => 'string', 'example' => 'Use', 'enum' => ['USE', 'IGNORE', 'NONE'], ], 'FunctionComputeConfiguration' => [ 'title' => '', 'description' => 'The Function Compute service configuration item.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The configuration item ID.', 'type' => 'string', 'example' => '1'], 'Event' => [ 'title' => '', 'description' => 'The event list.', 'type' => 'array', 'items' => ['description' => '事件名称', 'type' => 'string', 'example' => 'ObjectCreated:PutObject', 'title' => ''], 'example' => '', ], 'Filter' => [ 'title' => '', 'description' => 'The object filter configuration.', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '', 'description' => 'Object过滤配置键', 'type' => 'object', 'properties' => [ 'Prefix' => ['title' => '', 'description' => 'Object前缀', 'type' => 'string', 'example' => 'prod'], 'Suffix' => ['title' => '', 'description' => 'Object后缀', 'type' => 'string', 'example' => '.jpb'], ], 'example' => '', ], ], 'example' => '', ], 'Function' => [ 'title' => '', 'description' => 'The Function Compute configuration.', 'type' => 'object', 'properties' => [ 'Arn' => ['title' => '', 'description' => '请求的函数计算服务资源', 'type' => 'string', 'example' => 'acs:fc:oss-ap-southeast-1:1993989758795198:services/qianwang-fc-test.LATEST/functions/fc-test'], 'AssumeRole' => ['title' => '', 'description' => '向函数计算请求服务的角色', 'type' => 'string', 'example' => 'acs:ram::1993989758795198:role/AliyunOSSObjectFcForOSSDefaultRole'], ], 'example' => '', ], ], 'example' => '', ], 'GetAccessPointResult' => [ 'title' => '', 'description' => 'The container that stores access point information.', 'type' => 'object', 'properties' => [ 'AccessPointName' => ['description' => 'The name of the access point.', '$ref' => '#/components/schemas/AccessPointName', 'title' => '', 'example' => ''], 'Bucket' => ['title' => '', 'description' => 'The name of the bucket for which the access point is configured.', 'type' => 'string', 'example' => 'example-bucket'], 'AccountId' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account for which the access point is configured.', 'type' => 'string', 'example' => '10378****8768'], 'NetworkOrigin' => ['title' => '', 'description' => 'The network origin of the access point. Valid values:'."\n" ."\n" .'- vpc: Only access through the specified VPC ID is allowed.'."\n" .'- internet: Access through both Internet and internal network endpoints is allowed.', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', 'example' => ''], 'VpcConfiguration' => ['title' => '', 'description' => 'The container that stores VPC network origin information.', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', 'example' => ''], 'AccessPointArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the access point.', '$ref' => '#/components/schemas/AccessPointArn', 'title' => '', 'example' => ''], 'Alias' => ['description' => 'The alias of the access point.', '$ref' => '#/components/schemas/AccessPointAlias', 'title' => '', 'example' => ''], 'Status' => ['description' => 'The status of the access point.', '$ref' => '#/components/schemas/AccessPointStatus', 'title' => '', 'example' => ''], 'Endpoints' => [ 'title' => '', 'description' => 'The container that stores the network origin information of the access point.', 'type' => 'object', 'properties' => [ 'PublicEndpoint' => ['title' => '', 'description' => '接入点的外网Endpoint。', '$ref' => '#/components/schemas/Endpoint', 'example' => ''], ], 'example' => '', ], 'InternalEndpoint' => ['title' => '', '$ref' => '#/components/schemas/Endpoint', 'description' => '', 'example' => ''], ], 'example' => '', ], 'GetBucketProcessConfiguration' => [ 'title' => '存储空间图片处理配置', 'description' => 'Bucket图片处理通道配置', 'type' => 'object', 'properties' => [ 'Version' => ['title' => '版本', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'CompliedHost' => ['title' => '域名', 'type' => 'string', 'example' => 'Img'], 'SourceFileProtect' => ['title' => '原图保护', 'type' => 'string', 'example' => 'Disabled'], 'SourceFileProtectSuffix' => ['title' => '原图保护后缀', 'type' => 'string', 'example' => '.jpg'], 'StyleDelimiters' => ['title' => '央视分隔符', 'type' => 'string', 'example' => '-,_,/,!'], 'BucketChannelConfig' => ['title' => '存储空间图片处理频道配置', '$ref' => '#/components/schemas/BucketChannelConfig'], 'LastModified' => ['title' => '最后修改时间', 'type' => 'string', 'example' => '2024-10-18T09:51:54.000Z'], ], ], 'GetChannelResult' => [ 'title' => '保存图片处理频道信息的容器', 'description' => 'xxx', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '存储空间名称', 'type' => 'string', 'example' => 'test-bucket'], 'Status' => ['title' => '图片处理频道的状态', 'type' => 'string', 'example' => 'enble'], 'OrigPicForbidden' => ['title' => '是否禁止原图访问', 'type' => 'boolean', 'example' => 'false'], 'UseSrcFormat' => ['title' => '是否使用源格式', 'type' => 'boolean', 'example' => 'false'], 'SetAttachName' => ['title' => '是否设置Content-Disposition: attachment响应头', 'type' => 'boolean', 'example' => 'true'], 'UseStyleOnly' => ['title' => '是否仅允许通过样式进行图片处理', 'type' => 'boolean', 'example' => 'true'], 'AutoSetContentType' => ['title' => '是否自动设置 Content-Type', 'type' => 'boolean', 'example' => 'false'], 'Default404Pic' => ['title' => '默认404图片', 'type' => 'string', 'example' => '404.jpg'], 'StyleDelimiters' => ['title' => '样式分隔符', 'type' => 'string', 'example' => '-,|'], 'CreateTime' => ['title' => '创建时间', 'type' => 'string', 'example' => 'Fri, 15 Nov 2024 08:11:56 GMT'], 'LastModifyTime' => ['title' => '最后修改时间', 'type' => 'string', 'example' => 'Fri, 15 Nov 2024 08:11:56 GMT'], ], ], 'GetObjectInfoResult' => [ 'title' => '保存对象信息的容器', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '对象所属存储空间的名称', 'type' => 'string', 'example' => 'test-bucket'], 'Type' => ['title' => '对象类型', 'type' => 'string', 'example' => 'Multipart'], 'Key' => ['title' => '对象名称', 'type' => 'string', 'example' => 'test.txt'], 'EncryptFlag' => ['title' => '对象加密类型', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'LastModified' => ['title' => '对象最后一次修改时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2024-11-08T10:02:11.000Z'], 'ETag' => ['title' => '对象ETag', 'type' => 'string', 'example' => '"EB327B57BB20D17C293A966115FE27BD"'], 'HashCrc64ecma' => ['title' => '对象CRC64', 'type' => 'string', 'example' => '7866203970082294162'], 'StorageClass' => ['title' => '对象存储类型', 'type' => 'string', 'example' => 'Standard'], 'Content-Type' => ['title' => '对象文件类型', 'type' => 'string', 'example' => 'text/plain'], 'Size' => ['title' => '对象大小', 'type' => 'string', 'example' => '78'], 'UploadId' => ['title' => '分片上传的UploadId', 'type' => 'string', 'example' => 'C5DD87C5E7CD482F8F2C3D63904DA228'], ], ], 'GetResourcePoolInfoResp' => [ 'title' => '获取资源池信息的响应体', 'description' => '获取资源池信息的响应体', 'type' => 'object', 'properties' => [ 'Region' => ['title' => '资源池所在地域', 'type' => 'string', 'example' => 'oss-cn-shanghai'], 'Name' => ['title' => '资源池名称', 'type' => 'string', 'example' => 'rp-for-ai'], 'Owner' => ['title' => '资源池所有者', 'type' => 'string', 'example' => '1234567890987'], 'CreateTime' => ['title' => '资源池创建时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2024-07-24T08:42:32.000Z'], 'QosConfiguration' => ['title' => '资源池QoS配置信息', '$ref' => '#/components/schemas/QoSConfiguration'], ], ], 'GetResourcePoolInfoResponse' => [ 'title' => '', 'description' => 'The response body for retrieving resource pool information.', 'type' => 'object', 'properties' => [ 'Region' => ['title' => '', 'description' => 'The region where the resource pool resides.', 'type' => 'string', 'example' => 'oss-cn-shanghai'], 'Name' => ['title' => '', 'description' => 'The name of the resource pool.', 'type' => 'string', 'example' => 'rp-for-ai'], 'Owner' => ['title' => '', 'description' => 'The owner of the resource pool.', 'type' => 'string', 'example' => '1234567890987'], 'CreateTime' => ['title' => '', 'description' => 'The time when the resource pool was created.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2024-07-24T08:42:32.000Z'], 'QosConfiguration' => ['title' => '', 'description' => 'The QoS configuration of the resource pool.', '$ref' => '#/components/schemas/QoSConfiguration', 'example' => ''], ], 'example' => '', ], 'Grant' => ['description' => 'The access control list (ACL) of the bucket.', '$ref' => '#/components/schemas/ObjectACL', 'title' => '', 'example' => ''], 'HttpsConfiguration' => [ 'title' => '', 'description' => 'The TLS version configuration of the bucket.', 'type' => 'object', 'properties' => [ 'TLS' => [ 'title' => '', 'description' => 'The TLS version configuration of the bucket.', 'type' => 'object', 'properties' => [ 'Enable' => [ 'title' => '', 'description' => 'Specifies whether TLS version configuration is enabled.', 'enumValueTitles' => ['true' => 'TLS version configuration is enabled.', 'false' => 'TLS version configuration is disabled.'], 'type' => 'boolean', 'required' => true, 'example' => 'true', ], 'TLSVersion' => [ 'title' => '', 'description' => 'The list of TLS versions.', 'type' => 'array', 'items' => [ 'description' => 'The TLS version.', 'enumValueTitles' => ['TLSv1.3' => 'TLSv1.3', 'TLSv1.2' => 'TLSv1.2', 'TLSv1.1' => 'TLSv1.1', 'TLSv1.0' => 'TLSv1.0'], 'type' => 'string', 'example' => 'TLSv1.2', 'title' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'IncrementalInventory' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'IsEnabled' => ['title' => '', 'type' => 'boolean', 'example' => 'true', 'description' => ''], 'Schedule' => ['title' => '', '$ref' => '#/components/schemas/IncrementInventorySchedule', 'description' => '', 'example' => ''], 'OptionalFields' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'Etag', 'description' => '', 'title' => ''], 'description' => '', 'example' => '', ], ], 'description' => '', 'example' => '', ], ], 'description' => '', 'example' => '', ], 'IncrementInventorySchedule' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Frequency' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'description' => ''], ], 'description' => '', 'example' => '', ], 'IndexDocument' => [ 'title' => '', 'description' => 'The container for the default homepage.', 'type' => 'object', 'properties' => [ 'Suffix' => ['title' => '', 'description' => 'The default homepage.', 'type' => 'string', 'example' => 'index.html'], 'SupportSubDir' => [ 'title' => '', 'description' => 'Specifies whether to redirect to the default homepage in the subdirectory when a subdirectory is accessed. Valid values:'."\n" .' - **true**: Redirects to the default homepage in the subdirectory.'."\n" .' - **false** (default): Does not redirect to the default homepage in the subdirectory. Instead, redirects to the default homepage in the root directory.'."\n" ."\n" .'For example, assume the default homepage is index.html and you want to access `bucket.oss-ap-southeast-1.aliyuncs.com/subdir/`. If **SupportSubDir** is set to false, the request is redirected to `bucket.oss-ap-southeast-1.aliyuncs.com/index.html`. If **SupportSubDir** is set to true, the request is redirected to `bucket.oss-ap-southeast-1.aliyuncs.com/subdir/index.html`.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'Type' => ['title' => '', 'description' => 'The behavior when the default homepage is set, 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. This parameter takes effect after RoutingRule but before ErrorFile.'."\n" .'For example, assume the default homepage is index.html, the file path to access is `bucket.oss-ap-southeast-1.aliyuncs.com/abc`, and the object abc does not exist. The behaviors for different values of **Type** are as follows:'."\n" .' - **0** (default): Checks whether abc/index.html exists (in the format of `Object + forward slash (/) + homepage`). If it exists, a 302 response is returned with the Location header set to the URL-encoded form of `/abc/` (in the format of `forward slash (/) + Object + forward slash (/)`). If it does not exist, a 404 response is returned, and ErrorFile is checked.'."\n" .' - **1**: Directly returns a 404 response with the NoSuchKey error, and ErrorFile is checked.'."\n" .' - **2**: Checks whether abc/index.html exists. If it exists, the content of the object is returned. If it does not exist, a 404 response is returned, and ErrorFile is checked.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], 'example' => '', ], 'InitiateWormConfiguration' => [ 'title' => '', 'description' => 'The root node.', 'type' => 'object', 'properties' => [ 'RetentionPeriodInDays' => ['title' => '', 'description' => 'The retention period of the object, in days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '365'], ], 'example' => '', ], 'InputSerialization' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'CompressionType' => ['description' => 'The file compression type. Currently, no compression is supported. The only valid value is None.', 'example' => 'None', '$ref' => '#/components/schemas/CompressionType', 'title' => ''], 'CSV' => ['description' => 'The CSV input format.', '$ref' => '#/components/schemas/CSVInput', 'title' => '', 'example' => ''], 'JSON' => ['description' => 'The JSON input format.', '$ref' => '#/components/schemas/JSONInput', 'title' => '', 'example' => ''], ], 'example' => '', ], 'InventoryConfiguration' => [ 'title' => '', 'description' => 'The container that stores the inventory configuration.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The custom inventory name. The inventory name must be unique within the current bucket.', 'type' => 'string', 'example' => 'report1'], 'IsEnabled' => [ 'title' => '', 'description' => 'Specifies whether to enable the inventory feature. Valid values:'."\n" ."\n" .'- true: enables the inventory feature.'."\n" .'- false: does not enable the inventory feature.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'Destination' => ['title' => '', 'description' => 'The container that stores the inventory results.', '$ref' => '#/components/schemas/InventoryDestination', 'example' => ''], 'Schedule' => ['title' => '', 'description' => 'The container that stores the inventory export frequency information.', '$ref' => '#/components/schemas/InventorySchedule', 'example' => ''], 'Filter' => ['title' => '', 'description' => 'The prefix used to filter the inventory. After you specify a prefix, the inventory filters objects that match the prefix.', '$ref' => '#/components/schemas/InventoryFilter', 'example' => ''], 'IncludedObjectVersions' => [ 'title' => '', 'description' => 'Specifies whether to include object version information in the inventory. Valid values:'."\n" ."\n" .'- All: exports all version information of objects.'."\n" ."\n" .'- Current: exports the current version information of objects.', 'enumValueTitles' => ['All' => 'All', 'Current' => 'Current'], 'type' => 'string', 'example' => 'All', ], 'OptionalFields' => [ 'title' => '', 'description' => 'The list of configuration items included in the inventory results.', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '', 'description' => '清单结果中包含的配置项。'."\n" .'可选的配置项包括:'."\n" ."\n" .'- Size:Object的大小。'."\n" .'- LastModifiedDate:Object的最后修改时间。'."\n" .'- ETag:Object的ETag值,用于标识Object的内容。'."\n" .'- StorageClass:Object的存储类型。'."\n" .'- IsMultipartUploaded:是否为通过分片上传方式上传的Object。'."\n" .'- EncryptionStatus:Object是否加密。'."\n" ."\n", 'type' => 'array', 'items' => ['description' => '清单结果中包含的配置项。', '$ref' => '#/components/schemas/InventoryOptionalField', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'IncrementalInventory' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/IncrementalInventory'], ], 'example' => '', ], 'InventoryDestination' => [ 'title' => '', 'description' => 'The information about the destination where inventory results are stored.', 'type' => 'object', 'properties' => [ 'OSSBucketDestination' => ['title' => '', 'description' => 'The information about the bucket where inventory results are exported and stored.', '$ref' => '#/components/schemas/InventoryOSSBucketDestination', 'example' => ''], ], 'example' => '', ], 'InventoryEncryption' => [ 'title' => '', 'description' => 'The encryption method of the inventory list file.', 'type' => 'object', 'properties' => [ 'SSE-OSS' => ['title' => '', 'description' => 'The container that stores the SSE-OSS encryption method.', '$ref' => '#/components/schemas/SSEOSS', 'example' => ''], 'SSE-KMS' => ['title' => '', 'description' => 'The container that stores the SSE-KMS encryption key.', '$ref' => '#/components/schemas/SSEKMS', 'example' => ''], ], 'example' => '', ], 'InventoryFilter' => [ 'title' => '', 'description' => 'The prefix used for inventory filtering. After you specify a prefix, the inventory filters objects that match the prefix.', 'type' => 'object', 'properties' => [ 'Prefix' => ['title' => '', 'description' => 'The matching prefix of the filter rule.', 'type' => 'string', 'example' => 'Pics/'], 'LastModifyBeginTimeStamp' => ['title' => '', 'description' => 'The start timestamp for filtering objects by last modified time. Unit: seconds. Valid values: [1262275200, 253402271999].', 'type' => 'integer', 'format' => 'int64', 'example' => '1637883649'], 'LastModifyEndTimeStamp' => ['title' => '', 'description' => 'The end timestamp for filtering objects by last modified time. Unit: seconds. Valid values: [1262275200, 253402271999].', 'type' => 'integer', 'format' => 'int64', 'example' => '1638347592'], 'LowerSizeBound' => ['title' => '', 'description' => 'The minimum size of objects to filter. Unit: bytes. Valid values: greater than or equal to 0 bytes and less than or equal to 48.8 TB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], 'UpperSizeBound' => ['title' => '', 'description' => 'The maximum size of objects to filter. Unit: bytes. Valid values: greater than 0 bytes and less than or equal to 48.8 TB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576'], 'StorageClass' => ['title' => '', 'description' => 'The storage class of objects to filter. You can specify multiple storage classes. Valid values:'."\n" .'- Standard: Standard.'."\n" .'- IA: Infrequent Access.'."\n" .'- Archive: Archive.'."\n" .'- ColdArchive: Cold Archive.'."\n" .'- All (default): all storage classes.', 'type' => 'string', 'example' => 'All'], ], 'example' => '', ], 'InventoryFormat' => [ 'title' => '', 'description' => 'Valid values: CSV.', 'type' => 'string', 'example' => 'CSV', 'enum' => ['CSV'], ], 'InventoryFrequency' => [ 'title' => '', 'description' => 'The export cycle of inventory lists.'."\n" ."\n" .'Valid values:'."\n" .'- Daily: Exports inventory lists on a daily basis.'."\n" .'- Weekly: Exports inventory lists on a weekly basis.', 'enumValueTitles' => ['Daily' => 'Daily', 'Weekly' => 'Weekly'], 'type' => 'string', 'example' => 'Daily', 'enum' => ['Daily', 'Weekly'], ], 'InventoryIncludedObjectVersions' => [ 'title' => '', 'description' => 'Specifies whether to include object version information in the inventory list. Valid values:'."\n" ."\n" .'- All: Exports all versions of the object.'."\n" .'- Current: Exports the current version of the object.', 'enumValueTitles' => ['All' => 'All', 'Current' => 'Current'], 'type' => 'string', 'example' => 'All', 'enum' => ['All', 'Current'], ], 'InventoryOptionalField' => [ 'title' => '', 'description' => 'The configuration items included in the inventory results.'."\n" ."\n" .'- Size: the size of the object.'."\n" .'- LastModifiedDate: the last modified time of the object.'."\n" .'- ETag: the ETag value of the object, which identifies 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: specifies whether the object is encrypted.', 'type' => 'string', 'example' => 'Size', 'enum' => ['Size', 'LastModifiedDate', 'ETag', 'StorageClass', 'IsMultipartUploaded', 'EncryptionStatus'], ], 'InventoryOSSBucketDestination' => [ 'title' => '', 'description' => 'The bucket information for storing exported inventory results.', 'type' => 'object', 'properties' => [ 'Format' => ['title' => '', 'description' => 'The file format of the inventory list. The exported inventory list is a CSV file compressed by using GZIP.', '$ref' => '#/components/schemas/InventoryFormat', 'example' => ''], 'AccountId' => ['title' => '', 'description' => 'The account ID granted by the bucket owner.', 'type' => 'string', 'example' => '100000000000000'], 'RoleArn' => ['title' => '', 'description' => 'The name of the role that has permissions to read all objects from the source bucket and write objects to the destination bucket. Format: `acs:ram::uid:role/rolename`.', 'type' => 'string', 'example' => 'acs:ram::100000000000000:role/AliyunOSSRole'], 'Bucket' => ['title' => '', 'description' => 'The bucket that stores the exported inventory list.', 'type' => 'string', 'example' => 'acs:oss:::bucket_0001'], 'Prefix' => ['title' => '', 'description' => 'The storage path prefix of the inventory list.', 'type' => 'string', 'example' => 'prefix1/'], 'Encryption' => ['title' => '', 'description' => 'The encryption method of the inventory list.', '$ref' => '#/components/schemas/InventoryEncryption', 'example' => ''], ], 'example' => '', ], 'InventorySchedule' => [ 'title' => '', 'description' => 'Contains the frequency that inventory lists are exported.', 'type' => 'object', 'properties' => [ 'Frequency' => ['title' => '', 'description' => 'The frequency at which inventory lists are exported.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- Daily: Inventory lists are exported on a daily basis.'."\n" .'- Weekly: Inventory lists are exported on a weekly basis.', '$ref' => '#/components/schemas/InventoryFrequency', 'example' => 'Daily'], ], 'example' => '', ], 'JSONInput' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the input JSON.', 'enumValueTitles' => [' LINES' => ' LINES', 'DOCUMENT' => 'DOCUMENT'], 'example' => 'DOCUMENT', '$ref' => '#/components/schemas/JSONType', 'title' => '', ], 'Range' => [ 'title' => '', 'description' => 'The range of the file parameter query. This parameter is optional. The following two formats are supported:'."\n" .'> The file that you want parameter query by using the Range parameter must have select meta. For more information about select meta, see [CreateSelectObjectMeta](~~74054~~).'."\n" ."\n" .'- Query by row: line-range=start-end. For example, line-range=10-20 specifies to scan rows 10 through 20.'."\n" ."\n" .'- Query by split: split-range=start-end. For example, split-range=10-20 specifies to scan splits 10 through 20.'."\n" ."\n" .'
Both start and end are inclusive. The format is the same as the range parameter in range download.'."\n" .'
This parameter is used only when the document is in CSV format or the JSON Type is LINES.', 'enumValueTitles' => ['line-range=start-end' => 'line-range=start-end', 'split-range=start-end' => 'split-range=start-end'], 'type' => 'string', 'example' => 'line-range=start-end', ], 'ParseJsonNumberAsString' => [ 'title' => '', 'description' => 'Parses numbers (integers and floating-point numbers) in JSON as character strings. Floating-point numbers in JSON may experience precision loss during parsing. To fully preserve the raw data, use this options. If you need to perform numerical calculations, you can cast the values to the required format in SQL, such as int, double, or decimal.'."\n" .'
Default value: false.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], ], 'example' => '', ], 'JSONOutput' => [ 'title' => '', 'description' => 'The container that stores the results of the Select request.', 'type' => 'object', 'properties' => [ 'RecordDelimiter' => ['title' => '', 'description' => 'The line feed in Base64 encoding. The value before encoding can contain up to two characters, represented by the ANSI value of the character. For example, `'."\n" .'` is used in Java to represent a line feed.'."\n" .'
Default value: `'."\n" .'`.', 'type' => 'string', 'example' => '\\n'], ], 'example' => '', ], 'JSONType' => [ 'title' => '', 'description' => 'The type of the input JSON. Valid values:'."\n" .'- DOCUMENT: A single JSON object in the input data can span multiple lines.'."\n" .'- LINES: Each line in the input data contains a JSON object.', 'enumValueTitles' => ['DOCUMENT' => 'DOCUMENT', 'LINES' => 'LINES'], 'type' => 'string', 'example' => 'DOCUMENT', 'enum' => ['DOCUMENT', 'LINES'], ], 'LegalHold' => [ 'title' => '', 'description' => 'The legal hold status of the object.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'Valid values: ON and OFF, indicating whether legal hold is enabled for the object ', 'title' => '', 'type' => 'string', 'example' => 'ON'], ], 'example' => '', ], 'LifecycleConfiguration' => [ 'title' => '', 'description' => 'The container for lifecycle configurations. A maximum of 1,000 rules can be configured.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '', 'description' => 'The container for a lifecycle rule. The expiration time of an object must be later than the time when the object is transitioned to the Infrequent Access or Archive storage class.', 'type' => 'array', 'items' => ['description' => 'The container for a lifecycle rule. The expiration time of an object must be later than the time when the object is transitioned to the Infrequent Access or Archive storage class.', '$ref' => '#/components/schemas/LifecycleRule', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'LifecycleRule' => [ 'title' => '', 'description' => 'The container for lifecycle rules.'."\n" .' - Archive buckets do not support creating storage class conversion rules.'."\n" .' - The expiration time of an object must be later than the time when the object is converted to the Infrequent Access or Archive storage class.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The unique ID that identifies the rule. The ID can be up to 255 bytes in length. If you do not specify this parameter or leave it empty, OSS automatically generates a unique ID.', 'type' => 'string', 'required' => true, 'example' => 'rule1'], 'Prefix' => ['title' => '', 'description' => 'The prefix to which the rule applies. Prefix values must be unique.'."\n" .' - If a prefix is specified, the rule applies only to objects in the bucket that match the prefix.'."\n" .' - If the prefix is empty, the rule applies to all objects in the bucket.', 'type' => 'string', 'required' => false, 'example' => 'tmp/'], 'Status' => [ 'title' => '', 'description' => 'Specifies whether the rule is enabled. Valid values:'."\n" .'- Enabled: The rule is enabled. OSS periodically executes the rule.'."\n" .'- Disabled: The rule is disabled. OSS ignores the rule.', 'enumValueTitles' => ['Enabled' => 'Enabled', 'Disabled' => 'Disabled'], 'type' => 'string', 'required' => true, 'example' => 'Enabled', ], 'Expiration' => [ 'title' => '', 'description' => 'The expiration attributes of the lifecycle rule for objects. For versioning-enabled buckets, the specified expiration attributes apply only to the current version of objects.'."\n" .'
The expiration time of an object must be later than the time when the object is converted to the Infrequent Access or Archive storage class.', 'type' => 'object', 'properties' => [ 'CreatedBeforeDate' => ['title' => '', 'description' => '指定一个日期,OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期格式为yyyy-MM-ddT00:00:00.000Z。'."\n" .'
日期需要按照ISO8601标准表示并使用UTC时间,且必须为UTC的零点。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2002-10-11T00:00:00.000Z'], 'Days' => ['title' => '', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ExpiredObjectDeleteMarker' => [ 'title' => '', 'description' => '指定是否自动移除过期删除标记。'."\n" ."\n" .'- true:表示自动移除过期删除标记。取值为true时,不支持指定Days或CreatedBeforeDate。'."\n" ."\n" .'- false:表示不会自动移除过期删除标记。取值为false时,则必须指定Days或CreatedBeforeDate。', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '', ], 'Transition' => [ 'title' => '', 'description' => 'Specifies when OSS converts objects to the Infrequent Access, Archive, or Cold Archive storage class during their valid lifecycle.'."\n" .'Standard objects in a Standard bucket can be converted to the Infrequent Access, Archive, or Cold Archive storage class. The time to convert objects to the Archive storage class must be longer than the time to convert objects to the Infrequent Access storage class. For example, if the Days value of the Transition to Infrequent Access is set to 30, the Days value of the Transition to Archive must be greater than 30.'."\n" ."\n" .'> You can specify only one of Days and CreatedBeforeDate.', 'type' => 'array', 'items' => [ 'description' => '指定Object在有效生命周期中,OSS何时将Object转储为IA、Archive和ColdArchive存储类型 。'."\n" .'Standard Bucket中的Standard Object可以转储为IA、Archive或ColdArchive存储类型,但转储Archive存储类型的时间必须比转储IA存储类型的时间长。例如Transition'."\n" .'IA设置Days为30,Transition Archive设置Days必须大于30。'."\n" ."\n" .'> Days或CreatedBeforeDate只能二选一。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'CreatedBeforeDate' => ['title' => '', 'description' => '指定一个日期,OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期必须服从ISO8601的格式,且要求是UTC的零点。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2002-10-11T00:00:00.000Z'], 'Days' => ['title' => '', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'StorageClass' => [ 'title' => '', 'description' => '指定Object转储的存储类型。'."\n" ."\n" .'- IA:低频访问'."\n" .'- Archive:归档存储'."\n" .'- ColdArchive:冷归档存储'."\n" ."\n" .'> IA Bucket中的Object可以转储为Archive或者ColdArchive存储类型,但不支持转储为Standard存储类型。'."\n", 'enumValueTitles' => [], '$ref' => '#/components/schemas/StorageClass', 'example' => '', ], 'IsAccessTime' => ['title' => '', 'description' => '指定是否基于last access time匹配规则。取值如下:'."\n" ."\n" .'- true:采用Object的last access time(最后一次访问时间)匹配规则。'."\n" ."\n" .'- false(默认值):采用Object的last modify time(最后一次修改时间)匹配规则。', 'type' => 'boolean', 'example' => 'true'], 'ReturnToStdWhenVisit' => ['title' => '', 'description' => '指定Object转为非标准存储后,再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下:'."\n" ."\n" .'- true:Object由非标准存储转为标准存储。'."\n" ."\n" .'- false(默认值):Object仍为非标准存储。', 'type' => 'boolean', 'example' => 'true'], 'AllowSmallFile' => ['title' => '', 'description' => '基于最后一次访问时间设置生命周期规则时,指定是否将小于64 KB的Object转储为低频、归档、冷归档文件类型。取值如下:'."\n" ."\n" .'- true(默认值):转储包含小于64 KB在内的所有Object。当Object小于64 KB时,按照64 KB计算。当Object大于或等于64 KB时,按照实际大小计算。设置为true时,可能会增加存储费用。'."\n" ."\n" .'- false:不转储小于64 KB的Object。', 'type' => 'boolean', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'AbortMultipartUpload' => [ 'title' => '', 'description' => 'The expiration attributes for incomplete multipart uploads.', 'type' => 'object', 'properties' => [ 'Days' => ['title' => '', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'CreatedBeforeDate' => ['title' => '', 'description' => '指定一个日期,OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期必须服从ISO8601的格式,且要求是UTC的零点。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2002-10-11T00:00:00.000Z'], ], 'example' => '', ], 'Tag' => [ 'title' => '', 'description' => 'Settings of object tagging to which the rule applies. You can configure multiple labels.', 'type' => 'array', 'items' => ['description' => '指定规则所适用的对象标签,可设置多个。'."\n", '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], 'example' => '', ], 'NoncurrentVersionExpiration' => [ 'title' => '', 'description' => 'The expiration attributes of the lifecycle rule for noncurrent versions of objects.', 'type' => 'object', 'properties' => [ 'NoncurrentDays' => ['title' => '', 'description' => '指定生命周期规则在Object成为非当前版本多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], 'example' => '', ], 'NoncurrentVersionTransition' => [ 'title' => '', 'description' => 'Specifies when OSS converts noncurrent versions of objects to the Infrequent Access or Archive storage class during the valid lifecycle rule.'."\n" .'The time to convert Standard objects to the Archive storage class must be longer than the time to convert them to the Infrequent Access storage class.', 'type' => 'array', 'items' => [ 'description' => '在有效的生命周期规则中,OSS何时将指定Object的非当前版本转储为IA或者Archive存储类型 。'."\n" .'Standard类型的Object转储为Archive类型的时间必须大于转储为IA类型的时间。'."\n", 'type' => 'object', 'properties' => [ 'NoncurrentDays' => ['title' => '', 'description' => '指定生命周期规则在Object成为非当前版本多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'StorageClass' => [ 'title' => '', 'description' => '指定Object转储的存储类型。'."\n" ."\n" .'- IA:低频访问'."\n" .'- Archive:归档存储'."\n" .'- ColdArchive:冷归档存储'."\n" ."\n" .'> IA Bucket中的Object可以转储为Archive或者ColdArchive存储类型,但不支持转储为Standard存储类型。'."\n", 'enumValueTitles' => [], '$ref' => '#/components/schemas/StorageClass', 'example' => '', ], 'IsAccessTime' => ['title' => '', 'description' => '指定是否基于last access time匹配规则。取值如下:'."\n" ."\n" .'- true:采用Object的last access time(最后一次访问时间)匹配规则。'."\n" ."\n" .'- false(默认值):采用Object的last modify time(最后一次修改时间)匹配规则。', 'type' => 'boolean', 'example' => 'true'], 'ReturnToStdWhenVisit' => ['title' => '', 'description' => '指定Object转为非标准存储后,再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下:'."\n" ."\n" .'- true:Object由非标准存储转为标准存储。'."\n" ."\n" .'- false(默认值):Object仍为非标准存储。', 'type' => 'boolean', 'example' => 'true'], 'AllowSmallFile' => ['title' => '', 'description' => '基于最后一次访问时间设置生命周期规则时,指定是否将小于64 KB的Object转储为低频、归档、冷归档文件类型。取值如下:'."\n" ."\n" .'- true(默认值):转储包含小于64 KB在内的所有Object。当Object小于64 KB时,按照64 KB计算。当Object大于或等于64 KB时,按照实际大小计算。设置为true时,可能会增加存储费用。'."\n" ."\n" .'- false:不转储小于64 KB的Object。', 'type' => 'boolean', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Filter' => [ 'title' => '', 'description' => 'The exclusion conditions for this rule.', 'type' => 'object', 'properties' => [ 'Not' => [ 'title' => '', 'description' => '满足何种规则跳过。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Prefix' => ['title' => '', 'description' => '本条排除规则所适用的Object前缀。不可为空。 如果Rule节点下配置了Prefix,则Not节点下的Prefix必须以Rule节点下的Prefix为前缀。例如,Rule节点下配置的Prefix为dir,则Not节点下的Prefix必须以dir开头,例如dir1、dir2等。 如果Not节点下未配置Tag,则Not节点下配置的Prefix不能和Rule节点下的Prefix相同。', 'type' => 'string', 'example' => 'logs/keep/'], 'Tag' => ['title' => '', 'description' => '本条排除规则所适用的Object标签,至多一个,可置空。', '$ref' => '#/components/schemas/Tag', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ObjectSizeGreaterThan' => ['title' => '', 'description' => '本条生命周期规则只对文件大小大于该值的文件生效', 'type' => 'integer', 'format' => 'int64', 'example' => '10240'], 'ObjectSizeLessThan' => ['title' => '', 'description' => '本条生命周期规则只对文件大小小于该值的文件生效', 'type' => 'integer', 'format' => 'int64', 'example' => '10240'], ], 'example' => '', ], 'AtimeBase' => ['title' => '', 'description' => 'The timestamp when access tracking is enabled for the bucket.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626158525'], ], 'example' => '', ], 'ListAccessPointsResult' => [ 'title' => '', 'description' => 'The container that stores the results of listing access point information.', 'type' => 'object', 'properties' => [ 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether the results returned in the request are truncated. Valid values: true: Not all results are returned in this request. false: All results are returned in this request.', 'type' => 'string', 'example' => 'true'], 'NextContinuationToken' => ['title' => '', 'description' => 'Indicates that this ListAccessPoints request contains subsequent results. Set continuation-token to the value of NextContinuationToken to continue retrieving results.', 'type' => 'string', 'example' => 'abc**'], 'AccountId' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account to which the access point belongs.', 'type' => 'string', 'example' => '10107***1448150'], 'AccessPoints' => [ 'title' => '', 'description' => 'The container that stores all access point information.', 'type' => 'object', 'properties' => [ 'AccessPoint' => [ 'title' => '', 'description' => '保存接入点信息的列表。', 'type' => 'array', 'items' => ['description' => '保存接入点的详细信息。', '$ref' => '#/components/schemas/AccessPoint', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'MaxKeys' => ['title' => '', 'description' => 'The maximum number of results configured for this listing operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ListAllMyCacheResult' => [ 'title' => '保存加速器列举结果的容器', 'description' => '加速器列举结果', 'type' => 'object', 'properties' => [ 'Caches' => [ 'title' => '保存加速器列表的容器', 'type' => 'object', 'properties' => [ 'Cache' => [ 'title' => '加速器结果列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/CacheBaseInfo'], ], ], ], 'Owner' => ['title' => '加速器所有者信息', '$ref' => '#/components/schemas/Owner'], 'Prefix' => ['title' => '列举前缀', 'type' => 'string', 'example' => 'abc'], 'Marker' => ['title' => '列举开始标记', 'type' => 'string', 'example' => 'abc'], 'MaxKeys' => ['title' => '列举最大结果数', 'type' => 'string', 'example' => '2'], 'IsTruncated' => ['title' => '是否截断', 'type' => 'boolean', 'example' => 'true'], 'NextMarker' => ['title' => '下一个列举标记', 'type' => 'string', 'example' => 'xyz'], ], ], 'ListBucketRequesterQoSInfosResult' => [ 'title' => '', 'description' => 'The result of listing bucket-level requester throttle configurations.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'test-bucket'], 'ContinuationToken' => ['title' => '', 'description' => 'The token that identifies the starting point of the current listing.', 'type' => 'string', 'example' => '29387293298'], 'NextContinuationToken' => ['title' => '', 'description' => 'The token that identifies the starting point of the next listing.', 'type' => 'string', 'example' => '29387293298'], 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether the listing result is truncated.', 'type' => 'boolean', 'example' => 'true'], 'RequesterQoSInfo' => [ 'title' => '', 'description' => 'The list of requester QoS configurations.', 'type' => 'array', 'items' => ['description' => '保存存储空间请求者QoS配置信息的容器', '$ref' => '#/components/schemas/RequesterQoSInfo', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ListDataLakeCachePrefetchJobHistory' => [ 'title' => 'oss加速器异步预热任务执行记录列表', 'description' => 'oss加速器异步预热任务执行历史记录', 'type' => 'object', 'properties' => [ 'DataLakeCachePrefetchJobHistory' => [ 'title' => 'oss加速器异步预热任务执行记录列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/DataLakeCachePrefetchJobHistory'], ], ], ], 'ListDataLakeStorageTransferJobHistory' => [ 'title' => '', 'description' => '数据湖元数据转换历史任务列表', 'type' => 'object', 'properties' => [ 'DataLakeStorageTransferJobHistory' => [ 'title' => '数据湖元数据转换历史任务列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/DataLakeStorageTransferJobHistory'], ], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'ListDataLakeStorageTransferJobHistory' => [ 'title' => '数据湖元数据转换历史任务列表', 'description' => '数据湖元数据转换历史任务列表', 'type' => 'object', 'properties' => [ 'DataLakeStorageTransferJobHistory' => [ 'title' => '数据湖元数据转换历史任务列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/DataLakeStorageTransferJobHistory'], ], ], ], ], ], 'example' => '', ], 'ListResourcePoolBucketsResult' => [ 'title' => '', 'description' => 'The result of listing buckets in a resource pool.', 'type' => 'object', 'properties' => [ 'ResourcePool' => ['title' => '', 'description' => 'The name of the target resource pool.', 'type' => 'string', 'example' => 'rp-for-api'], 'ContionuationToken' => ['title' => '', 'description' => 'The continuation token for the current listing.', 'type' => 'string', 'example' => 'abcd'], 'NextContionuationToken' => ['title' => '', 'description' => 'The continuation token for the next listing.', 'type' => 'string', 'example' => 'defg'], 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether the listing result is truncated.', 'type' => 'boolean', 'example' => 'true'], 'ResourcePoolBucket' => [ 'title' => '', 'description' => 'The list of buckets in the resource pool.', 'type' => 'array', 'items' => ['description' => '保存资源池中的Bucket信息的容器', '$ref' => '#/components/schemas/ResourcePoolBucket', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ListResourcePoolRequesterQoSInfosResult' => [ 'title' => '', 'description' => 'The result of listing resource pool-level requester throttle configurations.', 'type' => 'object', 'properties' => [ 'ResourcePool' => ['title' => '', 'description' => 'The name of the resource pool.', 'type' => 'string', 'example' => 'rp-for-ai'], 'ContinuationToken' => ['title' => '', 'description' => 'The starting point of the current listing operation.', 'type' => 'string', 'example' => '29387293298'], 'NextContinuationToken' => ['title' => '', 'description' => 'The starting point of the next listing operation.', 'type' => 'string', 'example' => '29387293298'], 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether the listing result is truncated.', 'type' => 'boolean', 'example' => 'true'], 'RequesterQoSInfo' => [ 'title' => '', 'description' => 'The list of requester QoS configurations.', 'type' => 'array', 'items' => ['description' => '保存请求者QoS配置信息的容器', '$ref' => '#/components/schemas/RequesterQoSInfo', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ListResourcePoolsResult' => [ 'title' => '', 'description' => 'The resource pools of the current user in a specific region.', 'type' => 'object', 'properties' => [ 'Region' => ['title' => '', 'description' => 'The target region.', 'type' => 'string', 'example' => 'oss-cn-shanghai'], 'Owner' => ['title' => '', 'description' => 'The owner of the listed resource pools.', 'type' => 'string', 'example' => '1032307xxxx72056'], 'ContionuationToken' => ['title' => '', 'description' => 'The starting point of the current listing.', 'type' => 'string', 'example' => 'abcd'], 'NextContionuationToken' => ['title' => '', 'description' => 'The starting point of the next listing.', 'type' => 'string', 'example' => 'xyz'], 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether the listing result is truncated.', 'type' => 'boolean', 'example' => 'true'], 'ResourcePool' => [ 'title' => '', 'description' => 'The list of resource pools.', 'type' => 'array', 'items' => ['description' => '资源池信息', '$ref' => '#/components/schemas/ResourcePoolSimpleInfo', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ListUserRegionsResult' => [ 'title' => '用户存储空间所属的所有区域', 'description' => '列举用户 Bucket 所属的区域', 'type' => 'object', 'properties' => [ 'Regions' => [ 'title' => '保存所有区域列表的容器', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => '每个区域的名称', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'oss-cn-hangzhou'], ], ], ], ], ], 'ListVirtualBucketResult' => [ 'title' => '保存虚拟存储空间配置列表的容器', 'description' => '列举的虚拟 Bucket 配置信息', 'type' => 'object', 'properties' => [ 'VirtualBucket' => [ 'title' => '用户名下配置的所有虚拟存储空间列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/VirtualBucket'], ], ], ], 'LiveChannel' => [ 'title' => '', 'description' => 'The container that stores the information about each LiveChannel.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the LiveChannel.', 'type' => 'string', 'example' => 'channel-0'], 'Description' => ['title' => '', 'description' => 'The description of the LiveChannel.', 'type' => 'string', 'example' => 'test'], 'Status' => ['title' => '', 'description' => 'The status of the LiveChannel. Valid values:'."\n" .'- disabled: The LiveChannel is disabled.'."\n" .'- enabled: The LiveChannel is enabled.', 'type' => 'string', 'example' => 'enabled'], 'LastModified' => ['title' => '', 'description' => 'The last time the LiveChannel configuration was modified. Format: ISO 8601.', 'type' => 'string', 'format' => 'iso8601', 'example' => 'ISO8601'], 'PublishUrls' => ['description' => 'The container that stores the ingest URL of the LiveChannel.', '$ref' => '#/components/schemas/LiveChannelPublishUrls', 'title' => '', 'example' => ''], 'PlayUrls' => ['description' => 'The container that stores the streaming URL of the LiveChannel.', '$ref' => '#/components/schemas/LiveChannelPlayUrls', 'title' => '', 'example' => ''], ], 'example' => '', ], 'LiveChannelAudio' => [ 'title' => '', 'description' => 'The container that stores audio stream information when Status is Live.'."\n" .'> The Video and Audio containers are returned only when Status is Live. However, these two containers are not always returned when Status is Live. For example, if the client has connected to the LiveChannel but has not sent audio or video data, these two containers are not returned.', 'type' => 'object', 'properties' => [ 'Bandwidth' => ['title' => '', 'description' => 'The bitrate of the current audio stream.'."\n" .'> Bandwidth is the average bitrate of the audio or video stream over a recent period of time. When the LiveChannel has just switched to the Live status, the returned Bandwidth value may be 0.'."\n" .'Unit: B/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'SampleRate' => ['title' => '', 'description' => 'The sample rate of the current audio stream.', 'type' => 'integer', 'format' => 'int64', 'example' => '44100'], 'Codec' => ['title' => '', 'description' => 'The encoding format of the current audio stream.', 'type' => 'string', 'example' => 'ADPCM'], ], 'example' => '', ], 'LiveChannelConfiguration' => [ 'title' => '', 'description' => 'The container that stores the LiveChannel configuration.', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'The description of the LiveChannel. The description can be up to 128 bytes in length.', 'type' => 'string', 'example' => 'test'], 'Status' => ['title' => '', 'description' => 'The status of the LiveChannel.'."\n" ."\n" .'Valid values: **enabled**, **disabled**'."\n" .'Default value: **enabled**.', 'type' => 'string', 'example' => 'enabled'], 'Target' => ['description' => 'The container that stores the storage configuration.', '$ref' => '#/components/schemas/LiveChannelTarget', 'title' => '', 'example' => ''], 'Snapshot' => ['description' => 'The container that stores the Snapshot options for the high-frequency snapshot operation.', '$ref' => '#/components/schemas/LiveChannelSnapshot', 'title' => '', 'example' => ''], ], 'example' => '', ], 'LiveChannelPlayUrls' => [ 'title' => '', 'description' => 'The container that stores the playback URL.', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The playback URL.', 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-hangzhou.aliyuncs.com/test-channel/playlist.m3u8'], ], 'example' => '', ], 'LiveChannelPublishUrls' => [ 'title' => '', 'description' => 'The container that stores the streaming URL.', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The streaming URL.'."\n" ."\n" .'> - The streaming URL is an unsigned URL. If the bucket ACL is not public-read-write, you must sign the URL before you can access it.'."\n" .'> - The playback URL is an unsigned URL. If the bucket ACL is private, you must sign the URL before you can access it.', 'type' => 'string', 'example' => 'rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/test-channel'], ], 'example' => '', ], 'LiveChannelSnapshot' => [ 'title' => '', 'description' => 'The container for the Snapshot options of the high-frequency snapshot operation.', 'type' => 'object', 'properties' => [ 'RoleName' => ['title' => '', 'description' => 'The name of the role used for the high-frequency snapshot operation. The role must have write permissions on DestBucket and permissions to send messages to NotifyTopic.', 'type' => 'string', 'example' => 'role_for_snapshot'], 'DestBucket' => ['title' => '', 'description' => 'The destination bucket for storing high-frequency snapshots. The bucket must have the same owner as the current bucket.', 'type' => 'string', 'example' => 'snapshotdest'], 'NotifyTopic' => ['title' => '', 'description' => 'The MNS topic used to notify users of the high-frequency snapshot operation results.', 'type' => 'string', 'example' => 'snapshotnotify'], 'Interval' => ['title' => '', 'description' => 'The interval for high-frequency snapshots. If no keyframe (I-frame) exists within the interval, no snapshot is captured during that interval.'."\n" ."\n" .'Unit: seconds.'."\n" ."\n" .'Valid values: [1, 100].', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], 'example' => '', ], 'LiveChannelTarget' => [ 'title' => '', 'description' => 'The container that stores the streaming storage configuration.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The type of streaming storage.'."\n" ."\n" .'Valid values: **HLS**'."\n" ."\n" .'> - When the streaming storage type is HLS, OSS updates the m3u8 file after each ts file is generated. The m3u8 file contains up to the most recent FragCount ts files.'."\n" .'> - When the streaming storage type is HLS, after the duration of audio and video data written to the current ts file reaches the duration specified by FragDuration, OSS switches to the next ts file upon receiving the next key frame. If the next key frame is not received after max(2*FragDuration, 60s), OSS forcibly switches the file, which may cause playback stuttering.', 'type' => 'string', 'example' => 'HLS'], 'FragDuration' => ['title' => '', 'description' => 'The duration of each ts file when Type is set to HLS.'."\n" .'Unit: seconds.'."\n" ."\n" .'Valid values: [1, 100].'."\n" .'Default value: **5**.'."\n" .'> The default values of FragDuration and FragCount take effect only when neither is specified. If one is specified, the other must also be specified.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'FragCount' => ['title' => '', 'description' => 'The number of ts files contained in the m3u8 file when Type is set to HLS.'."\n" ."\n" .'Valid values: [1, 100].'."\n" .'Default value: **3**.'."\n" .'> The default values of FragDuration and FragCount take effect only when neither is specified. If one is specified, the other must also be specified.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'PlaylistName' => ['title' => '', 'description' => 'The name of the generated m3u8 file when Type is set to HLS. The name must end with ".m3u8" and be 6 to 128 characters in length.'."\n" ."\n" .'Default value: **playlist.m3u8**.'."\n" .'Valid values: [6, 128].', 'type' => 'string', 'example' => 'playlist.m3u8'], ], 'example' => '', ], 'LiveChannelVideo' => [ 'title' => '', 'description' => 'The container that stores video stream information when Status is Live.'."\n" .'> **Note** The Video and Audio containers are returned only when Status is Live. However, these two containers are not always returned when Status is Live. For example, if the client has connected to the LiveChannel but has not yet sent audio or video data, these two containers are not returned.', 'type' => 'object', 'properties' => [ 'Width' => ['title' => '', 'description' => 'The width of the current video stream.'."\n" .'Unit: pixel.', 'type' => 'integer', 'format' => 'int64', 'example' => '1280'], 'Height' => ['title' => '', 'description' => 'The height of the current video stream.'."\n" .'Unit: pixel.', 'type' => 'integer', 'format' => 'int64', 'example' => '536'], 'FrameRate' => ['title' => '', 'description' => 'The frame rate of the current video stream.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], 'Bandwidth' => ['title' => '', 'description' => 'The bitrate of the current video stream.'."\n" .'Unit: B/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Codec' => ['title' => '', 'description' => 'The encoding format of the current video stream.', 'type' => 'string', 'example' => 'ADPCM'], ], 'example' => '', ], 'LiveRecord' => [ 'title' => '', 'description' => 'The container that stores information about a stream ingest record.', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'The time when the stream ingest started, in ISO 8601 format.', 'type' => 'string', 'example' => '2016-07-30T01:53:21.000Z'], 'EndTime' => ['title' => '', 'description' => 'The time when the stream ingest ended, in ISO 8601 format.', 'type' => 'string', 'example' => '2016-07-30T01:53:31.000Z'], 'RemoteAddr' => ['title' => '', 'description' => 'The IP address of the stream ingest client.', 'type' => 'string', 'example' => '10.101.194.148:57632'], ], 'example' => '', ], 'LocationTransferType' => [ 'title' => '', 'description' => 'The container that stores Location information with TransferType.', 'type' => 'object', 'properties' => [ 'Location' => ['title' => '', 'description' => 'The region in which the destination bucket to which data can be replicated is located.', 'type' => 'string', 'example' => 'oss-cn-beijing'], 'TransferTypes' => [ 'title' => '', 'description' => 'The container that stores the transfer type.', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '', 'description' => 'The data transfer type used for data replication. Valid values:'."\n" .' - internal (default): the default OSS data transfer link.'."\n" .' - oss_acc: the transfer acceleration link. The transfer acceleration link can be used only when you create a cross-region replication rule.', 'type' => 'array', 'items' => ['description' => 'The data transfer type used for data replication.', 'type' => 'string', 'example' => 'oss_acc', 'title' => ''], 'example' => 'oss_acc', ], ], 'example' => '', ], ], 'example' => '', ], 'LoggingEnabled' => [ 'title' => '', 'description' => 'The container for access log information.', 'type' => 'object', 'properties' => [ 'TargetBucket' => ['title' => '', 'description' => 'The bucket that stores access logs.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'], 'TargetPrefix' => ['title' => '', 'description' => 'The prefix of the saved log file. This parameter can be empty.', 'type' => 'string', 'example' => 'MyLog-'], 'LoggingRole' => ['title' => '', 'description' => 'The RAM role for log delivery authorization.', 'type' => 'string', 'example' => 'AliyunOSSLoggingDefaultRole'], ], 'example' => '', ], 'MetaQuery' => [ 'title' => '', 'description' => 'The container for query conditions.', 'type' => 'object', 'properties' => [ 'NextToken' => ['title' => '', 'description' => 'The pagination token. Object information is returned in alphabetical order starting from the value of NextToken.', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****'], 'MaxResults' => ['title' => '', 'description' => 'The maximum number of objects to return. Valid values: 0 to 100.'."\n" .'If you do not specify this parameter or set it to 0, the default value 100 is used.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'Query' => ['title' => '', 'description' => 'The query conditions. The following options are included:'."\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 match), prefix (prefix query), and (logical AND), or (logical OR), and not (logical NOT).'."\n" ."\n" .'- Field: the field name.'."\n" ."\n" .'- Value: the field value.'."\n" ."\n" .'- SubQueries: the subquery conditions, which include the same options as simple query conditions. Subquery conditions are required only when Operations is set to a logical operator (and, or, or not).', 'type' => 'string', 'required' => false, 'example' => '{"Field": "Size","Value": "1048576","Operation": "gt"}'], 'Sort' => ['title' => '', 'description' => 'Sorts results by the specified field.', 'type' => 'string', 'example' => 'Size'], 'Order' => ['title' => '', 'description' => 'The sort order.', '$ref' => '#/components/schemas/MetaQueryOrder', 'example' => ''], 'Aggregations' => [ 'title' => '', 'description' => 'The container for aggregation operation information.', 'type' => 'object', 'properties' => [ 'Aggregation' => [ 'title' => '', 'description' => '单个聚合操作信息的容器。', 'type' => 'array', 'items' => ['description' => '句号操作信息的容器。', '$ref' => '#/components/schemas/MetaQueryAggregation', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'MediaTypes' => [ 'title' => '', 'description' => 'The multimedia metadata retrieve conditions. This parameter is used only for AISearch.', 'type' => 'object', 'properties' => [ 'MediaType' => [ 'title' => '', 'description' => '选择检索的多媒体类型。', 'type' => 'array', 'items' => ['description' => '取值如下: image:图片 video:视频 audio:音频 document:文档', 'type' => 'string', 'example' => 'image', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'SimpleQuery' => ['title' => '', 'description' => 'The query conditions. This parameter is used only for vector search.', 'type' => 'string', 'example' => '{"Operation":"gt", "Field": "Size", "Value": "30"}'], ], 'example' => '', ], 'MetaQueryAggregation' => [ 'title' => '', 'description' => 'The aggregate operation information.', 'type' => 'object', 'properties' => [ 'Field' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'example' => 'Size'], 'Operation' => ['title' => '', 'description' => 'The operator in the aggregate operation. Valid values:'."\n" ."\n" .'- min: minimum value'."\n" .'- max: maximum value'."\n" .'- average: average value'."\n" .'- sum: sum'."\n" .'- count: count'."\n" .'- distinct: deduplicate statistics'."\n" .'- group: group count.', 'type' => 'string', 'example' => 'sum'], ], 'example' => '', ], 'MetaQueryAggregationsResult' => [ 'title' => '', 'description' => 'The aggregate query results of the data index.', 'type' => 'object', 'properties' => [ 'Field' => ['title' => '', 'description' => 'The field name.', 'type' => 'string', 'example' => 'Size'], 'Operation' => ['title' => '', 'description' => 'The aggregation operator.', 'type' => 'string', 'example' => 'sum'], 'Value' => ['title' => '', 'description' => 'The result value of the operation.', 'type' => 'number', 'format' => 'double', 'example' => '200'], 'Groups' => [ 'title' => '', 'description' => 'The container for the list of grouping and aggregation results.', 'type' => 'object', 'properties' => [ 'Group' => [ 'title' => '', 'description' => '分组聚合的结果列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Value' => ['title' => '', 'description' => '分组聚合的值', 'type' => 'string', 'example' => '100'], 'Count' => ['title' => '', 'description' => '分组聚合的总个数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'MetaQueryFile' => [ 'title' => '', 'description' => 'The information of a single object in data index search results.', 'type' => 'object', 'properties' => [ 'Filename' => ['title' => '', 'description' => 'The full path of the object.', 'type' => 'string', 'example' => 'exampleobject.txt'], 'Size' => ['title' => '', 'description' => 'The size of the object.', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], 'FileModifiedTime' => ['title' => '', 'description' => 'The time when the object was last modified.', 'type' => 'string', 'example' => '2021-06-29T15:04:05.000000000Z07:00'], 'OSSObjectType' => [ 'title' => '', 'description' => 'The type of the object.', 'enumValueTitles' => ['Multipart' => 'MultipartUpload上传的文件', 'Symlink' => 'PutSymlink创建的软链接', 'Appendable' => 'AppendObject上传的文件', 'Normal' => 'PutObject上传的文件'], 'type' => 'string', 'example' => 'Normal', ], 'OSSStorageClass' => [ 'title' => '', 'description' => 'The storage class of the object.', 'enumValueTitles' => ['Archive' => '归档存储类型', 'ColdArchive' => '冷归档存储类型文件', 'IA' => '低频文件', 'Standard' => '标准文件'], 'type' => 'string', 'example' => 'Standard', ], 'ObjectACL' => [ 'title' => '', 'description' => 'The access permissions of the object.', 'enumValueTitles' => ['default' => '遵循存储空间的访问权限', 'private' => '私有', 'public-read' => '公共读', 'public-read-write' => '公共读写'], 'type' => 'string', 'example' => 'default', ], 'ETag' => ['title' => '', 'description' => 'The ETag of the object.', 'type' => 'string', 'example' => '"fba9dede5f27731c9771645a3986****"'], 'OSSCRC64' => ['title' => '', 'description' => 'The CRC64 checksum of the object.', 'type' => 'string', 'example' => '4858A48BD1466884'], 'ServerSideEncryption' => ['title' => '', 'description' => 'The server-side encryption key used when the object was created.', 'type' => 'string', 'example' => 'AES256'], 'ServerSideEncryptionCustomerAlgorithm' => ['title' => '', 'description' => 'The server-side encryption algorithm used when the object was created.', 'type' => 'string', 'example' => 'SM4'], 'OSSTaggingCount' => ['title' => '', 'description' => 'The number of tags on the object.', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], 'OSSTagging' => [ 'title' => '', 'description' => 'The list of tags on the object.', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'title' => '', 'description' => '对象的标签', 'type' => 'array', 'items' => ['description' => '对象的标签', '$ref' => '#/components/schemas/MetaQueryTagging', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'OSSUserMeta' => [ 'title' => '', 'description' => 'The list of user metadata on the object.', 'type' => 'object', 'properties' => [ 'UserMeta' => [ 'title' => '', 'description' => '对象的自定义元数据', 'type' => 'array', 'items' => ['description' => '用户自定义元数据', '$ref' => '#/components/schemas/MetaQueryUserMeta', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'URI' => ['title' => '', 'description' => 'The full path of the object.', 'type' => 'string', 'example' => 'oss://examplebucket/test-object.jpg'], 'ProduceTime' => ['title' => '', 'description' => 'The time when the photo or video was captured by the device.', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00'], 'ContentType' => ['title' => '', 'description' => 'The MIME type.', 'type' => 'string', 'example' => 'image/jpeg'], 'MediaType' => ['title' => '', 'description' => 'The multimedia type.', 'type' => 'string', 'example' => 'image'], 'LatLong' => ['title' => '', 'description' => 'The latitude and longitude information.', 'type' => 'string', 'example' => '30.134390,120.074997'], 'Title' => ['title' => '', 'description' => 'The title of the file.', 'type' => 'string', 'example' => 'test'], 'OSSExpiration' => ['title' => '', 'description' => 'The expiration time of the file.', 'type' => 'string', 'example' => '2124-12-01T12:00:00.000Z'], 'AccessControlAllowOrigin' => ['title' => '', 'description' => 'The allowed origins for cross-origin requests.', 'type' => 'string', 'example' => 'https://aliyundoc.com'], 'AccessControlRequestMethod' => ['title' => '', 'description' => 'The methods used in cross-origin requests.', 'type' => 'string', 'example' => 'PUT'], 'ServerSideDataEncryption' => ['title' => '', 'description' => 'The encryption algorithm of the object.', 'type' => 'string', 'example' => 'SM4'], 'ServerSideEncryptionKeyId' => ['title' => '', 'description' => 'The customer master key (CMK) managed by KMS.', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****'], 'CacheControl' => ['title' => '', 'description' => 'The caching behavior of the web page when the object is downloaded.', 'type' => 'string', 'example' => 'no-cache'], 'ContentDisposition' => ['title' => '', 'description' => 'The name of the object when it is downloaded.', 'type' => 'string', 'example' => 'attachment; filename =test.jpg'], 'ContentEncoding' => ['title' => '', 'description' => 'The content encoding format of the object when it is downloaded.', 'type' => 'string', 'example' => 'UTF-8'], 'ContentLanguage' => ['title' => '', 'description' => 'The language of the object content.', 'type' => 'string', 'example' => 'zh-CN'], 'ImageHeight' => ['title' => '', 'description' => 'The height of the image, in pixels (px).', 'type' => 'integer', 'example' => '500', 'format' => 'int64'], 'ImageWidth' => ['title' => '', 'description' => 'The width of the image, in pixels (px).', 'type' => 'integer', 'example' => '270', 'format' => 'int64'], 'VideoWidth' => ['title' => '', 'description' => 'The width of the video frame, in pixels (px).', 'type' => 'integer', 'example' => '1080', 'format' => 'int64'], 'VideoHeight' => ['title' => '', 'description' => 'The height of the video frame, in pixels (px).', 'type' => 'integer', 'example' => '1920', 'format' => 'int64'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate, in bits per second (bit/s).', 'type' => 'integer', 'example' => '13091201', 'format' => 'int64'], 'Artist' => ['title' => '', 'description' => 'The artist.', 'type' => 'string', 'example' => 'Jane'], 'AlbumArtist' => ['title' => '', 'description' => 'The album artist.', 'type' => 'string', 'example' => 'Jenny'], 'Composer' => ['title' => '', 'description' => 'The composer.', 'type' => 'string', 'example' => 'Jane'], 'Performer' => ['title' => '', 'description' => 'The performer.', 'type' => 'string', 'example' => 'Jane'], 'Album' => ['title' => '', 'description' => 'The album.', 'type' => 'string', 'example' => 'FirstAlbum'], 'Duration' => ['title' => '', 'description' => 'The total duration of the video, in seconds.', 'type' => 'number', 'example' => '15.263000', 'format' => 'double'], 'VideoStreams' => [ 'title' => '', 'description' => 'The list of video streams.', 'type' => 'object', 'properties' => [ 'VideoStream' => ['title' => '', 'description' => '视频流', '$ref' => '#/components/schemas/MetaQueryRespVideoStream', 'example' => ''], ], 'example' => '', ], 'AudioStreams' => [ 'title' => '', 'description' => 'The list of audio streams.', 'type' => 'object', 'properties' => [ 'AudioStream' => ['title' => '', 'description' => '音频流', '$ref' => '#/components/schemas/MetaQueryRespAudioStream', 'example' => ''], ], 'example' => '', ], 'Subtitles' => [ 'title' => '', 'description' => 'The list of subtitle streams.', 'type' => 'object', 'properties' => [ 'Subtitle' => ['title' => '', 'description' => '字幕流', '$ref' => '#/components/schemas/MetaQueryRespSubtitle', 'example' => ''], ], 'example' => '', ], 'Addresses' => [ 'title' => '', 'description' => 'The list of address information.', 'type' => 'object', 'properties' => [ 'Address' => ['title' => '', 'description' => '地址信息', '$ref' => '#/components/schemas/MetaQueryRespAddress', 'example' => ''], ], 'example' => '', ], ], 'example' => '', ], 'MetaQueryOpenRequest' => [ 'title' => '', 'description' => '为开启元数据管理功能的请求体', 'type' => 'object', 'properties' => [ 'Filters' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Filter' => [ 'title' => '', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'Size > 1024,FileModifiedTime > 2025-06-03T09:20:47.999Z', 'description' => '', 'title' => ''], 'description' => '', 'example' => '', ], ], 'description' => '', 'example' => '', ], ], 'example' => '', ], 'MetaQueryOrder' => [ 'title' => '', 'description' => 'The sort order. Valid values:'."\n" ."\n" .'- asc: ascending order.'."\n" ."\n" .'- desc (default): descending order.', 'type' => 'string', 'example' => 'asc', 'enum' => ['asc', 'desc'], ], 'MetaQueryResp' => [ 'title' => '', 'description' => 'The response body for a data index query.', 'type' => 'object', 'properties' => [ 'NextToken' => ['title' => '', 'description' => 'The token used for pagination when the total number of objects exceeds the specified MaxResults value. Set NextToken to this value in the next request to list the remaining objects. This parameter is returned only when not all objects have been returned.', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****'], 'Files' => [ 'title' => '', 'description' => 'The container for object information.', 'type' => 'object', 'properties' => [ 'File' => [ 'title' => '', 'description' => '保存单个Object信息的容器。', 'type' => 'array', 'items' => ['description' => '满足查询条件的文件列表', '$ref' => '#/components/schemas/MetaQueryFile', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'Aggregations' => [ 'title' => '', 'description' => 'The container for aggregation operation results.', 'type' => 'object', 'properties' => [ 'Aggregation' => [ 'title' => '', 'description' => '聚合操作结果列表', 'type' => 'array', 'items' => ['description' => '聚合操作结果', '$ref' => '#/components/schemas/MetaQueryAggregationsResult', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'MetaQueryRespAddress' => [ 'title' => '', 'description' => 'The address information in data index vector retrieve results.', 'type' => 'object', 'properties' => [ 'AddressLine' => ['title' => '', 'description' => 'The full address.', 'type' => 'string', 'example' => '中国浙江省杭州市余杭区文一西路969号'], 'City' => ['title' => '', 'description' => 'The city.', 'type' => 'string', 'example' => '杭州市'], 'District' => ['title' => '', 'description' => 'The district.', 'type' => 'string', 'example' => '余杭区'], 'Language' => ['title' => '', 'description' => 'The language in BCP 47 format.', 'type' => 'string', 'example' => 'zh-Hans'], 'Province' => ['title' => '', 'description' => 'The province.', 'type' => 'string', 'example' => '浙江省'], 'Township' => ['title' => '', 'description' => 'The township or street.', 'type' => 'string', 'example' => '文一西路'], ], 'example' => '', ], 'MetaQueryRespAudioStream' => [ 'title' => '', 'description' => 'The audio stream information in data index AISearch retrieve results.', 'type' => 'object', 'properties' => [ 'CodecName' => ['title' => '', 'description' => 'The codec name.', 'type' => 'string', 'example' => 'aac'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate, in bits per second (bit/s).', 'type' => 'integer', 'format' => 'int64', 'example' => '320087'], 'SampleRate' => ['title' => '', 'description' => 'The sample rate, in hertz (Hz).', 'type' => 'integer', 'format' => 'int64', 'example' => '48000'], 'StartTime' => ['title' => '', 'description' => 'The start time of the audio stream, in seconds (s).', 'type' => 'number', 'format' => 'double', 'example' => '0.0235'], 'Duration' => ['title' => '', 'description' => 'The duration of the audio stream, in seconds (s).', 'type' => 'number', 'format' => 'double', 'example' => '3.690667'], 'Channels' => ['title' => '', 'description' => 'The number of audio channels.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'Language' => ['title' => '', 'description' => 'The language used in the audio stream, in BCP 47 format.', 'type' => 'string', 'example' => 'en'], ], 'example' => '', ], 'MetaQueryRespFileInsights' => [ 'title' => '视频与图片的描述信息。', 'type' => 'object', 'properties' => [ 'Video' => ['title' => '保存视频文件描述信息的容器。', '$ref' => '#/components/schemas/MetaQueryRespFileInsightsVideo'], 'Image' => ['title' => '保存图片文件描述信息的容器。', '$ref' => '#/components/schemas/MetaQueryRespFileInsightsImage'], ], ], 'MetaQueryRespFileInsightsImage' => [ 'title' => '图片文件描述信息', 'type' => 'object', 'properties' => [ 'Caption' => ['title' => '简短描述信息', 'type' => 'string', 'example' => '站着一个人'], 'Description' => ['title' => '详细描述信息', 'type' => 'string', 'example' => '图片中有一人,穿着深色西装外套,内搭白色衬衫。背景为渐变的浅蓝色至灰色'], ], ], 'MetaQueryRespFileInsightsVideo' => [ 'title' => '视频文件的描述信息。', 'type' => 'object', 'properties' => [ 'Caption' => ['title' => '简短描述信息。', 'type' => 'string', 'example' => '手拿洗发水'], 'Description' => ['title' => '详细描述信息。', 'type' => 'string', 'example' => '视频中展示了两个不同场景:一个是静止的白色盘子、黑色瓶子和透明玻璃杯,另一个是手拿着标有“YEZOLU”的洗发水瓶在浴室中缓慢上移'], ], ], 'MetaQueryRespSubtitle' => [ 'title' => '', 'description' => 'The subtitle stream information in data index AISearch retrieve results.', 'type' => 'object', 'properties' => [ 'CodecName' => ['title' => '', 'description' => 'The encoder name.', 'type' => 'string', 'example' => 'mov_text'], 'Language' => ['title' => '', 'description' => 'The subtitle language in BCP 47 format.', 'type' => 'string', 'example' => 'en'], 'StartTime' => ['title' => '', 'description' => 'The start time of the subtitle stream, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '0.000000'], 'Duration' => ['title' => '', 'description' => 'The duration of the subtitle stream, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '71.378'], ], 'example' => '', ], 'MetaQueryRespVideoStream' => [ 'title' => '', 'description' => 'The video stream information in data index AISearch retrieve results.', 'type' => 'object', 'properties' => [ 'CodecName' => ['title' => '', 'description' => 'The codec name.', 'type' => 'string', 'example' => 'h264'], 'Language' => ['title' => '', 'description' => 'The language used in the video stream, in BCP 47 format.', 'type' => 'string', 'example' => 'en'], 'Bitrate' => ['title' => '', 'description' => 'The bitrate, in bits per second (bit/s).', 'type' => 'integer', 'format' => 'int64', 'example' => '5407765'], 'FrameRate' => ['title' => '', 'description' => 'The frame rate of the video stream.', 'type' => 'string', 'example' => '25/1'], 'StartTime' => ['title' => '', 'description' => 'The start time of the video stream, in seconds (s).', 'type' => 'number', 'format' => 'double', 'example' => '0.000000'], 'Duration' => ['title' => '', 'description' => 'The duration of the video stream, in seconds (s).', 'type' => 'number', 'format' => 'double', 'example' => '22.88'], 'FrameCount' => ['title' => '', 'description' => 'The number of video frames.', 'type' => 'integer', 'format' => 'int64', 'example' => '572'], 'BitDepth' => ['title' => '', 'description' => 'The bit depth per pixel.', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], 'PixelFormat' => ['title' => '', 'description' => 'The pixel format of the video stream.', 'type' => 'string', 'example' => 'yuv420p'], 'ColorSpace' => ['title' => '', 'description' => 'The color space.', 'type' => 'string', 'example' => 'bt709'], 'Height' => ['title' => '', 'description' => 'The height of the video stream, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '720'], 'Width' => ['title' => '', 'description' => 'The width of the video stream, in pixels (px).', 'type' => 'integer', 'format' => 'int64', 'example' => '1280'], ], 'example' => '', ], 'MetaQueryTagging' => [ 'title' => '', 'description' => 'The label attached to the object.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The object label key.', 'type' => 'string', 'example' => 'abc'], 'Value' => ['title' => '', 'description' => 'The object label value.', 'type' => 'string', 'example' => 'test'], ], 'example' => '', ], 'MetaQueryUserMeta' => [ 'title' => '', 'description' => 'The user metadata.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The user metadata key.', 'type' => 'string', 'example' => 'abc'], 'Value' => ['title' => '', 'description' => 'The user metadata value.', 'type' => 'string', 'example' => 'test'], ], 'example' => '', ], 'NotificationConfiguration' => [ 'title' => '', 'description' => 'BucketNotification 配置信息', 'type' => 'object', 'properties' => [ 'TopicConfiguration' => [ 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'type' => 'string', 'example' => 'test-topic-1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], 'ObjectACL' => [ 'description' => 'The access control list (ACL) of the object when it is created in OSS.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- default: The object inherits the ACL of the bucket in which it is stored.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have read and access permissions on the object. Other users cannot access the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have read and access permissions on the object. Other users have only read permissions on the object. Exercise caution when you set this value.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have read and access permissions on the object. Exercise caution when you set this value.'."\n" ."\n" .'For more information about ACLs, see **[ACL](~~100676~~)**.', 'type' => 'string', 'example' => 'public-read', 'default' => 'default', 'enum' => ['private', 'public-read', 'public-read-write', 'default'], 'title' => '', ], 'ObjectHashConfiguration' => [ 'title' => '', 'description' => 'The object hash algorithm configuration.', 'type' => 'object', 'properties' => [ 'ObjectHashFunction' => ['title' => '', 'description' => 'The object hash algorithm.', 'type' => 'string', 'example' => 'SHA-256'], 'DisplayObjectHash' => ['title' => '', 'description' => 'Specifies whether to display the object hash value in the HTTP header when the object is accessed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'ObjectIdentifier' => [ 'title' => '', 'description' => 'The object identifier.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The object key.', 'type' => 'string', 'required' => true, 'example' => 'object_key'], 'VersionId' => ['title' => '', 'description' => 'The version ID.', 'type' => 'string', 'example' => 'version_20211101141621_d137'], ], 'example' => '', ], 'ObjectLinkInfo' => [ 'title' => '保存ObjectLink类型文件信息的容器', 'description' => 'ObjectLink类型文件信息', 'type' => 'object', 'properties' => [ 'Part' => [ 'title' => '保存文件每个Part的信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PartNumber' => ['title' => '该Part的序号', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'PartName' => ['title' => '该Part的文件名称', 'type' => 'string', 'example' => 'test.txt'], ], ], ], ], ], 'ObjectList' => [ 'title' => '', 'description' => '文件信息的容器', 'type' => 'array', 'items' => ['description' => 'The object metadata returned.', '$ref' => '#/components/schemas/ObjectSummary', 'title' => '', 'example' => ''], 'enumValueTitles' => [], 'example' => '', ], 'ObjectProcessConfiguration' => [ 'title' => '', 'description' => 'The Object FC Access Point configuration.', 'type' => 'object', 'properties' => [ 'AllowedFeatures' => [ 'title' => '', 'description' => 'The container that stores information about requests initiated through the Object FC Access Point.', 'type' => 'object', 'properties' => [ 'AllowedFeature' => [ 'title' => '', 'description' => '函数计算支持的功能特性列表', 'type' => 'array', 'items' => ['description' => '函数计算支持的功能特性', 'type' => 'string', 'example' => 'GetObject-Range', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'TransformationConfigurations' => [ 'title' => '', 'description' => 'The container that stores the transformation configuration information.', 'type' => 'object', 'properties' => [ 'TransformationConfiguration' => [ 'title' => '', 'description' => '保存转换配置信息的列表', 'type' => 'array', 'items' => [ 'description' => '保存转换配置信息的容器', 'type' => 'object', 'properties' => [ 'Actions' => [ 'title' => '', 'description' => '保存操作信息的容器', 'type' => 'object', 'properties' => [ 'Action' => [ 'title' => '', 'description' => '保存操作信息的列表', 'type' => 'array', 'items' => ['description' => '具体的操作名称', 'type' => 'string', 'example' => 'OSS API操作,目前仅支持GetObject', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'ContentTransformation' => [ 'title' => '', 'description' => '保存转换信息的容器', 'type' => 'object', 'properties' => [ 'FunctionCompute' => [ 'title' => '', 'description' => '保存函数计算信息的容器', 'type' => 'object', 'properties' => [ 'FunctionAssumeRoleArn' => ['title' => '', 'description' => '函数计算用于访问您在其他云产品中的资源的角色ARN', 'type' => 'string', 'example' => 'acs:ram::111933544165****:role/aliyunfcdefaultrole'], 'FunctionArn' => ['title' => '', 'description' => '函数ARN', 'type' => 'string', 'example' => 'acs:fc:cn-qingdao:111933544165****:services/test-oss-fc.LATEST/functions/fc-01'], ], 'example' => '', ], 'AdditionalFeatures' => [ 'title' => '', 'description' => '保存额外特性配置', 'type' => 'object', 'properties' => [ 'CustomForwardHeaders' => [ 'title' => '', 'description' => '保存自定义转发请求头列表', 'type' => 'object', 'properties' => [ 'CustomForwardHeader' => [ 'title' => '', 'description' => '自定义转发请求头', 'type' => 'array', 'items' => ['description' => '自定义转发请求头', 'type' => 'string', 'example' => 'test-header', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'ObjectSummary' => [ 'title' => '', 'description' => 'The returned object metadata.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the object.', 'type' => 'string', 'example' => 'fun/test.jpg'], 'LastModified' => ['title' => '', 'description' => 'The time when the object was last modified.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-24T08:42:32.000Z'], 'ETag' => ['title' => '', 'description' => 'The ETag (entity tag) that is created when an object is generated. ETags are used to identify the content of an object.'."\n" ."\n" .'- For an object created by a PutObject request, the ETag value is the MD5 hash of the object content.'."\n" ."\n" .'- For an object created by using other methods, the ETag value is a unique value calculated based on specific rules, but is not the MD5 hash of the object content.'."\n" ."\n" .'- The ETag value can be used to check whether the object content has changed. Do not use the ETag value as the MD5 hash of the object content to verify data integrity.', 'type' => 'string', 'example' => '5B3C1A2E053D763E1B002CC607C5A0FE1****'], 'Type' => ['title' => '', 'description' => 'The type of the object. Valid values:'."\n" ."\n" .'- Normal: The object is created by a simple upload.'."\n" ."\n" .'- Multipart: The object is created by a multipart upload.'."\n" ."\n" .'- Appendable: The object is created by an append upload. You can append content only to objects of the Appendable type.', 'type' => 'string', 'example' => 'Normal'], 'Size' => ['title' => '', 'description' => 'The size of the object, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '344606'], 'StorageClass' => ['title' => '', 'description' => 'The storage class of the object.', '$ref' => '#/components/schemas/StorageClass', 'example' => ''], 'Owner' => ['title' => '', 'description' => 'The container that stores the information about the bucket owner.', '$ref' => '#/components/schemas/Owner', 'example' => ''], 'ResoreInfo' => ['title' => '', 'type' => 'string', 'example' => 'ongoing-request="true”', 'description' => ''], ], 'example' => '', ], 'ObjectVersion' => [ 'title' => '', 'description' => 'The container that stores object versions other than delete markers.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The name of the object.', 'type' => 'string', 'example' => 'example'], 'VersionId' => ['title' => '', 'description' => 'The version ID of the object.', 'type' => 'string', 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****'], 'IsLatest' => [ 'title' => '', 'description' => 'Indicates whether the object is the current version. Valid values:'."\n" ."\n" .'- true: The object is the current version.'."\n" ."\n" .'- false: The object is not the current version.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', 'default' => 'false', ], 'LastModified' => ['title' => '', 'description' => 'The time when the object was last modified.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-04-09T07:27:28.000Z'], 'ETag' => ['title' => '', 'description' => 'The ETag that is generated when each object is created. ETags are used to identify the content of objects.'."\n" .' - For an object created by a PutObject request, the ETag value is the MD5 hash of the object content.'."\n" .' - For an object created by using other methods, the ETag value is a unique value calculated based on specific rules, but is not the MD5 hash of the object content.'."\n" ."\n" .'> ETag values are used only to check whether the object content has changed. Do not use ETag values for MD5 data integrity verification of object content.', 'type' => 'string', 'example' => '250F8A0AE989679A22926A875F0A2****'], 'Size' => ['title' => '', 'description' => 'The size of the object in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '93731'], 'StorageClass' => ['title' => '', 'description' => 'The storage class of the object.', 'example' => 'Standard', '$ref' => '#/components/schemas/StorageClass'], 'Owner' => ['title' => '', 'description' => 'The container that stores the information about the bucket owner.', '$ref' => '#/components/schemas/Owner', 'example' => ''], ], 'example' => '', ], 'ObjectWormConfiguration' => [ 'title' => '', 'description' => 'The container that stores object-level retention policies.', 'type' => 'object', 'properties' => [ 'ObjectWormEnabled' => ['description' => 'Indicates whether the object-level compliance retention policy is enabled ', 'title' => '', 'type' => 'string', 'example' => 'Enabled'], 'Rule' => [ 'description' => 'Container for storing bucket object-level retention policies ', 'title' => '', 'type' => 'object', 'properties' => [ 'DefaultRetention' => [ 'description' => 'List of object-level compliance retention policies ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Container for storing retention policy rules ', 'title' => '', 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'Mode of the bucket object-level retention policy. Valid values: GOVERNANCE (administration mode) and COMPLIANCE (compliance mode) ', 'title' => '', 'type' => 'string', 'example' => 'COMPLIANCE'], 'Days' => ['description' => 'Number of days for the bucket object-level retention policy (maximum 36 500). Only one of Days or Years can be specified ', 'title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Years' => ['description' => 'Number of years for the bucket object-level retention policy (maximum 100). Only one of Days or Years can be specified ', 'title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'OutputSerialization' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'CSV' => ['description' => 'The format parameters for the output CSV.', '$ref' => '#/components/schemas/CSVOutput', 'title' => '', 'example' => ''], 'JSON' => ['description' => 'The format parameters for the output JSON.', '$ref' => '#/components/schemas/JSONOutput', 'title' => '', 'example' => ''], 'KeepAllColumns' => [ 'title' => '', 'description' => 'Specifies whether to include the positions of all CSV columns in the response (optional).
Default value: false.'."\n" .'
Only columns that appear in the SELECT statement have values. Columns that do not appear are empty. The data in each row of the response is arranged in ascending order of CSV column positions.'."\n" .'For example, the following statement:
'."\n" .'`select _5, _1 from ossobject.`'."\n" .'
If KeepAllColumns is set to true and there are six columns in total, the following data is returned:'."\n" .'
`Value of 1st column,,,,Value of 5th column,'."\n" .'`.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'OutputHeader' => [ 'title' => '', 'description' => 'Specifies whether to output CSV header information at the beginning of the response.'."\n" .'
Default value: false.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'OutputRawData' => [ 'title' => '', 'description' => 'Specifies whether the output data is raw data.'."\n" ."\n" .'- If you specify the OutputRawData value in the request, OSS returns data based on the request.'."\n" ."\n" .'- If you do not specify the OutputRawData value in the request, OSS automatically selects a format to return data.'."\n" ."\n" .'- If you explicitly set OutputRawData to True and the SQL statement does not return data for a long time, the HTTP request may time out because no data is returned.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'EnablePayloadCrc' => [ 'title' => '', 'description' => 'Each frame contains a 32-bit CRC32 checksum. The client can calculate the CRC32 value of the corresponding payload to verify data integrity.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '', ], 'OverwriteConfiguration' => [ 'title' => '', 'description' => 'The overwrite prohibition configurations.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '', 'description' => 'The container that stores a single overwrite prohibition rule.', 'type' => 'array', 'items' => [ 'description' => '单个Bucket最多支持配置100条规则。', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => '规则的唯一标识符。如果不填写,则会随机生成一个UUID来填充;如果填写,则必须为唯一值,即不同的Rule中不能设置相同的ID。', 'type' => 'string', 'example' => 'forbid-write-rule1'], 'Action' => ['title' => '', 'description' => '操作类型。当前只支持设置forbid(禁止覆盖写)。', 'type' => 'string', 'example' => 'forbid'], 'Prefix' => ['title' => '', 'description' => 'Object名称的前缀,用于筛选需要处理的Object。最大长度为1023个字符。单个Rule中最多一个Prefix。前后缀不支持正则表达。', 'type' => 'string', 'example' => 'a/'], 'Suffix' => ['title' => '', 'description' => 'Object名称的后缀,用于筛选需要处理的Object。最大长度为1023个字符。单个Rule中最多一个Suffix。前后缀不支持正则表达。', 'type' => 'string', 'example' => '.txt'], 'Principals' => [ 'title' => '', 'description' => '保存规则生效的账号与角色列表的容器', 'type' => 'object', 'properties' => [ 'Principal' => [ 'title' => '', 'description' => '规则生效的账号与角色列表。用法与Bucket Policy的Principal相仿,支持主账号、子账号或角色的输入。如果为空或不配置,则表明对于满足前后缀条件的Object,一律不允许覆盖写。', 'type' => 'array', 'items' => ['description' => '授权主体。支持主账号、子账号或角色的输入。如果值为空,则为无效设置。', 'type' => 'string', 'example' => '27737962156157xxxx', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Owner' => [ 'title' => '', 'description' => 'The container that stores the information about the bucket owner.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The user ID of the bucket owner.', 'type' => 'string', 'example' => 'ut_test_bucket'], 'DisplayName' => ['title' => '', 'description' => 'The name of the bucket owner. Currently, this value is the same as the ID.', 'type' => 'string', 'example' => 'ut_test_bucket'], ], 'example' => '', ], 'Part' => [ 'title' => '', 'description' => 'The container that stores information about uploaded parts.', 'type' => 'object', 'properties' => [ 'ETag' => ['title' => '', 'description' => 'The ETag value returned by OSS after the part is successfully uploaded.', 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****'], 'PartNumber' => ['title' => '', 'description' => 'The part number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'The size of the uploaded part.', 'type' => 'integer', 'format' => 'int64', 'example' => '6291456'], 'LastModified' => ['title' => '', 'description' => 'The time when the part was uploaded.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T07:01:34.000Z'], ], 'example' => '', ], 'PromoteDataLakeCacheReq' => [ 'title' => '', 'description' => '加速器缓存管理请求', 'type' => 'object', 'properties' => [ 'Object' => [ 'title' => '要缓存的文件信息', 'type' => 'object', 'properties' => [ 'ObjectName' => ['title' => '要缓存的文件名称', 'type' => 'string', 'example' => 'test.data'], 'Range' => ['title' => '要缓存的文件范围', 'type' => 'string', 'example' => '1024-2048'], ], ], ], 'alibabaCloud' => 'alibabaCloud:1.0.0', 'info' => ['runtimeType' => 'none', 'namespace' => 'Oss::2019-05-17', 'apiStyle' => 'restful'], 'components' => [ 'schemas' => [ 'PromoteDataLakeCacheReq' => [ 'title' => '加速器缓存管理请求', 'description' => '加速器缓存管理请求', 'type' => 'object', 'properties' => [ 'Object' => [ 'title' => '要缓存的文件信息', 'type' => 'object', 'properties' => [ 'ObjectName' => ['title' => '要缓存的文件名称', 'type' => 'string', 'example' => 'test.data'], 'Range' => ['title' => '要缓存的文件范围', 'type' => 'string', 'example' => '1024-2048'], ], ], ], ], ], ], 'example' => '', ], 'PublicAccessBlockConfiguration' => [ 'title' => '', 'description' => 'The Block Public Access configuration.', 'type' => 'object', 'properties' => [ 'BlockPublicAccess' => ['title' => '', 'description' => 'Specifies whether to enable Block Public Access. Valid values:'."\n" .'- true: Block Public Access is enabled.'."\n" .'- false: Block Public Access is disabled.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'PutReplicationRule' => [ 'title' => '', 'description' => 'The data replication rule.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The unique identifier of the data replication rule.', 'type' => 'string', 'example' => 'first-repl-rule'], 'PrefixSet' => ['title' => '', 'description' => 'The container that stores the key prefix configuration for the objects to be replicated.', '$ref' => '#/components/schemas/ReplicationPrefixSet', 'example' => ''], 'Action' => ['title' => '', 'description' => 'Specifies the operations that can be replicated to the destination bucket. If Action is configured, both new data writes and historical data synchronization follow the replication operations specified by Action. Action allows the following operation types. You can specify one or more types. Valid values:'."\n" ."\n" .'- ALL (default): PUT, DELETE, and ABORT operations are all replicated to the destination bucket.'."\n" .'- PUT: write operations that are replicated to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.', 'type' => 'string', 'example' => 'ALL'], 'Destination' => ['title' => '', 'description' => 'The container that stores the destination bucket information.', '$ref' => '#/components/schemas/ReplicationDestination', 'example' => ''], 'HistoricalObjectReplication' => [ 'title' => '', 'description' => 'Specifies whether to replicate historical data.', 'type' => 'string', 'example' => 'disabled', 'enum' => ['enabled', 'disabled'], ], 'SyncRole' => ['title' => '', 'description' => 'The role that authorizes OSS to perform data replication.', 'type' => 'string', 'example' => 'aliyunramrole'], 'SourceSelectionCriteria' => ['title' => '', 'description' => 'The container that stores additional filter criteria for identifying source objects to be replicated.', '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', 'example' => ''], 'EncryptionConfiguration' => ['title' => '', 'description' => 'The encryption configuration for destination objects.', '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', 'example' => ''], 'RTC' => ['description' => 'The container that stores the replication time control (RTC) configuration.', '$ref' => '#/components/schemas/RTC', 'title' => '', 'example' => ''], ], 'example' => '', ], 'QoSConfiguration' => [ 'title' => '', 'description' => 'The throttle quota information.', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => ['title' => '', 'description' => 'The total upstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'IntranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ExtranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalDownloadBandwidth' => ['title' => '', 'description' => 'The total downstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'IntranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'ExtranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalQps' => ['title' => '', 'description' => 'The total queries per second (QPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'IntranetQps' => ['title' => '', 'description' => 'The QPS over the internal network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'ExtranetQps' => ['title' => '', 'description' => 'The QPS over the public network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], ], 'example' => '', ], 'QoSConfigurationWithRemark' => [ 'title' => '', 'description' => 'The QoS configuration with remarks.', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => ['title' => '', 'description' => 'The total upstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'IntranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ExtranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalDownloadBandwidth' => ['title' => '', 'description' => 'The total downstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'IntranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'ExtranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalQps' => ['title' => '', 'description' => 'The total QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'IntranetQps' => ['title' => '', 'description' => 'The QPS over the internal network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'ExtranetQps' => ['title' => '', 'description' => 'The QPS over the public network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'integer', 'format' => 'int64', 'example' => '备注'], ], 'example' => '', ], 'RefererConfiguration' => [ 'title' => '', 'description' => 'The container that stores the Referer configuration.', 'type' => 'object', 'properties' => [ 'AllowEmptyReferer' => [ 'title' => '', 'description' => 'Specifies whether to allow requests with an empty Referer field to access OSS. Valid values:'."\n" ."\n" .'- true (default): Requests with an empty Referer field are allowed to access OSS.'."\n" .'- false: Requests with an empty Referer field are not allowed to access OSS.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'true', ], 'AllowTruncateQueryString' => [ 'title' => '', 'description' => 'Specifies whether to truncate the query string. Valid values:'."\n" ."\n" .'- true (default): Truncates the query string.'."\n" ."\n" .'- false: Does not truncate the query string.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'TruncatePath' => [ 'title' => '', 'description' => 'Specifies whether to truncate the path during matching (that is, only match the protocol://host/ part). Valid values:'."\n" ."\n" .'- true: Truncates all parts of the URL after and including the path.'."\n" ."\n" .'- false: Does not truncate any parts of the URL after and including the path.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'RefererList' => [ 'title' => '', 'description' => 'The container that stores the Referer whitelist.'."\n" .'> **Note** PutBucketReferer uses overwrite semantics. The new whitelist specified in RefererList overwrites the existing whitelist. If you upload an empty RefererList (that is, it does not contain a Referer request element), this operation clears the existing whitelist in RefererList.', 'type' => 'object', 'properties' => [ 'Referer' => [ 'title' => '', 'description' => '指定一条Referer访问白名单。'."\n", 'type' => 'array', 'items' => ['description' => '指定一条Referer访问白名单。', 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], 'example' => '', ], ], 'required' => true, 'example' => '', ], 'RefererBlacklist' => [ 'title' => '', 'description' => 'The container that stores the Referer blacklist.', 'type' => 'object', 'properties' => [ 'Referer' => [ 'title' => '', 'description' => '指定一条Referer访问黑名单', 'type' => 'array', 'items' => ['description' => '指定一条Referer访问黑名单', 'type' => 'string', 'example' => 'https://www.abc.com', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'RegionInfo' => [ 'title' => '', 'description' => 'The region information.', 'type' => 'object', 'properties' => [ 'Region' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'InternetEndpoint' => ['title' => '', 'description' => 'The public endpoint of the region.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com'], 'InternalEndpoint' => ['title' => '', 'description' => 'The internal endpoint of the region.', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com'], 'AccelerateEndpoint' => ['title' => '', 'description' => 'The transfer acceleration endpoint of the region. The value is fixed as oss-accelerate.aliyuncs.com.', 'type' => 'string', 'example' => 'oss-accelerate.aliyuncs.com'], ], 'example' => '', ], 'ReplicationConfiguration' => [ 'title' => '', 'description' => 'The data replication configuration.', 'type' => 'object', 'properties' => [ 'Rule' => ['title' => '', 'description' => 'The container for the data replication rule.', '$ref' => '#/components/schemas/PutReplicationRule', 'example' => ''], ], 'example' => '', ], 'ReplicationDestination' => [ 'title' => '', 'description' => 'The container that stores the information about the destination bucket.', 'type' => 'object', 'properties' => [ 'Bucket' => ['title' => '', 'description' => 'The destination bucket to which data is replicated.', 'type' => 'string', 'example' => 'target-bucket'], 'Location' => [ 'title' => '', 'description' => 'The region in which the destination bucket is located.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'oss-cn-beijing', ], 'TransferType' => [ 'title' => '', 'description' => 'The data transfer link used for data replication. Valid values:'."\n" .' - internal (default): the default data transfer link of OSS.'."\n" .' - oss_acc: the transfer acceleration link. You can use the transfer acceleration link only when you create a cross-region replication rule.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'oss_acc', 'enum' => ['internal', 'oss_acc'], ], ], 'example' => '', ], 'ReplicationEncryptionConfiguration' => [ 'title' => '', 'description' => 'The encryption configuration of the destination object.', 'type' => 'object', 'properties' => [ 'ReplicaKmsKeyID' => ['title' => '', 'description' => 'The SSE-KMS key ID. This element is required if you specify replication of objects created with SSE-KMS encryption.', 'type' => 'string', 'example' => 'c4d49f85-ee30-426b-a5ed-95e9139dxxxxx'], ], 'example' => '', ], 'ReplicationPrefixSet' => [ 'title' => '', 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each replication rule.', 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => '', 'description' => 'The prefix of the objects to be replicated. Only objects that match the specified prefix are replicated to the destination bucket.'."\n" .' - The maximum length of a prefix is 1,023 characters.'."\n" .' - If a prefix is configured, both newly written data and historical data are synchronized according to the rules specified by the prefix.', 'type' => 'array', 'items' => ['description' => 'The prefix of the objects to be replicated. Only objects that match the specified prefix are replicated to the destination bucket.'."\n" .' - The maximum length of a prefix is 1,023 characters.'."\n" .' - If a prefix is configured, both newly written data and historical data are synchronized according to the rules specified by the prefix.'."\n" ."\n", 'type' => 'string', 'example' => 'video', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'ReplicationProgressRule' => [ 'title' => '', 'description' => 'The data replication progress information.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'string', 'example' => 'rep01'], 'PrefixSet' => ['title' => '', 'description' => 'The container that stores prefixes. You can specify up to 10 prefixes in each replication rule.', '$ref' => '#/components/schemas/ReplicationPrefixSet', 'example' => ''], 'Action' => [ 'title' => '', 'description' => 'The operations that are replicated to the destination bucket.'."\n" ."\n" .'Action allows the following operation types. You can specify one or more types.'."\n" ."\n" .'ALL (default): PUT, DELETE, and ABORT operations are all replicated to the destination bucket.'."\n" ."\n" .'PUT: write operations that are replicated to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.', 'enumValueTitles' => ['ALL' => 'PUT/DELETE/ABORT操作都会同步', 'PUT' => '仅同步写入类操作'], 'type' => 'string', 'example' => 'PUT', ], 'Destination' => ['title' => '', 'description' => 'The container that stores the destination bucket information.', '$ref' => '#/components/schemas/ReplicationDestination', 'example' => ''], 'Status' => ['title' => '', 'description' => 'The replication status.', 'type' => 'string', 'example' => 'doing'], 'HistoricalObjectReplication' => [ 'title' => '', 'description' => 'Specifies whether to replicate historical data. Historical data refers to the data that exists in the source bucket before data replication is enabled.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- enabled (default): Replicate historical data.'."\n" ."\n" .'- disabled: Do not replicate historical data. Only data written after the cross-region replication rule takes effect is replicated.', 'enumValueTitles' => ['disabled' => '不复制历史数据', 'enabled' => '复制历史数据'], 'type' => 'string', 'example' => 'enabled', ], 'Progress' => [ 'title' => '', 'description' => 'The container that stores the replication progress. This element is returned only when data is being replicated (doing).', 'type' => 'object', 'properties' => [ 'HistoricalObject' => ['title' => '', 'description' => '显示已复制历史数据的百分比。仅对开启了历史数据复制的Bucket有效。', 'type' => 'string', 'example' => '0.86'], 'NewObject' => ['title' => '', 'description' => '显示数据复制到目标Bucket的时间点(GMT格式)。'."\n" ."\n" .'例如Thu, 24 Sep 2015 15:39:18 GMT,表示早于该时间点写入的数据都已复制到目标Bucket。', 'type' => 'string', 'example' => 'Thu, 24 Sep 2015 15:39:18 GMT'], ], 'example' => '', ], ], 'example' => '', ], 'ReplicationRule' => [ 'title' => '', 'description' => 'The data replication rule.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The ID of the request rule.', '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.', '$ref' => '#/components/schemas/ReplicationPrefixSet', 'example' => ''], 'Action' => ['title' => '', 'description' => 'The operations that can be replicated to the destination bucket. If Action is configured, both newly written data and historical data are synchronized based on the replication operations specified by Action.'."\n" ."\n" .'Action allows the following operation types. You can specify one or more types.'."\n" ."\n" .'Valid values:'."\n" .' - ALL (default): PUT, DELETE, and ABORT operations are all replicated to the destination bucket.'."\n" .' - PUT: write operations that are replicated to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.', 'type' => 'string', 'example' => 'PUT'], 'Destination' => ['title' => '', 'description' => 'The container that stores the destination bucket information.', '$ref' => '#/components/schemas/ReplicationDestination', 'example' => ''], 'Status' => ['title' => '', 'description' => 'The replication status.'."\n" ."\n" .'Valid values:'."\n" .' - starting: After a data replication rule is configured, Object Storage Service (OSS) prepares replication tasks for the bucket. In this case, the replication status is starting.'."\n" .' - doing: After the data replication rule takes effect and data is being synchronized, the replication status is doing.'."\n" .' - closing: After the data replication rule is deleted, OSS automatically performs cleanup. In this case, the replication status is closing.', 'type' => 'string', 'example' => 'starting'], 'HistoricalObjectReplication' => [ 'title' => '', 'description' => 'Specifies whether to replicate historical data. This parameter specifies whether to replicate the data in the source bucket to the destination bucket before data replication is enabled.'."\n" ."\n" .'Valid values:'."\n" .' - enabled (default): Historical data is replicated.'."\n" .' - disabled: Historical data is not replicated. Only data written after the data replication rule is created is replicated.', 'type' => 'string', 'example' => 'enabled', 'enum' => ['enabled', 'disabled'], ], 'SyncRole' => ['title' => '', 'description' => 'The role that OSS is authorized to use for data replication. If you specify SSE-KMS to encrypt the destination objects, you must specify this element.', 'type' => 'string', 'example' => 'aliyunramrole'], 'SourceSelectionCriteria' => ['title' => '', 'description' => 'The container for additional filter conditions that identify the source objects to replicate. OSS currently supports filter conditions only for source objects encrypted by using SSE-KMS.', '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', 'example' => ''], 'EncryptionConfiguration' => ['title' => '', 'description' => 'The encryption configuration for destination objects. If you set Status to Enabled, you must specify this element.', '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', 'example' => ''], 'RTC' => ['description' => 'The container that stores the replication time control (RTC) configuration.', '$ref' => '#/components/schemas/RTC', 'title' => '', 'example' => ''], ], 'example' => '', ], 'ReplicationRuleProgress' => [ 'title' => '', 'description' => 'The progress information of a data replication rule.', 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'description' => 'The ID of the data replication rule.', '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.', '$ref' => '#/components/schemas/ReplicationPrefixSet', 'title' => '', 'example' => ''], 'Action' => ['title' => '', 'description' => 'The operations that are replicated to the destination bucket.'."\n" .'You can specify one or more of the following operation types for Action.'."\n" ."\n" .'- ALL (default): PUT, DELETE, and ABORT operations are replicated to the destination bucket.'."\n" ."\n" .'- PUT: Write operations that are replicated to the destination bucket, including PutObject, PostObject, AppendObject, CopyObject, PutObjectACL, InitiateMultipartUpload, UploadPart, UploadPartCopy, and CompleteMultipartUpload.', 'type' => 'string', 'example' => 'ALL'], ], 'example' => '', ], 'ReplicationRules' => [ 'title' => '', 'description' => 'The container that stores the data replication rule to delete.', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '', 'description' => 'The ID of the replication rule to delete. You can retrieve the rule ID by calling the GetBucketReplication operation.', 'type' => 'array', 'items' => ['description' => 'The ID of the replication rule to delete. You can retrieve the rule ID by calling the GetBucketReplication operation.', 'type' => 'string', 'example' => 'test_replication_1', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'ReplicationSourceSelectionCriteria' => [ 'title' => '', 'description' => 'The container for additional filter conditions that identify source objects to be replicated. Currently, OSS supports specifying filter conditions only for source objects encrypted with SSE-KMS.', 'type' => 'object', 'properties' => [ 'SseKmsEncryptedObjects' => [ 'title' => '', 'description' => 'The container for filtering objects encrypted with SSE-KMS. If SourceSelectionCriteria is specified in the data replication rule, this element is required.', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '', 'description' => '指定OSS是否复制通过SSE-KMS加密创建的对象。取值范围如下:'."\n" .' - Enabled:表示复制通过SSE-KMS加密创建的对象。'."\n" .' - Disabled:表示不复制通过SSE-KMS加密创建的对象。', 'type' => 'string', 'example' => 'Enabled', 'enum' => ['Enabled', 'Disabled'], ], ], 'example' => '', ], ], 'example' => '', ], 'RequesterQoSInfo' => [ 'title' => '', 'description' => 'The container that stores the requester QoS configuration information.', 'type' => 'object', 'properties' => [ 'Requester' => ['title' => '', 'description' => 'The requester ID.', 'type' => 'string', 'example' => '21234567890090'], 'QoSConfiguration' => ['title' => '', 'description' => 'The requester QoS configuration.', '$ref' => '#/components/schemas/QoSConfiguration', 'example' => ''], ], 'example' => '', ], 'RequestPaymentConfiguration' => [ 'title' => '', 'description' => 'The container for the pay-by-requester configuration.', 'type' => 'object', 'properties' => [ 'Payer' => ['title' => '', 'description' => 'Specifies the pay by requester type for the bucket. Valid values:'."\n" ."\n" .'- BucketOwner: The bucket owner pays.'."\n" ."\n" .'- Requester: The requester pays.', 'type' => 'string', 'example' => 'Requester'], ], 'example' => '', ], 'ReservedCapacityCreateConfiguration' => [ 'title' => '创建预留空间的配置', 'description' => '创建预留空间的配置', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '预留空间实例的名称', 'type' => 'string', 'example' => 'test-rc-01'], 'Region' => ['title' => '预留空间所属地域', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'Capacity' => ['title' => '预留空间大小', 'type' => 'integer', 'format' => 'int64', 'example' => '11258999068426240'], 'DataRedundancyType' => ['title' => '预留空间冗余类型', 'type' => 'string', 'example' => 'LRS'], 'Years' => ['title' => '预留空间有效时长', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], 'ReservedCapacityRecord' => [ 'title' => '保存预留空间信息的容器', 'description' => '创建预留空间的信息', 'type' => 'object', 'properties' => [ 'Owner' => ['title' => '预留空间的所有者', '$ref' => '#/components/schemas/Owner'], 'ID' => ['title' => '预留空间的ID', 'type' => 'string', 'example' => 'c99797e7-510d-41e3-ac82-e851c17e1f5c'], 'Name' => ['title' => '预留空间的名称', 'type' => 'string', 'example' => 'test-rc-01'], 'Region' => ['title' => '预留空间所属地域', 'type' => 'string', 'example' => 'oss-cn-hangzhou'], 'Version' => ['title' => '预留空间版本', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Capacity' => ['title' => '预留空间容量', 'type' => 'integer', 'format' => 'int64', 'example' => '11258999068426240'], 'CreateTime' => ['title' => '创建时间时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1733822455'], 'LastModifyTime' => ['title' => '最后一次修改时间时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1733822455'], 'LastExpansionCapacity' => ['title' => '最后一次扩展容量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'ExpansionTime' => ['title' => '最后一次扩展时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'DueTime' => ['title' => '过期时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Years' => ['title' => '有效时长', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'FirstTimeEnabled' => ['title' => '最后一次生效时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Status' => ['title' => '当前状态', 'type' => 'string', 'example' => 'Init'], 'DataRedundancyType' => ['title' => '冗余类型', 'type' => 'string', 'example' => 'LRS'], ], ], 'ReservedCapacityRecordList' => [ 'title' => '预留空间列表', 'description' => '创建预留空间的信息', 'type' => 'object', 'properties' => [ 'ReservedCapacityRecord' => [ 'title' => '保存预留空间列表的容器', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/ReservedCapacityRecord'], ], ], ], 'ReservedCapacityUpdateConfiguration' => [ 'title' => '修改预留空间配置信息的请求内容', 'description' => '修改预留空间配置的请求', 'type' => 'object', 'properties' => [ 'Capacity' => ['title' => '预留空间大小', 'type' => 'integer', 'format' => 'int64', 'example' => '11258999068426240'], 'Years' => ['title' => '预留空间有效市场', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Status' => ['title' => '预留空间状态', 'type' => 'string', 'example' => 'Init'], ], ], 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID.'."\n" ."\n" .'- If this header is included in the request and a resource group ID is specified, OSS returns all buckets that belong to the specified 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 this header is included in the request but no resource group ID is specified, 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 resource group ID from the Resource Management console or by calling the ListResourceGroups operation.'."\n" ."\n" .'You can obtain the resource group ID from 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~~).', 'type' => 'string', 'example' => 'rg-aekz****'], 'ResourcePoolBucket' => [ 'title' => '', 'description' => 'The information about buckets in the resource pool.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'example' => 'test-bucket'], 'JoinTime' => ['title' => '', 'description' => 'The time when the bucket was added to the resource pool.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2024-07-24T08:42:32.000Z'], ], 'example' => '', ], 'ResourcePoolSimpleInfo' => [ 'title' => '', 'description' => 'The brief information about a user resource pool.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the resource pool.', 'type' => 'string', 'example' => 'rp-for-api'], 'CreateTime' => ['title' => '', 'description' => 'The time when the resource pool was created.', 'type' => 'string', 'example' => '2024-07-24T08:42:32.000Z'], ], 'example' => '', ], 'ResponseHeaderConfiguration' => [ 'title' => '', 'description' => 'The container for response header rules.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '', 'description' => 'The list of response header rules.', 'type' => 'array', 'items' => [ 'description' => '保存响应头规则的容器', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => '规则名称', 'type' => 'string', 'example' => 'hiddenHeader'], 'Filters' => [ 'title' => '', 'description' => '指定规则适应的操作的容器', 'type' => 'object', 'properties' => [ 'Operation' => [ 'title' => '', 'description' => '适用操作列表', 'type' => 'array', 'items' => ['description' => '适用操作名称', 'type' => 'string', 'example' => 'GetObject', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'HideHeaders' => [ 'title' => '', 'description' => '指定隐藏哪些响应头的容器', 'type' => 'object', 'properties' => [ 'Header' => [ 'title' => '', 'description' => '隐藏的响应头列表', 'type' => 'array', 'items' => ['description' => '隐藏的响应头名称', 'type' => 'string', 'example' => 'LastModifiedTime', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RestoreRequest' => [ 'title' => '', 'description' => 'The restore request information.', 'type' => 'object', 'properties' => [ 'Days' => ['title' => '', 'description' => 'The number of days for which the object remains in the restored state. Valid values: 1 to 7.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'JobParameters' => [ 'title' => '', 'description' => 'The container for the restore priority. This parameter takes effect only when you restore Cold Archive objects. If you do not specify the JobParameters node, the restore priority defaults to Standard.', 'type' => 'object', 'properties' => [ 'Tier' => ['title' => '', 'description' => 'The restore priority. Valid values:'."\n" .' - Expedited: the restore is completed within 1 hour.'."\n" .' - Standard: the restore is completed within 2 to 5 hours.'."\n" .' - Bulk: the restore is completed within 5 to 12 hours.', 'type' => 'string', 'example' => 'Standard'], ], 'example' => '', ], ], 'example' => '', ], 'Retention' => [ 'title' => '', 'description' => 'The container that stores the object-level data retention policy.', 'type' => 'object', 'properties' => [ 'Mode' => ['description' => 'Object-level data retention policy pattern ', 'title' => '', 'type' => 'string', 'example' => 'COMPLIANCE'], 'RetainUntilDate' => ['description' => 'The absolute date of the object-level data retention policy. The time must be later than the current time. ', 'title' => '', 'type' => 'string', 'example' => '2026-10-11T00:00:00.000Z'], ], 'example' => '', ], 'RoutingRule' => [ 'title' => '', 'description' => 'Specifies redirection rules or mirroring-based back-to-origin rules. You can specify up to 20 RoutingRules.', 'type' => 'object', 'properties' => [ 'RuleNumber' => ['title' => '', 'description' => 'The ordinal number used to match and execute the RoutingRule. OSS matches rules sequentially based on this number. If a match is found, the rule is executed and subsequent rules are skipped.'."\n" ."\n" .'>If the parent node RoutingRule is specified, this parameter is required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Condition' => ['title' => '', 'description' => 'The matching condition.'."\n" .'If all specified items are met, the rule is executed. All conditions under this container must be satisfied for a match to occur.'."\n" .'>If the parent node RoutingRule is specified, this parameter is required.', '$ref' => '#/components/schemas/RoutingRuleCondition', 'example' => ''], 'Redirect' => ['title' => '', 'description' => 'The action to perform after the rule is matched.'."\n" .'>If the parent node RoutingRule is specified, this parameter is required.', '$ref' => '#/components/schemas/RoutingRuleRedirect', 'example' => ''], ], 'example' => '', ], 'RoutingRuleCondition' => [ 'title' => '', 'description' => 'The matching conditions.'."\n" .'If all specified conditions are met, the rule is applied. All conditions under this container must be satisfied for a match.'."\n" .'>If the parent node RoutingRule is specified, this parameter is required.', 'type' => 'object', 'properties' => [ 'KeyPrefixEquals' => ['title' => '', 'description' => 'Only objects that match this prefix can match the rule.', 'type' => 'string', 'example' => 'abc'], 'KeySuffixEquals' => ['title' => '', 'description' => 'Only objects that match this suffix can match the rule.', 'type' => 'string', 'example' => '.txt'], 'HttpErrorCodeReturnedEquals' => ['title' => '', 'description' => 'The HTTP status code that must be returned when the specified object is accessed for the rule to match. When the redirection rule type is mirroring-based back-to-origin, this field must be 404.', 'type' => 'integer', 'format' => 'int64', 'example' => '404'], 'IncludeHeader' => [ 'title' => '', 'description' => 'The rule is matched only when the request contains the specified header with the specified value. You can specify up to 10 headers in this container.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => '只有请求中包含了此Header且值满足条件,才能匹配此规则。', 'type' => 'string', 'example' => 'test-header'], 'Equals' => ['title' => '', 'description' => '只有请求中包含了Key指定的Header且值为指定值时,才能匹配此规则。', 'type' => 'string', 'example' => 'test-value'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RoutingRuleLuaConfig' => [ 'title' => '', 'description' => 'The Lua script configuration to execute.', 'type' => 'object', 'properties' => [ 'Script' => ['title' => '', 'description' => 'The Lua script name.', 'type' => 'string', 'example' => 'test.lua'], ], 'example' => '', ], 'RoutingRuleRedirect' => [ 'title' => '', 'description' => 'Specifies the action to perform after a rule is matched.'."\n" .'>If the parent node RoutingRule is specified, this parameter is required.', 'type' => 'object', 'properties' => [ 'RedirectType' => ['title' => '', 'description' => 'The type of the redirect. Valid values:'."\n" .' - **Mirror**: mirroring-based back-to-origin.'."\n" .' - **External**: external redirect. OSS returns a 3xx response that redirects the request to another URL.'."\n" .' - **AliCDN**: Content Delivery Network (CDN) redirect. This value is mainly used for Alibaba Cloud CDN. Unlike External, OSS adds an additional header. After Content Delivery Network (CDN) identifies this header, it proactively redirects to the specified URL, retrieves the data, and returns the data to the user instead of returning the 3xx redirect response to the user.'."\n" ."\n" .'>If the parent node Redirect is specified, this parameter is required.', 'type' => 'string', 'example' => 'Mirror'], 'PassQueryString' => [ 'title' => '', 'description' => 'Specifies whether to include the request parameters of the original request in the redirect or mirroring-based back-to-origin request.'."\n" .'If a request to OSS includes the request parameter `?a=b&c=d` and **PassQueryString** is set to true, the request parameters are appended to the Location header for a 302 redirect. For example, `Location:example.com?a=b&c=d`. If the redirect type is mirroring-based back-to-origin, the request parameters are also included in the back-to-origin request.'."\n" .'Valid values: true, false (default).', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'MirrorURL' => [ 'title' => '', 'description' => 'The address of the origin server for mirroring-based back-to-origin. This parameter takes effect only when RedirectType is set to Mirror.'."\n" .'The address of the origin server must start with **http://** or **https://** and end with a forward slash (/). OSS appends the object name to this URL to form the back-to-origin URL.'."\n" .'For example, if the object to access is myobject and this parameter is set to `http://example.com/`, the back-to-origin URL is `http://example.com/myobject`. If this parameter is set to `http://example.com/dir1/`, the back-to-origin URL is `http://example.com/dir1/myobject`.'."\n" .'>If RedirectType is set to Mirror, this parameter is required.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'string', 'example' => 'http://example.com', ], 'MirrorSNI' => ['title' => '', 'description' => 'Specifies whether to pass through the Server Name Indication (SNI).', 'type' => 'boolean', 'example' => 'true'], 'MirrorPassQueryString' => [ 'title' => '', 'description' => 'Has the same function as PassQueryString but takes higher priority than PassQueryString. This parameter takes effect only when RedirectType is set to Mirror.'."\n" .'Default value: false.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'MirrorFollowRedirect' => [ 'title' => '', 'description' => 'Specifies whether to follow the redirect to the URL specified in the Location header if the mirroring-based back-to-origin response is 3xx. This parameter takes effect only when RedirectType is set to Mirror.'."\n" .'For example, when a mirroring-based back-to-origin request is initiated, the origin server returns 302 with a specified Location.'."\n" .' - If this parameter is set to true, OSS continues to request the URL specified in the Location header.'."\n" .'A maximum of 10 redirects are allowed. If the number of redirects exceeds 10, a mirroring-based back-to-origin failure is returned.'."\n" .' - If this parameter is set to false, OSS returns 302 and passes through the Location header.'."\n" ."\n" .'Default value: true.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], 'MirrorCheckMd5' => [ 'title' => '', 'description' => 'Specifies whether to check the MD5 hash of the back-to-origin response body. This parameter takes effect only when RedirectType is set to Mirror.'."\n" .'If **MirrorCheckMd5** is set to true and the response from the origin server contains the Content-Md5 header, OSS checks whether the MD5 hash of the retrieved data matches this header value. If the values do not match, the data is not stored in OSS.'."\n" .'Default value: false.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'MirrorHeaders' => [ 'title' => '', 'description' => 'The headers to include in the mirroring-based back-to-origin request. This parameter takes effect only when RedirectType is set to Mirror.', 'type' => 'object', 'properties' => [ 'PassAll' => [ 'title' => '', 'description' => ' 是否透传除以下Header之外的其他Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .' - content-length、authorization2、authorization、range、date等Header'."\n" .' - 以oss-/x-oss-/x-drs-开头的Header'."\n" ."\n" .'默认值:false'."\n", 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'Pass' => [ 'title' => '', 'description' => '透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .'每个Header长度最多为1024个字节,字符集为0~9、A~Z、a~z以及短划线(-)。'."\n" .'此字段最多可指定10个。'."\n", 'type' => 'array', 'items' => ['description' => '透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .'每个Header长度最多为1024个字节,字符集为0~9、A~Z、a~z以及短划线(-)。'."\n" .'此字段最多可指定10个。'."\n", 'type' => 'string', 'example' => 'myheader-key1', 'title' => ''], 'example' => '', ], 'Remove' => [ 'title' => '', 'description' => '禁止透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .'每个Header长度最多为1024个字节,字符集与Pass相同。'."\n" .'此字段最多可指定10个,通常与PassAll一起使用。'."\n", 'type' => 'array', 'items' => ['description' => '禁止透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .'每个Header长度最多为1024个字节,字符集与Pass相同。'."\n" .'此字段最多可指定10个,通常与PassAll一起使用。'."\n", 'type' => 'string', 'example' => 'myheader-key3', 'title' => ''], 'example' => '', ], 'Set' => [ 'title' => '', 'description' => '设置一个Header传到源站,不管请求中是否携带这些指定的Header,回源时都会设置这些Header。只有设置RedirectType为Mirror时才生效。'."\n" .'此容器最多可指定10组。'."\n", 'type' => 'array', 'items' => [ 'description' => '设置一个Header传到源站,不管请求中是否携带这些指定的Header,回源时都会设置这些Header。只有设置RedirectType为Mirror时才生效。'."\n" .'此容器最多可指定10组。'."\n", 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => '设置Header的key,最多1024个字节,字符集与Pass相同。只有设置RedirectType为Mirror时才生效。'."\n" .'>若指定了父节点Set,则必须指定此项。', 'type' => 'string', 'example' => 'myheader-key5'], 'Value' => ['title' => '', 'description' => '设置Header的value,最多1024个字节,不能出现`'."\r\n" .'`。只有设置RedirectType为Mirror时才生效。'."\n" .'>若指定了父节点Set,则必须指定此项。', 'type' => 'string', 'example' => 'myheader-value5'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Protocol' => ['title' => '', 'description' => 'The protocol used for the redirect. This parameter takes effect only when RedirectType is set to External or AliCDN.'."\n" .'For example, if the object to access is test, the redirect destination is `example.com`, and Protocol is set to https, the Location header is `https://example.com/test`.'."\n" .'Valid values: **http**, **https**.', 'type' => 'string', 'example' => 'http'], 'HostName' => ['title' => '', 'description' => 'The domain name used for the redirect. The domain name must comply with domain name specifications.'."\n" .'For example, if the object to access is test, Protocol is set to https, and Hostname is set to `example.com`, the Location header is `https://example.com/test`.', 'type' => 'string', 'example' => 'example.com'], 'ReplaceKeyPrefixWith' => ['title' => '', 'description' => 'The string that replaces the prefix of the object name during the redirect. If the prefix is empty, this string is prepended to the object name.'."\n" .'> Only one of ReplaceKeyWith or ReplaceKeyPrefixWith can be specified.'."\n" .'For example, if the object to access is abc/test.txt, KeyPrefixEquals is set to abc/, and ReplaceKeyPrefixWith is set to def/, the Location header is `http://example.com/def/test.txt`.', 'type' => 'string', 'example' => 'def/'], 'EnableReplacePrefix' => [ 'title' => '', 'description' => 'If this parameter is set to true, the prefix of the object is replaced with the value specified by ReplaceKeyPrefixWith. If this parameter is not specified or is empty, the object prefix is truncated.'."\n" .'> This parameter cannot be set to true when the ReplaceKeyWith parameter is not empty.'."\n" ."\n" .'Default value: false.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], 'ReplaceKeyWith' => ['title' => '', 'description' => 'The string that replaces the object name during the redirect. ReplaceKeyWith supports variables. The supported variable is ${key}, which represents the object name in the request.'."\n" .'For example, if the object to access is test and ReplaceKeyWith is set to `prefix/${key}.suffix`, the Location header is `http://example.com/prefix/test.suffix`.', 'type' => 'string', 'example' => 'prefix/${key}.suffix'], 'HttpRedirectCode' => ['title' => '', 'description' => 'The HTTP redirect code returned during the redirect. This parameter takes effect only when RedirectType is set to External or AliCDN.'."\n" .'Valid values: 301 (default), 302, 307.', 'type' => 'integer', 'format' => 'int64', 'example' => '301'], 'MirrorPassOriginalSlashes' => ['title' => '', 'description' => 'Specifies whether to pass through forward slashes (/) to the origin server.', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], 'RTC' => [ 'title' => '', 'description' => 'The status of the data replication time control (RTC) feature.', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '', 'description' => 'Indicates whether the replication time control (RTC) feature is enabled.', 'enumValueTitles' => ['disabled' => 'The RTC feature is disabled.', 'enabled' => 'The RTC feature is enabled.'], 'type' => 'string', 'example' => 'Enabled', ], ], 'example' => '', ], 'RtcConfiguration' => [ 'title' => '', 'description' => 'The data replication time control (RTC) configuration container.', 'type' => 'object', 'properties' => [ 'RTC' => ['description' => 'The container that stores the RTC status rule.', '$ref' => '#/components/schemas/RTC', 'title' => '', 'example' => ''], 'ID' => ['title' => '', 'description' => 'The ID of the replication rule for which you want to set the RTC status.', 'type' => 'string', 'example' => 'test_replication_rule_1'], ], 'example' => '', ], 'SelectMetaRequest' => [ 'title' => '', 'description' => 'The container that stores SelectMetaRequest information.', 'type' => 'object', 'properties' => [ 'InputSerialization' => ['description' => 'The input serialization parameter (optional).', '$ref' => '#/components/schemas/InputSerialization', 'title' => '', 'example' => ''], 'OverwriteIfExists' => [ 'title' => '', 'description' => 'Recalculates SelectMeta and overwrites existing data.'."\n" .'
Default value: false (if Select Meta already exists, the existing data is returned directly).', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'false', ], ], 'example' => '', ], 'SelectMetaStatus' => [ 'title' => '', 'description' => 'The container that stores CreateSelectObjectMeta information.', 'type' => 'object', 'properties' => [ 'Offset' => ['title' => '', 'description' => 'An 8-bit integer that specifies the file offset when the scan ends.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000065'], 'TotalScannedBytes' => ['title' => '', 'description' => 'An 8-bit integer that specifies the total size of scanned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000065'], 'Status' => ['title' => '', 'description' => 'A 4-bit integer that specifies the final status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x000000c8'], 'SplitsCount' => ['title' => '', 'description' => 'A 4-bit integer that specifies the total number of splits.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x00000001'], 'RowsCount' => ['title' => '', 'description' => 'An 8-bit integer that specifies the total number of rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000003'], 'ColsCount' => ['title' => '', 'description' => 'A 4-bit integer that specifies the total number of columns.', 'type' => 'integer', 'format' => 'int64', 'example' => '0x00000004'], 'ErrorMessage' => ['title' => '', 'description' => 'The detailed error message. If no error occurs, this value is empty.', 'type' => 'string', 'example' => 'The body size in select request exceeds the max allowed size.'], ], 'example' => '', ], 'SelectProcess' => ['description' => 'The optional x-oss-process parameter for SelectObject.', 'type' => 'string', 'example' => 'csv/select', 'title' => ''], 'SelectRequest' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'Expression' => ['title' => '', 'description' => 'The Base64-encoded SQL statement.', 'type' => 'string', 'example' => 'c2VsZWN0IGNvdW50KCopIGZyb20gb3Nzb2JqZWN0IHdoZXJlIF80ID4gNDU='], 'InputSerialization' => ['description' => 'The input serialization parameters.', '$ref' => '#/components/schemas/InputSerialization', 'title' => '', 'example' => ''], 'OutputSerialization' => ['description' => 'The output serialization parameters.', '$ref' => '#/components/schemas/OutputSerialization', 'title' => '', 'example' => ''], 'Options' => ['description' => 'The other optional parameters.', '$ref' => '#/components/schemas/SelectRequestOptions', 'title' => '', 'example' => ''], ], 'example' => '', ], 'SelectRequestOptions' => [ 'title' => '', 'description' => 'The container that stores the Select request.', 'type' => 'object', 'properties' => [ 'SkipPartialDataRecord' => [ 'title' => '', 'description' => 'Specifies whether to skip rows with missing data.'."\n" ."\n" .'- If this parameter is set to false, OSS ignores missing columns (treating the column values as null) without reporting errors.'."\n" ."\n" .'- If this parameter is set to true, the entire row is skipped because the data is incomplete. If the number of skipped rows exceeds the specified maximum number of rows that can be skipped, OSS reports an error and stops processing.', 'enumValueTitles' => ['false' => 'false', 'true' => 'true'], 'type' => 'boolean', 'example' => 'false', ], 'MaxSkippedRecordsAllowed' => ['title' => '', 'description' => 'The maximum number of rows that can be skipped. A row is skipped if the data in the row does not match the type expected in the SQL statement, or if one or more columns are missing and SkipPartialDataRecord is set to True. If the number of skipped rows exceeds the value of this parameter, OSS stops processing and reports an error.'."\n" .'
Default value: 0.'."\n" ."\n" .'> If a row is an invalid CSV row, for example, a column contains an odd number of consecutive quote characters, OSS immediately stops processing and reports an error because the error is likely to affect the parsing of the entire CSV file. This parameter is used to adjust the tolerance for irregular data but does not apply to invalid CSV files.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], 'example' => '', ], 'ServerSideEncryptionRule' => [ 'title' => '', 'description' => 'The container for the server-side encryption rule.', 'type' => 'object', 'properties' => [ 'ApplyServerSideEncryptionByDefault' => ['description' => 'The container for the default server-side encryption method.', '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', 'title' => '', 'example' => ''], ], 'example' => '', ], 'SSEKMS' => [ 'title' => '', 'description' => 'The container that stores SSE-KMS encryption keys.', 'type' => 'object', 'properties' => [ 'KeyId' => ['title' => '', 'description' => 'The KMS key ID.', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****'], ], 'example' => '', ], 'SSEOSS' => [ 'title' => '', 'description' => 'Uses an OSS fully managed key for encryption and decryption.', 'type' => 'string', 'properties' => [], 'example' => 'SSE-OSS', ], 'StorageClass' => [ 'title' => '', 'description' => 'The storage class of the bucket. Valid values:'."\n" ."\n" .'- Standard (default): Standard.'."\n" .'- IA: Infrequent Access.'."\n" .'- Archive: Archive.'."\n" .'- ColdArchive: Cold Archive.'."\n" .'- DeepColdArchive: Deep Cold Archive.', 'enumValueTitles' => ['Archive' => 'Archive', 'ColdArchive' => 'ColdArchive', 'IA' => 'IA', 'Standard' => 'Standard'], 'type' => 'string', 'example' => 'Standard', 'default' => 'Standard', 'enum' => ['Standard', 'IA', 'Archive', 'ColdArchive', 'DeepColdArchive'], ], 'Style' => [ 'title' => '', 'description' => 'The container that stores the list of Content information.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the image style. An image style can contain one or more image processing operations.'."\n" ."\n" .'- An image style that contains a single image processing operation. For example, image/resize,p_50 indicates that the source image is scaled to 50%.'."\n" ."\n" .'- An image style that contains multiple image processing operations. For example, image/resize,p_63/quality,q_90 indicates that the image is first scaled to 63% of the source image, and then the relative quality of the image is set to 90%.', 'type' => 'string', 'example' => 'image/resize,p_50'], ], 'example' => '', ], 'StyleInfo' => [ 'title' => '', 'description' => 'The struct that contains the image processing style information of a bucket.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The style name.', 'type' => 'string', 'example' => 'imagestyle'], 'Content' => ['title' => '', 'description' => 'The style content.', 'type' => 'string', 'example' => 'image/resize,p_50'], 'CreateTime' => ['title' => '', 'description' => 'The time when the style was created.', 'type' => 'string', 'example' => 'Wed, 20 May 2020 12:07:15 GMT'], 'LastModifyTime' => ['title' => '', 'description' => 'The time when the style was created.', 'type' => 'string', 'example' => 'Wed, 21 May 2020 12:07:15 GMT'], 'Category' => ['title' => '', 'description' => 'The style category. Valid values:'."\n" .'- image'."\n" .'- document'."\n" .'- video.', 'type' => 'string', 'example' => 'image'], ], 'example' => '', ], 'Tag' => [ 'title' => '', 'description' => 'The container for the bucket tag.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the bucket tag.'."\n" ."\n" .'> - The maximum length is 64 bytes.'."\n" .'> - The key cannot start with `http ://`, `https://`, or `Aliyun`.'."\n" .'> - The key must be UTF-8 encoded.'."\n" .'> - The key cannot be empty.', 'type' => 'string', 'required' => true, 'example' => 'testb'], 'Value' => ['title' => '', 'description' => 'The value of the bucket tag.'."\n" .' > - The maximum length is 128 bytes.'."\n" .' > - The value must be UTF-8 encoded.'."\n" .' > - The value can be empty.', 'type' => 'string', 'example' => 'testv2'], ], 'example' => '', ], 'Tagging' => [ 'title' => '', 'description' => 'The container for the TagSet of the bucket.', 'type' => 'object', 'properties' => [ 'TagSet' => ['title' => '', 'description' => 'The container for a set of bucket tags.', 'required' => false, '$ref' => '#/components/schemas/TagSet', 'example' => ''], ], 'example' => '', ], 'TagSet' => [ 'title' => '', 'description' => 'The collection of labels.', 'type' => 'object', 'properties' => [ 'Tag' => [ 'title' => '', 'description' => 'The collection of labels.', 'type' => 'array', 'items' => ['description' => '标签集合。', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'TransferAccelerationConfiguration' => [ 'title' => '', 'description' => 'The container for the transfer acceleration configuration.', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'title' => '', 'description' => 'Specifies whether transfer acceleration is enabled for the destination bucket. Valid values:'."\n" .' - **true**: Transfer acceleration is enabled.'."\n" .' - **false**: Transfer acceleration is disabled.'."\n" ."\n" .'> Enabling or disabling transfer acceleration takes effect within 30 minutes.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'example' => 'true', ], ], 'example' => '', ], 'Upload' => [ 'title' => '', 'description' => 'The container that stores information about multipart upload events.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The name of the object for which the multipart upload event is initiated.'."\n" ."\n\n" ."\n" .'> The returned results are sorted in alphabetical order by object name. For the same object, the results are sorted in alphabetical order by upload ID.', 'type' => 'string', 'example' => 'multipart.data'], 'UploadId' => ['title' => '', 'description' => 'The ID of the multipart upload event.', 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D6****'], 'Initiated' => ['title' => '', 'description' => 'The time when the multipart upload event was initiated.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T04:18:23.000Z'], ], 'example' => '', ], 'UserAntiDDOSInfo' => [ 'title' => '', 'description' => 'The Anti-DDoS instance information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['title' => '', 'description' => 'The Anti-DDoS instance ID.', 'type' => 'string', 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****'], 'Owner' => ['title' => '', 'description' => 'The UID of the Anti-DDoS instance owner.', 'type' => 'string', 'example' => '114893010724****'], 'Ctime' => ['title' => '', 'description' => 'The creation time of the Anti-DDoS instance. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769503'], 'Mtime' => ['title' => '', 'description' => 'The update time of the Anti-DDoS instance. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769840'], 'ActiveTime' => ['title' => '', 'description' => 'The activation time of the Anti-DDoS instance. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769845'], 'Status' => ['title' => '', 'description' => 'The status of the Anti-DDoS instance. Valid values:'."\n" ."\n" .'- Init: The instance is being initialized for protection.'."\n" ."\n" .'- Defending: The instance is actively providing protection.'."\n" ."\n" .'- HaltDefending: The protection has been deactivated.', 'type' => 'string', 'example' => 'Defending'], ], 'example' => '', ], 'UserDefinedLogFieldsConfiguration' => [ 'title' => '', 'description' => 'The user-defined field configuration in bucket real-time logs.', 'type' => 'object', 'properties' => [ 'HeaderSet' => [ 'title' => '', 'description' => 'The container for custom request header configuration information.', 'type' => 'object', 'properties' => [ 'header' => [ 'title' => '', 'description' => '自定义请求头列表。', 'type' => 'array', 'items' => ['description' => '自定义请求头信息。', 'type' => 'string', 'example' => 'header1', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'ParamSet' => [ 'title' => '', 'description' => 'The container for custom query parameter settings information.', 'type' => 'object', 'properties' => [ 'parameter' => [ 'title' => '', 'description' => '自定义查询参数列表。', 'type' => 'array', 'items' => ['description' => '自定义查询参数信息。', 'type' => 'string', 'example' => 'param1', 'title' => ''], 'example' => 'my-param', ], ], 'example' => '', ], ], 'example' => '', ], 'UserQosConfiguration' => [ 'title' => '', 'description' => 'The user-level request throttling quota.', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => ['title' => '', 'description' => 'The total upstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'IntranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ExtranetUploadBandwidth' => ['title' => '', 'description' => 'The upstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalDownloadBandwidth' => ['title' => '', 'description' => 'The total downstream bandwidth. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'IntranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the internal network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], 'ExtranetDownloadBandwidth' => ['title' => '', 'description' => 'The downstream bandwidth over the public network. Unit: Gbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'TotalQps' => ['title' => '', 'description' => 'The total QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'IntranetQps' => ['title' => '', 'description' => 'The QPS over the internal network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'ExtranetQps' => ['title' => '', 'description' => 'The QPS over the public network.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'], 'Remark' => ['title' => '', 'description' => 'The remarks.', 'type' => 'integer', 'format' => 'int64', 'example' => '备注'], 'Region' => ['title' => '', 'description' => 'The region.', 'type' => 'string', 'example' => 'oss-cn-shanghai'], 'DefaultQoSConfiguration' => ['title' => '', 'description' => 'The default user-level QoS configuration information.', '$ref' => '#/components/schemas/QoSConfigurationWithRemark', 'example' => ''], ], 'example' => '', ], 'VersioningConfiguration' => [ 'title' => '', 'description' => 'The container that stores the versioning state.', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The versioning state. Valid values:'."\n" ."\n" .'- Enabled: The versioning state is enabled.'."\n" ."\n" .'- Suspended: The versioning state is suspended.', 'enumValueTitles' => ['Enabled' => 'Enabled', 'Suspended' => 'Suspended'], 'example' => 'Enabled', '$ref' => '#/components/schemas/BucketVersioningStatus', 'title' => '', ], ], 'example' => '', ], 'VirtualBucket' => [ 'title' => '存储空间配置信息', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '虚拟存储空间的名称', 'type' => 'string', 'example' => 'virtual-bucket'], 'RealBucket' => [ 'title' => '虚拟存储空间关联的真实存储空间列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['title' => '关联的真实存储空间名称', 'type' => 'string', 'example' => 'real-bucket'], 'Status' => ['title' => '关联的真实存储空间状态', 'type' => 'string', 'example' => 'ok'], ], ], ], ], ], 'VirtualBucketConfiguration' => [ 'title' => '保存虚拟存储空间配置信息的容器', 'description' => '虚拟Bucket配置', 'type' => 'object', 'properties' => [ 'RealBucket' => [ 'title' => '关联的真实的存储空间列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => ['title' => '关联的真实存储空间名称', 'type' => 'string', 'example' => 'realbucket-1'], ], ], ], ], ], 'VpcId' => ['title' => '', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4nlw426y44rd3iq4****'], 'WebsiteConfiguration' => [ 'title' => '', 'description' => 'The root node.', 'type' => 'object', 'properties' => [ 'IndexDocument' => ['title' => '', 'description' => 'The container for the default homepage.'."\n" ."\n" .'>Specify at least one of the following three containers: IndexDocument, ErrorDocument, or RoutingRules.', '$ref' => '#/components/schemas/IndexDocument', 'example' => ''], 'ErrorDocument' => ['title' => '', 'description' => 'The container for the 404 page.'."\n" ."\n" .'>Specify at least one of the following three containers: IndexDocument, ErrorDocument, or RoutingRules.', '$ref' => '#/components/schemas/ErrorDocument', 'example' => ''], 'RoutingRules' => [ 'title' => '', 'description' => 'The container for RoutingRule.'."\n" ."\n" .'>Specify at least one of the following three containers: IndexDocument, ErrorDocument, or RoutingRules.', 'type' => 'object', 'properties' => [ 'RoutingRule' => [ 'title' => '', 'description' => '指定跳转规则或者镜像回源规则,最多指定20个RoutingRule。'."\n", 'type' => 'array', 'items' => ['description' => '指定跳转规则或者镜像回源规则,最多指定20个RoutingRule。'."\n", '$ref' => '#/components/schemas/RoutingRule', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'apis' => [ 'AbortBucketWorm' => [ 'summary' => 'Deletes an unlocked data retention policy from a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete an unlocked retention policy', 'description' => 'After a time-based retention policy is created, the policy is in the InProgress state by default. This state is valid for 24 hours. Within the 24-hour validity period, the data in the bucket to which the policy applies is in the protection status.'."\n" ."\n" .'- Within 24 hours after the retention policy is created: If the policy is not committed for locking, the bucket owner and users with authorization can delete the policy. If the retention policy is committed for locking, the policy cannot be deleted. You cannot shorten the protection epoch of the policy but can only extend the protection epoch.'."\n" ."\n" .'- More than 24 hours after the retention policy is created: If the policy is not committed for locking within 24 hours, the policy automatically expires.'."\n" ."\n" .'
If files in the bucket are within the protection epoch, you cannot delete the data retention policy or the bucket. When the bucket is empty, the bucket owner can delete the bucket, which indirectly deletes the data retention policy of the bucket.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:AbortBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'AbortMultipartUpload' => [ 'summary' => 'Cancels a multipart upload event and deletes the corresponding part data.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'oss-example', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the multipart upload event.', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6E****', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Cancel a multipart upload event and delete part data', 'description' => '**Precautions**'."\n" ."\n" .'- You must provide the uploadId that corresponds to the multipart upload event.'."\n" .'- If some parts are still being uploaded during the procedure of canceling a multipart upload event, those parts cannot be deleted by the cancellation operation.'."\n" .'- After you cancel a multipart upload event, you can no longer use the uploadId for any operations, and all uploaded part data is deleted.'."\n" .'- Complete or cancel multipart uploads promptly, because uploaded parts that are neither completed nor canceled occupy bucket storage and incur storage costs.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:AbortMultipartUpload', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'AppendObject' => [ 'summary' => 'Uploads an object by using append upload.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'position', 'in' => 'query', 'schema' => ['description' => 'The position from which the append operation starts. Each time an AppendObject operation succeeds, the x-oss-next-append-position response header specifies the position for the next append operation. The position for the first append operation must be 0. The position for subsequent append operations is the current size of the object. For example, if the first AppendObject request specifies a position of 0 and a content-length of 65536, the second AppendObject request must specify a position of 65536.'."\n" ."\n" .'- If the position is 0 and no object with the same name exists, the AppendObject request is similar to a PutObject request. In this case, you can specify request headers such as x-oss-server-side-encryption. If a valid x-oss-server-side-encryption header is included, subsequent AppendObject responses also include the x-oss-server-side-encryption header. To modify the metadata later, use the CopyObject operation.'."\n" .'- If the position value is valid and content with a size of 0 is appended to an existing appendable object, the status of the object does not change.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => ['description' => 'The method of server-side encryption.'."\n" .'Valid values:'."\n" ."\n" .'- AES256: Keys managed by OSS for encryption and decryption (SSE-OSS).'."\n" .'- KMS: Keys managed by Key Management Service (KMS) for encryption and decryption.'."\n" .'- SM4: The SM4 encryption algorithm.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => ['description' => 'The access control list (ACL) of the object. Valid values:'."\n" ."\n" .'- default: The object inherits the ACL of the bucket in which the object is stored.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have read and access permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have read and access permissions on the object. Other users have only read permissions on the object. Exercise caution when you set the ACL to this value.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have read and access permissions on the object. Exercise caution when you set the ACL to this value.'."\n" ."\n" .'For more information about ACLs, see [ACL](~~100676~~).', '$ref' => '#/components/schemas/ObjectACL', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => ['description' => 'The storage class of the object. Valid values:'."\n" ."\n" .'- Standard'."\n" .'- IA: Infrequent Access'."\n" .'- Archive'."\n" .'For a bucket of any storage class, if you specify this parameter when you upload an object, the object is stored as the specified storage class. For example, if you upload an object to an IA bucket and set x-oss-storage-class to Standard, the object is stored as Standard.'."\n" .'For more information about storage classes, see Overview of storage classes.'."\n" ."\n" .'> This value takes effect only when the first AppendObject operation is performed. It does not take effect for subsequent append operations.', '$ref' => '#/components/schemas/StorageClass', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => 'You can specify the x-oss-meta-* parameter when you create an appendable object. This parameter cannot be included in subsequent append operations. If you specify a parameter prefixed with x-oss-meta-*, the parameter is considered as user metadata.'."\n" .'Size limit: An object can have multiple metadata entries, but the total size of all metadata cannot exceed 8 KB.'."\n" .'Naming conventions: Hyphens (-), digits, and lowercase letters (a to z) are supported. Uppercase letters are converted to lowercase letters. Other characters, including underscores (_), are not supported.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => '创建AppendObject时可以添加x-oss-meta-*,继续追加时不可以携带此参数。如果配置以x-oss-meta-*为前缀的参数,则该参数视为元数据。'."\n" .'元数据大小限制:一个Object可以包含多个元数据,但所有的元数据总大小不能超过8 KB。'."\n" .'元数据命名规则:支持短划线(-)、数字、英文字母(a~z)。英文字符的大写字母会被转成小写字母,不支持下划线(_)在内的其他字符。', 'type' => 'string', 'example' => 'x-oss-meta-location', 'title' => ''], 'example' => 'x-oss-meta-location', 'title' => '', ], ], [ '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)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'no-cache', 'title' => ''], ], [ '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)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'attachment;filename=oss_download.jpg', 'title' => ''], ], [ 'name' => 'Content-Encoding', 'in' => 'header', 'schema' => ['description' => 'The content encoding format of the object. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'utf-8', 'title' => ''], ], [ 'name' => 'Content-MD5', 'in' => 'header', 'schema' => ['description' => 'A value generated by the MD5 algorithm. This request header is used to check whether the content of the received message is the same as the content that is sent.'."\n" .'To obtain the Content-MD5 value, execute the MD5 algorithm on the message body (excluding the header) to obtain a 128-bit number, and then perform Base64 encoding on the number.'."\n" .'Default value: null.'."\n" .'Limit: none.', 'type' => 'string', 'required' => false, 'example' => 'ohhnqLBJFiKkPSBO1eNaUA==', 'title' => ''], ], [ 'name' => 'Expires', 'in' => 'header', 'schema' => ['description' => 'The expiration time. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Wed, 08 Jul 2015 16:57:01 GMT', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request body.', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', 'title' => ''], ], ], '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":"\\n","type":"xml"}]', 'title' => 'Upload an object by using append upload', 'description' => '**Versioning**.'."\n" ."\n" .'When the destination bucket has versioning enabled or suspended, take note of the following items when you perform operations on appendable objects:'."\n" .'- You can perform Related operations only on an object whose current version is an appendable object. OSS does not generate historical versions for the appendable object.'."\n" .'- If you perform a PutObject or DeleteObject operation on an object whose current version is an appendable object, OSS retains the appendable object as a historical version, but the object can no longer be appended.'."\n" .'- Copying appendable objects is not supported.'."\n" .'- You cannot perform Related operations on non-appendable objects, including Normal objects and delete markers.'."\n" ."\n" .'**Limits**.'."\n" ."\n" .'- The maximum size of an object that is generated by using AppendObject is 5 GB.'."\n" .'- Objects that are protected by a [data retention policy](~~90564~~) do not support AppendObject operations.'."\n" .'- Appendable objects do not support server-side KMS encryption with a specified CMK ID.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'CloseMetaQuery' => [ 'summary' => 'Disables the metadata management feature for a bucket. OSS automatically deletes the metadata index of the bucket, and metadata indexing becomes unavailable.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Disable bucket metadata management', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:CloseMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'CompleteBucketWorm' => [ 'summary' => 'Invokes the CompleteBucketWorm operation to lock 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'wormId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the retention policy.', 'type' => 'string', 'required' => true, 'example' => '1666E2CFB2B3418****'], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Lock a retention policy', 'description' => 'After a time-based retention policy is created, the policy is in the InProgress state by default. This state is valid for 24 hours. During the 24-hour validity period, the data in the bucket to which the policy applies is in protection status.'."\n" ."\n" .'- Within 24 hours after the retention policy is initiated: If the policy is not committed to the locked state, the bucket owner and authorized users can delete the policy. If the retention policy is committed to the locked state, the policy cannot be deleted, and the protection period can only be extended, not shortened.'."\n" ."\n" .'- After 24 hours from when the retention policy is initiated: If the retention policy is not committed to the locked state within 24 hours, the policy automatically expires.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:CompleteBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'CompleteMultipartUpload' => [ 'summary' => 'Completes the multipart upload of an entire file.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of this multipart upload event.', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6E****', 'title' => ''], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => ['description' => 'Specifies the encoding type for the returned key. Currently, only URL encoding is supported.'."\n" ."\n\n" .'Keys use UTF-8 characters, but XML 1.0 does not support parsing certain control characters, such as characters with ASCII values from 0 to 10. If a key contains control characters that are not supported by XML 1.0, you can specify encoding-type to encode the returned key.'."\n" ."\n" .'Default value: null.'."\n" ."\n" .'Valid values: url.', '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to overwrite an existing object with the same name when the CompleteMultipartUpload operation is called.'."\n" ."\n" .'- If x-oss-forbid-overwrite is not specified or is set to false, an existing object with the same name is overwritten.'."\n" .'- If x-oss-forbid-overwrite is set to true, an existing object with the same name is not overwritten.'."\n" ."\n" .'> '."\n" .'- If versioning is enabled or suspended for the destination bucket, the x-oss-forbid-overwrite request header is ignored, and an existing object with the same name is overwritten.'."\n" .'- Setting the x-oss-forbid-overwrite request header decreases the QPS processing performance. If you need to use the x-oss-forbid-overwrite request header frequently (QPS > 1000), submit a ticket to confirm and avoid impact on your business.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'x-oss-complete-all', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to list all parts that have been uploaded for the current UploadId.'."\n" ."\n" .'- If x-oss-complete-all:yes is specified, OSS lists all parts that have been uploaded for the current UploadId, sorts them by PartNumber in ascending order, and then performs the CompleteMultipartUpload operation. During the CompleteMultipartUpload process, parts that are being uploaded or missing parts cannot be detected. Therefore, you must ensure the completeness of the parts.'."\n" .'- If x-oss-complete-all:yes is specified, you cannot specify a request body. Otherwise, an error is returned.'."\n" .'- If x-oss-complete-all:yes is specified, the response format remains unchanged.', 'type' => 'string', 'required' => false, 'example' => 'yes', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the CompleteMultipartUpload request content.', 'type' => 'object', 'properties' => [ 'CompleteMultipartUpload' => ['description' => 'The container that stores the CompleteMultipartUpload request content.', '$ref' => '#/components/schemas/CompleteMultipartUpload', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => ['title' => '文件版本id', 'type' => 'string'], ], ], 'schema' => [ 'description' => 'The response body that contains the CompleteMultipartUpload request result.', 'type' => 'object', 'properties' => [ 'CompleteMultipartUploadResult' => [ 'description' => 'The container that stores the CompleteMultipartUpload response content.', 'type' => 'object', 'properties' => [ 'EncodingType' => ['description' => 'Indicates whether the returned key is encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'Location' => ['description' => 'The URL of the newly created object.', 'type' => 'string', 'example' => 'http://oss-example.oss-cn-hangzhou.aliyuncs.com/multipart.data', 'title' => ''], 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'Key' => ['description' => 'The name of the newly created object.', 'type' => 'string', 'example' => 'multipart.data', 'title' => ''], 'ETag' => ['description' => 'The ETag that is created when an object is generated. The ETag identifies the content of an object.'."\n" ."\n" .'The ETag value of an object created by a CompleteMultipartUpload request is a unique value calculated based on specific rules, but is not the MD5 hash of the object content.'."\n" ."\n" .'>You can use the ETag value to check whether the object content has changed. However, do not use the ETag as the MD5 hash of the object content to verify data integrity.', 'type' => 'string', 'example' => '"B864DB6A936D376F9F8D3ED3BBE540****"', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n url\\n http://oss-example.oss-cn-hangzhou.aliyuncs.com/multipart.data\\n example-bucket\\n multipart.data\\n \\"B864DB6A936D376F9F8D3ED3BBE540****\\"\\n","type":"xml"}]', 'title' => 'Complete a multipart upload for an entire file', 'description' => '**Before you begin**.'."\n" ."\n" .'When you call the CompleteMultipartUpload operation, you must provide a list of all valid parts (including PartNumber and ETag). After OSS receives the part list, it verifies the validity of each part. After all parts pass verification, OSS combines these parts into a complete object.'."\n" .'- Confirm part sizes: When CompleteMultipartUpload is called, OSS verifies that all parts except the last part are greater than or equal to 100 KB in size, and checks each PartNumber and ETag in the part list submitted by the user. Therefore, when uploading parts, the client must record not only the part number but also the ETag value returned by the server after each successful part upload.'."\n" ."\n" .'- Request processing: Because OSS takes a certain amount of time to process a CompleteMultipartUpload request, if the connection between the client and OSS is interrupted during this period, OSS continues to process the request.'."\n" ."\n" .'- PartNumber: The server validates PartNumber when the CompleteMultipartUpload operation is called.'."\n" .'Valid values of PartNumber: 1 to 10000. PartNumber values do not need to be consecutive but must be in ascending order. For example, the PartNumber of the first part is 1, and the PartNumber of the second part can be 5.'."\n" ."\n" .'- UploadId: The same object can have multiple UploadId values at the same time. After a specific UploadId is completed, that UploadId becomes invalid, but other UploadId values of the object are not affected.'."\n" ."\n" .'- x-oss-server-side-encryption request header: If the x-oss-server-side-encryption request header is specified when the InitiateMultipartUpload operation is called, the x-oss-server-side-encryption header is returned in the CompleteMultipartUpload response. The value indicates the server-side encryption algorithm of the object.'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'If versioning is enabled for the bucket, calling the CompleteMultipartUpload operation to complete the multipart upload causes OSS to generate a unique version ID for the object and return it in the x-oss-version-id response header.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'CopyObject' => [ 'summary' => 'Copies an object within the same region between the same or different buckets.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'oss-example', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'x-oss-copy-source', 'in' => 'header', 'schema' => ['description' => 'The path of the source object.'."\n" .'Default value: null.', 'type' => 'string', 'required' => true, 'example' => '/oss-example/oss.jpg', 'title' => ''], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to overwrite the destination object with the same name during the CopyObject operation. When the destination bucket is in the enabled or suspended versioning state, the **x-oss-forbid-overwrite** request header is invalid, and the object with the same name can be overwritten.'."\n" .' - If **x-oss-forbid-overwrite** is not specified or is set to **false**, the destination object with the same name can be overwritten.'."\n" .' - If **x-oss-forbid-overwrite** is set to **true**, the object with the same name cannot be overwritten.'."\n" ."\n" .'Setting the **x-oss-forbid-overwrite** request header decreases the QPS processing performance. If you need to use the **x-oss-forbid-overwrite** request header for a large number of operations (QPS > 1000), contact technical support to avoid impact on your business.'."\n" .'Default value: false.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-match', 'in' => 'header', 'schema' => ['description' => 'If the ETag value of the source object matches the ETag value that you specify, the copy operation is performed and 200 OK is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-none-match', 'in' => 'header', 'schema' => ['description' => 'If the ETag value of the source object does not match the ETag value that you specify, the copy operation is performed and 200 OK is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-unmodified-since', 'in' => 'header', 'schema' => ['description' => 'If the specified time is the same as or later than the actual modification time of the object, the object is copied as expected and 200 OK is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '2019-04-09T07:01:56.000Z', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-modified-since', 'in' => 'header', 'schema' => ['description' => 'If the source object has been modified after the specified time, the copy operation is performed.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '2019-04-09T07:01:56.000Z', 'title' => ''], ], [ 'name' => 'x-oss-metadata-directive', 'in' => 'header', 'schema' => ['description' => 'Specifies how to set the metadata of the destination object.'."\n" .' - **COPY** (default): The metadata of the source object is copied to the destination object.'."\n" .'OSS does not copy the **x-oss-server-side-encryption** configuration of the source object to the destination object. The server-side encryption method of the destination object is determined by whether **x-oss-server-side-encryption** is specified in the current copy operation.'."\n" .' - **REPLACE**: The metadata of the source object is ignored, and the metadata specified in the request is used.'."\n" ."\n" .'> If the source object path and the destination object path are the same and versioning is not enabled, the metadata of the source object is ignored regardless of the value of x-oss-metadata-directive. The destination object uses the metadata specified in the request.', 'type' => 'string', 'required' => false, 'example' => 'COPY', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => ['description' => 'Specifies the server-side encryption algorithm that is used when OSS creates the destination object.'."\n" .'Valid values: **AES256**, **KMS**.'."\n" .'You must purchase a KMS suite to use the KMS encryption algorithm. Otherwise, OSS returns the KmsServiceNotEnabled error.'."\n" .' - If **x-oss-server-side-encryption** is not specified in the copy operation, the destination object is not server-side encrypted regardless of whether the source object is server-side encrypted.'."\n" .' - If **x-oss-server-side-encryption** is specified in the copy operation, the destination object is server-side encrypted regardless of whether the source object is server-side encrypted. The response header of the copy operation contains **x-oss-server-side-encryption**, whose value indicates the encryption algorithm of the destination object.'."\n" .'When the destination object is downloaded, the response header also contains **x-oss-server-side-encryption**, whose value indicates the encryption algorithm of the object.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => ['description' => 'Specifies the encryption algorithm of the object. If this parameter is not specified, the object is encrypted by using AES256. This parameter is valid only when x-oss-server-side-encryption is set to KMS.', 'type' => 'string', 'required' => false, 'example' => 'SM4', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => ['description' => 'The ID of the customer master key (CMK) hosted by Key Management Service (KMS).'."\n" .'This parameter is valid only when **x-oss-server-side-encryption** is set to KMS.', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', 'title' => ''], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => ['description' => 'The access control list (ACL) of the destination object that is created by OSS.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- default: The object inherits the ACL of the bucket.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have read and access permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have read and access permissions on the object. Other users have only read permissions on the object. Exercise caution when you set this ACL.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have read and access permissions on the object. Exercise caution when you set this ACL.'."\n" ."\n" .'For more information about ACLs, see **[ACL](~~100676~~)**.', '$ref' => '#/components/schemas/ObjectACL', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => ['description' => 'The storage class of the object.'."\n" .'For a bucket of any storage class, if you specify this parameter when you upload an object, the object is stored as the specified storage class. For example, if you specify **x-oss-storage-class** as Standard when you upload an object to an IA bucket, the object is stored as Standard.'."\n" ."\n" .'Valid values:'."\n" .'- Standard'."\n" .'- IA: Infrequent Access'."\n" .'- Archive'."\n" .'- ColdArchive: Cold Archive'."\n" ."\n" .'For more information about storage classes, see **[Overview of storage classes](~~51374~~)**.', '$ref' => '#/components/schemas/StorageClass', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => ['description' => 'Settings for object tagging of the object. You can configure multiple tags at the same time, for example, TagA=A&TagB=B.'."\n" .'> The key and value must be URL-encoded. If a tag does not contain an equal sign (=), the tag value is considered an empty string.', 'type' => 'string', 'required' => false, 'example' => 'a:1', 'title' => ''], ], [ 'name' => 'x-oss-tagging-directive', 'in' => 'header', 'schema' => ['description' => 'Specifies how to set the object tagging of the destination object. Valid values:'."\n" .' - **Copy** (default): The object tagging of the source object is copied to the destination object.'."\n" .' - **Replace**: The object tagging of the source object is ignored, and the tags specified in the request are used.', 'type' => 'string', 'required' => false, 'example' => 'Copy', 'title' => ''], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => 'If a parameter is prefixed with x-oss-meta-*, the parameter is considered as user metadata.'."\n" .'Size limit: An object can contain multiple metadata entries, but the total size of all metadata cannot exceed 8 KB.'."\n" .'Naming conventions: Hyphens (-), digits, and lowercase letters (a to z) are supported. Uppercase letters are converted to lowercase letters. Other characters, including underscores (_), are not supported.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => '元数据命名规则:支持短划线(-)、数字、英文字母(a~z)。英文字符的大写字母会被转成小写字母,不支持下划线(_)在内的其他字符。', 'type' => 'string', 'example' => 'mx-oss-meta-owner', 'title' => ''], 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-copy-source-version-id' => [ 'schema' => ['type' => 'string'], ], 'x-oss-version-id' => [ 'schema' => ['type' => 'string'], ], ], 'schema' => [ 'description' => 'The response body that contains the CopyObject result.', 'type' => 'object', 'properties' => [ 'CopyObjectResult' => [ 'description' => 'The container that stores the CopyObject result.', 'type' => 'object', 'properties' => [ 'ETag' => ['description' => 'The ETag value of the destination object.', 'type' => 'string', 'example' => '5B3C1A2E053D763E1B002CC607C5****', 'title' => ''], 'LastModified' => ['description' => 'The time when the destination object was last modified.', 'type' => 'string', 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 5B3C1A2E053D763E1B002CC607C5****\\n Fri, 24 Feb 2012 07:18:48 GMT\\n","type":"xml"}]', 'title' => 'Copy an object', 'description' => '**Versioning**.'."\n" ."\n" .'- By default, `x-oss-copy-source` copies the current version of the object. You can add versionId to x-oss-copy-source to copy a specific object version. If the corresponding version of the source object is a delete marker, 404 is returned, indicating that the object does not exist.'."\n" .'- To restore an earlier version of an object as the current version, copy the earlier version of the object to the same bucket. OSS then sets the earlier version as the current version.'."\n" .'- If versioning is enabled for the destination bucket, OSS automatically generates a unique version ID for the copied object. The version ID is returned in the x-oss-version-id response header. If versioning is not enabled or is suspended for the destination bucket, OSS generates a version with a version ID of null for the copied object and overwrites the existing version whose version ID is null.'."\n" ."\n" .'**Limits**.'."\n" ."\n" .'- When you use the CopyObject operation, the object size limits are as follows:'."\n" ."\n" .' - If the source bucket and the destination bucket are the same, no size limit applies.'."\n" ."\n" .' - If the source bucket and the destination bucket are different, copy objects smaller than 1 GB. To copy objects larger than 1 GB, use the [UploadPartCopy](~~31994~~) operation.'."\n" .' '."\n" .' Both the CopyObject and UploadPartCopy operations require read permissions on the source object.'."\n" ."\n" .'- In a bucket with versioning disabled, if the source object and the destination object are the same file when you invoke the CopyObject operation, OSS modifies only the metadata of the source object without copying the content of the source object.'."\n" .'- In a bucket with versioning enabled, objects created by using append upload cannot be copied.'."\n" .'- If the source object is a symbolic link, only the symbolic link is copied. The content of the file to which the symbolic link points is not copied.'."\n" ."\n" .'**Billing**.'."\n" ."\n" .'- Each call to the CopyObject operation adds one GET request to both the bucket that contains the source object and the bucket that contains the destination object.'."\n" .'- Calling the CopyObject operation increases the storage usage of the bucket that contains the destination object.'."\n" .'- Calling the CopyObject operation to change the storage class of an object involves data overwriting. For example, if an Infrequent Access (IA) object is overwritten as Standard within 10 days after it is created, early deletion fees for 20 days of IA storage are incurred. For more information about storage fees, see **[Storage fees](~~173534~~)**.', 'changeSet' => [ ['createdAt' => '2024-03-07T07:13:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject', 'validationType' => 'always'], ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObjectVersionTagging'], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The container that stores the access point information.', 'type' => 'object', 'properties' => [ 'CreateAccessPointConfiguration' => ['description' => 'The container that stores the access point configuration.', '$ref' => '#/components/schemas/CreateAccessPointConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CreateAccessPointResult' => ['description' => 'The container that stores the access point information.', '$ref' => '#/components/schemas/CreateAccessPointResult', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create an access point', 'description' => '- A single Alibaba Cloud account can create up to 1,000 access points.'."\n" .'- A single bucket can have up to 100 access points.', 'changeSet' => [ ['createdAt' => '2024-02-22T01:54:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'CreateBucketDataRedundancyTransition' => [ '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 for which you want to create a data redundancy type conversion task.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-target-redundancy-type', 'in' => 'query', 'schema' => ['description' => 'The target data redundancy type. OSS supports converting only LRS (locally redundant storage) to ZRS (zone-redundant storage).', 'type' => 'string', 'required' => true, 'example' => 'ZRS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'BucketDataRedundancyTransition' => [ 'description' => 'The container for the data redundancy type conversion task.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the data redundancy type conversion task. You can use this ID to query or delete the task.', 'type' => 'string', 'example' => ' '."\n" .'4be5beb0f74f490186311b268bf6****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'xml' => [], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a data redundancy type conversion task', 'summary' => 'Creates a data redundancy type conversion task for a bucket.', 'description' => '- The region of the bucket must support data redundancy type conversion. Regions that support data redundancy type conversion: China (Hangzhou), China (Shanghai), China (Beijing), China (Zhangjiakou), China (Ulanqab), China (Shenzhen), Hong Kong (China), Japan (Tokyo), Singapore, Indonesia (Jakarta), and Germany (Frankfurt).'."\n" .'- The data redundancy type of the bucket must be locally redundant storage. OSS supports converting only locally redundant storage to zone-redundant storage.'."\n" .'- The storage class of the bucket must be Standard, Infrequent Access, or Archive. However, files in the bucket can be of the Cold Archive or Deep Cold Archive storage class. Cold Archive and Deep Cold Archive files remain locally redundant after the conversion. Buckets of the Cold Archive or Deep Cold Archive storage class do not support data redundancy type conversion.'."\n" .'- To create a data redundancy type conversion task, you must have the oss:CreateBucketDataRedundancyTransition permission. For more information, see [Grant a Resource Access Management (RAM) user a custom access policy](~~199058~~).'."\n" .'- Each region has a corresponding endpoint. For more information about the mappings between regions and endpoints, see [Regions and endpoints](~~31837~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateBucketDataRedundancyTransition', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\t\\n4be5beb0f74f490186311b268bf6****\\n","type":"xml"}]', ], 'CreateCnameToken' => [ 'summary' => 'Creates a CnameToken required for domain name ownership verification.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for creating a CnameToken.', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => [ 'description' => 'The container that stores the CNAME configuration.', 'type' => 'object', 'properties' => [ 'Cname' => [ 'description' => 'The container that stores the CNAME domain name for which a token is to be generated.', 'type' => 'object', 'properties' => [ 'Domain' => ['description' => 'The target CNAME domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response that contains the CnameToken.', 'type' => 'object', 'properties' => [ 'CnameToken' => ['description' => 'The container that stores the CnameToken.', '$ref' => '#/components/schemas/CnameToken', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n examplebucket\\n example.com\\n be1d49d863dea9ffeff3df7d6455****\\n Wed, 23 Feb 2022 21:16:37 GMT\\n","type":"xml"}]', 'title' => 'Create a cnameToken', 'changeSet' => [ ['createdAt' => '2024-03-07T06:07:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateCnameToken', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'CreateSelectObjectMeta' => [ 'summary' => 'Retrieves the total number of rows, total number of columns (for CSV files), and the number of splits for a specified file. If this information does not exist, the entire file is scanned, analyzed, and the information is recorded. Subsequent calls to this operation return the saved information without rescanning the entire file.', '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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.png', 'title' => ''], ], [ 'name' => 'x-oss-process', 'in' => 'query', 'schema' => ['description' => 'Set this parameter to csv/meta for CSV files or json/meta for JSON files.', 'type' => 'string', 'required' => true, 'example' => 'csv/meta', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The container that stores the CreateSelectObjectMeta request.', 'type' => 'object', 'properties' => [ 'CsvMetaRequest' => ['description' => 'The container that stores the SelectMetaRequest information.', '$ref' => '#/components/schemas/SelectMetaRequest', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The container that stores the CreateSelectObjectMeta response.', '$ref' => '#/components/schemas/SelectMetaStatus', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 101\\n 101\\n 200\\n 1\\n 3\\n 4\\n The body size in select request exceeds the max allowed size.\\n","type":"xml"}]', 'title' => 'Retrieve total rows, total columns, and splits for a file', 'description' => '- The CreateSelectObjectMeta operation requires write permissions on the object.'."\n" ."\n" .'- If the operation succeeds, 200 is returned. If the specified file is not a valid CSV or JSON Lines file, or the specified CSV separator does not match the file, 400 is returned.', 'changeSet' => [ ['createdAt' => '2025-03-04T06:20:03.000Z', 'description' => 'Request parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => ['description' => 'The name of the access point.', 'type' => 'string', 'required' => true, 'example' => ' '."\n" .'ap-01', 'title' => ''], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete an access point', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => ['title' => '', 'description' => 'The access point name.', 'type' => 'string', 'required' => true, 'example' => 'ap-01'], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'Delete an access point policy', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete a bucket', 'description' => '- Only the bucket owner can delete the bucket.'."\n" .'- To prevent accidental deletion, OSS does not allow you to delete a non-empty bucket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucket', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketCommonHeader' => [ 'summary' => 'Deletes the custom HTTP header configuration of a bucket.', '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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete custom HTTP header configuration of a bucket', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:26.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketCommonHeader', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketCors' => [ 'summary' => 'Calls the DeleteBucketCors operation to disable Cross-Origin Resource Sharing (CORS) for a specified bucket and clear all CORS rules.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Disable CORS for a bucket', 'description' => '### Before you begin'."\n" .'To disable CORS, you must have the `oss:DeleteBucketCors` permission.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketEncryption' => [ 'summary' => 'Deletes the encryption rule of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete the encryption rule of a bucket', 'description' => 'Only the bucket owner and Resource Access Management (RAM) users with authorization can delete the encryption rule of a bucket. Otherwise, a 403 fault is returned. For more information about bucket encryption, see [Server-side encryption](~~31871~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketInventory' => [ 'summary' => 'Deletes a specified inventory rule from 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the inventory rule to delete.', 'type' => 'string', 'required' => true, 'example' => 'list1'], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete a specified inventory rule from a bucket', 'description' => '- Before calling this operation, make sure that you have sufficient permissions to manage inventory rules for the bucket. The bucket owner has this permission by default. If you do not have this permission, request it from the bucket owner.'."\n" .'- A successful request returns HTTP status code 204.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketLifecycle' => [ 'summary' => 'Calls the DeleteBucketLifecycle operation to delete the lifecycle rules of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete lifecycle rules of a bucket', 'description' => '- Only the bucket owner can delete the lifecycle rules of the bucket.'."\n" ."\n" .'- After you call the DeleteBucketLifecycle operation to delete all lifecycle rules of a specified bucket, objects in the bucket are not automatically deleted.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketLogging' => [ 'summary' => 'Performs a shutdown of the access log record 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Disable access log record for a bucket', 'description' => '- Only the bucket owner can perform a shutdown of the access log record feature for the bucket.'."\n" .'- If the target bucket does not have the access log record feature enabled, the parameter in the response returns a 204 status code.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketPolicy' => [ 'summary' => 'Deletes the access policy of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete the access policy of a bucket', 'description' => '- Authorization for Resource Access Management (RAM) users of other accounts.'."\n" ."\n" .'You can grant RAM users of other accounts access permissions to your OSS resources.'."\n" ."\n" .'- Grant anonymous users access permissions with specific IP address restrictions.'."\n" ."\n" .'In some scenarios, you need to grant anonymous users an access policy with IP address restrictions. For example, confidential documents within an enterprise are allowed to be accessed only from within the enterprise network and not from other areas. Because the enterprise has a large number of employees, configuring a RAM policy for each employee requires a significant amount of effort. In this case, you can use bucket policy settings to configure an access policy with IP address restrictions, which allows efficient authorization.'."\n" ."\n" .'For details about bucket policy configurations and scenario examples, see [Use bucket policies to authorize other users to access OSS resources](~~85111~~). For more information about the policy syntax, see [Policy syntax and structure](~~93739~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketReplication' => [ 'summary' => 'Stops data replication for a bucket and deletes the replication configuration of the bucket. After this operation, any operations on the source bucket are no longer 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the data replication rule to delete.', 'type' => 'object', 'properties' => [ 'ReplicationRules' => [ 'description' => 'The container that stores the data replication rule to delete.', 'type' => 'object', 'properties' => [ 'ID' => ['description' => 'The name of the data replication rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'first-rule', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Stop data replication for a bucket and delete its replication configuration', 'description' => '- If the requested bucket does not have a data replication rule configured, this operation returns 200 HTTP OK.'."\n" ."\n" .'- When you call this operation to delete a data replication rule, the rule is not immediately deleted. Object Storage Service (OSS) requires some time to perform cleanup operations, during which the replication rule status is closing. The replication rule is deleted only after the cleanup is complete.'."\n" ."\n" .'- If the data replication rule of the requested bucket is in the closing state, this operation returns 204 NoContent.', 'changeSet' => [ ['createdAt' => '2024-03-05T07:48:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketTags' => [ 'summary' => 'Deletes bucket tags.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete bucket tags', 'description' => 'If the target bucket does not have any tags or the specified tag key does not exist, HTTP status code 204 is returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteBucketWebsite' => [ 'summary' => 'Disables static website hosting and 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Disable static website hosting and redirection rules for a bucket', 'description' => 'Only the bucket owner can disable static website hosting for the bucket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteCname' => [ 'summary' => 'Deletes a CNAME that is bound 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for deleting the CNAME configuration.', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => [ 'description' => 'The container that stores the CNAME configuration.', 'type' => 'object', 'properties' => [ 'Cname' => [ 'description' => 'The container that stores the target CNAME.', 'type' => 'object', 'properties' => [ 'Domain' => ['description' => 'The CNAME to delete.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete a CNAME', 'changeSet' => [ ['createdAt' => '2024-03-05T12:07:24.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteLiveChannel' => [ 'summary' => 'Deletes 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The name of the LiveChannel. The LiveChannel must exist.', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete a specified live stream', 'description' => '>- If a client is currently streaming to the LiveChannel, the delete request fails.'."\n" .'- This operation deletes only the LiveChannel itself. It does not delete files generated by the stream.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'DeleteObject' => [ 'summary' => 'Deletes 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 bucket information.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object.', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgIDh3ZCB0BYiIGE4YjIyMjExZDhhYjQxNzZiNGUyZTI4ZjljZDcz****', 'title' => ''], ], ], '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' => '**Before you begin**.'."\n" ."\n" .'- To delete an object, you must have write permissions on the object.'."\n" .'- Regardless of whether the object to be deleted exists, a 204 status code is returned after a successful deletion.'."\n" .'- If the object type is a symbolic link, the DeleteObject operation deletes only the symbolic link.'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'The deletion behavior when versioning is enabled is as follows:'."\n" ."\n" .'- Without specifying a versionId (temporary deletion):'."\n" .'If you perform a delete operation without specifying a versionId, the current version of the object is not deleted by default. Instead, a delete marker is inserted for the current version. If you then perform a GetObject operation without specifying a versionId, OSS detects that the current version is a delete marker and returns `404 Not Found`. In addition, the response includes the header `x-oss-delete-marker = true` and the version ID of the newly generated delete marker `x-oss-version-id`.'."\n" .'A value of true for `x-oss-delete-marker` indicates that the version corresponding to the returned `x-oss-version-id` is a delete marker.'."\n" ."\n" .'- With a specified versionId (permanent deletion):'."\n" .'If you perform a delete operation with a specified versionId, OSS permanently deletes the version specified by the `versionId` parameter in `params`. To delete a version whose ID is "null", add `params[\'versionId\'] = "null"` to the `params` parameter. OSS treats the "null" string as a "null" versionId and deletes the object whose versionId is "null".', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:DeleteObjectVersion'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'DeleteObjectTagging' => [ 'summary' => 'Deletes the tagging information 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object to delete.', 'type' => 'string', 'required' => false, 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete object tagging', 'description' => '**Versioning**'."\n" ."\n" .'When you call the DeleteObjectTagging operation, only the tagging information of the current version of the object is deleted by default. You can specify the versionId parameter to delete the tagging information of a specified object version. If the corresponding version of the object is a delete marker, OSS returns 404 Not Found.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:DeleteObjectVersionTagging'], ], ], ], 'translator' => 'machine', ], 'DeletePublicAccessBlock' => [ 'summary' => 'Deletes the user-level Block Public Access configuration.', '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":"\\n","type":"xml"}]', 'title' => 'Delete the user-level block public access configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeletePublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteStyle' => [ 'summary' => 'Deletes a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => ['description' => 'The image style name.', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', 'title' => ''], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Delete an image style', 'changeSet' => [ ['createdAt' => '2024-02-21T07:26:17.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'DescribeRegions' => [ 'summary' => 'Queries the endpoint information of all supported regions or a specified region, including the public endpoint, internal network endpoint, and transfer acceleration endpoint.', '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 requested region ID.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body structure of the DescribeRegions operation.', 'type' => 'object', 'properties' => [ 'RegionInfoList' => [ 'description' => 'The list of region information.', 'type' => 'object', 'properties' => [ 'RegionInfo' => [ 'description' => 'The container that stores information about multiple regions.', 'type' => 'array', 'items' => ['description' => 'The region information.', '$ref' => '#/components/schemas/RegionInfo', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n oss-cn-hangzhou\\n oss-cn-hangzhou.aliyuncs.com\\n oss-cn-hangzhou-internal.aliyuncs.com\\n oss-accelerate.aliyuncs.com\\n \\n","type":"xml"}]', 'title' => 'Query regions', 'description' => 'The DescribeRegions operation can be called only on a third-level domain name such as oss-cn-hangzhou.aliyuncs.com.', 'extraInfo' => '
'."\n" .'Query the description of all supported regions'."\n" .'Request example.'."\n" ."\n" .'```http'."\n" .'GET /?regions HTTP/1.1'."\n" .'Host: oss-cn-hangzhou.aliyuncs.com'."\n" .'Date: Fri, 20 Aug 2021 06:38:30 GMT'."\n" .'Authorization: SignatureValue'."\n" .'```'."\n" .'Response example'."\n" .'```http'."\n" .'HTTP/1.1 200 OK'."\n" .'x-oss-request-id: 3a8f-2e2d-7965-3ff9-51c875b*****'."\n" .'Date: Fri, 20 Aug 2021 06:38:30 GMT'."\n" .'Content-Type: application/xml'."\n" .'Content-Length: 344606'."\n" .'Server: AliyunOSS'."\n" .'```'."\n" .'```xml'."\n" .''."\n" .''."\n" .' '."\n" .' oss-cn-hangzhou'."\n" .' oss-cn-hangzhou.aliyuncs.com'."\n" .' oss-cn-hangzhou-internal.aliyuncs.com'."\n" .' oss-accelerate.aliyuncs.com '."\n" .' '."\n" .' '."\n" .' oss-cn-shanghai'."\n" .' oss-cn-shanghai.aliyuncs.com'."\n" .' oss-cn-shanghai-internal.aliyuncs.com'."\n" .' oss-accelerate.aliyuncs.com '."\n" .' '."\n" .''."\n" .'```'."\n" .'
'."\n" .'
'."\n" .'Query the description of a specified region'."\n" .'Request example.'."\n" ."\n" .'```http'."\n" .'GET /?regions=oss-cn-hangzhou HTTP/1.1'."\n" .'Host: oss-cn-hangzhou.aliyuncs.com'."\n" .'Date: Fri, 20 Aug 2021 06:40:30 GMT'."\n" .'Authorization: SignatureValue'."\n" .'```'."\n" .'Response example'."\n" .'```http'."\n" .'HTTP/1.1 200 OK'."\n" .'x-oss-request-id: 3a8f-2e2d-7965-3ff9-51c875b*****'."\n" .'Date: Fri, 20 Aug 2021 06:40:30 GMT'."\n" .'Content-Type: application/xml'."\n" .'Content-Length: 3446'."\n" .'Server: AliyunOSS'."\n" .'```'."\n" .'```xml'."\n" .''."\n" .''."\n" .' '."\n" .' oss-cn-hangzhou'."\n" .' oss-cn-hangzhou.aliyuncs.com'."\n" .' oss-cn-hangzhou-internal.aliyuncs.com'."\n" .' oss-accelerate.aliyuncs.com '."\n" .' '."\n" .''."\n" .'```'."\n" .'
.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:DescribeRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DoMetaQuery' => [ 'summary' => 'Queries objects that meet specified conditions by using the metadata index feature of a bucket, and lists object information sorted by specified fields and sort order.', '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' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n"], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The retrieve mode. Valid values:'."\n" .'- basic: scalar retrieve (default).'."\n" .'- semantic: AISearch.', 'type' => 'string', 'required' => false, 'example' => 'semantic'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body that contains the query conditions.', 'type' => 'object', 'properties' => [ 'MetaQuery' => ['title' => '', 'description' => 'The container that stores the query conditions.', '$ref' => '#/components/schemas/MetaQuery', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body that contains the query results.', 'type' => 'object', 'properties' => [ 'MetaQuery' => ['description' => 'The container that stores the query results.', '$ref' => '#/components/schemas/MetaQueryResp', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****\\n \\n \\n exampleobject.txt\\n 120\\n 2021-06-29T15:04:05.000000000Z07:00\\n Normal\\n Standard\\n default\\n \\"fba9dede5f27731c9771645a3986****\\"\\n 4858A48BD1466884\\n AES256\\n SM4\\n 16\\n \\n \\n abc\\n test\\n \\n \\n \\n \\n abc\\n test\\n \\n \\n oss://examplebucket/test-object.jpg\\n 2021-06-29T14:50:13.011643661+08:00\\n image/jpeg\\n image\\n 30.134390,120.074997\\n test\\n 2124-12-01T12:00:00.000Z\\n https://aliyundoc.com\\n PUT\\n SM4\\n 9468da86-3509-4f8d-a61e-6eab1eac****\\n no-cache\\n attachment; filename =test.jpg\\n UTF-8\\n zh-CN\\n 500\\n 270\\n 1080\\n 1920\\n 13091201\\n Jane\\n Jenny\\n Jane\\n Jane\\n FirstAlbum\\n 15.263\\n \\n \\n h264\\n en\\n 5407765\\n 25/1\\n 0\\n 22.88\\n 572\\n 8\\n yuv420p\\n bt709\\n 720\\n 1280\\n \\n \\n \\n \\n aac\\n 320087\\n 48000\\n 0.0235\\n 3.690667\\n 2\\n en\\n \\n \\n \\n \\n mov_text\\n en\\n 0\\n 71.378\\n \\n \\n \\n
\\n 中国浙江省杭州市余杭区文一西路969号\\n 杭州市\\n 余杭区\\n zh-Hans\\n 浙江省\\n 文一西路\\n
\\n
\\n
\\n
\\n \\n \\n Size\\n sum\\n 200\\n \\n \\n 100\\n 5\\n \\n \\n \\n \\n
","type":"xml"}]', 'title' => 'Query objects that meet conditions', 'changeSet' => [ ['createdAt' => '2025-03-31T01:55:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:DoMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'ExtendBucketWorm' => [ 'summary' => 'Extends the retention period for objects in a bucket that has a locked retention policy.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'wormId', 'in' => 'query', 'schema' => ['description' => 'The ID of the retention policy.'."\n" ."\n" .'> If the specified retention policy ID for extending the object retention period does not exist, 404 is returned.', 'type' => 'string', 'required' => true, 'example' => '1666E2CFB2B3418****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The container that stores the retention policy.', 'type' => 'object', 'properties' => [ 'ExtendWormConfiguration' => ['description' => 'The container that stores the retention policy.', '$ref' => '#/components/schemas/ExtendWormConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Extend the retention period for objects in a bucket', 'description' => 'After a time-based retention policy is created, the policy is in the InProgress state by default. This state is valid for 24 hours. Within the 24-hour validity period, the data in the bucket to which the policy applies is in protection status.'."\n" ."\n" .'- Within 24 hours after the retention policy is created: If the policy is not committed, the bucket owner and authorized users can delete the policy. If the retention policy is committed, the policy cannot be deleted, and the protection period cannot be shortened. You can only extend the protection period.'."\n" ."\n" .'- More than 24 hours after the retention policy is created: If the policy is not committed within 24 hours, the policy automatically expires.'."\n" ."\n" .'If files in the bucket are within the protection period, you cannot delete the retention policy or the bucket. When the bucket is empty, the bucket owner can delete the bucket, which indirectly deletes the retention policy of the bucket.'."\n" ."\n\n" .'> If the specified WORM ID for extending the object retention period does not exist, 404 is returned.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:ExtendBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetAccessPoint' => [ 'summary' => 'Retrieves access point information.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => ['description' => 'The access point name.', 'type' => 'string', 'required' => true, 'example' => 'ap-01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'GetAccessPointResult' => ['description' => 'The container that stores the access point information.', '$ref' => '#/components/schemas/GetAccessPointResult', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n 10378****8768\\n \\n vpc-t4nlw426y44rd3iq4****\\n \\n \\n","type":"xml"}]', 'title' => 'Retrieve access point information', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetAccessPointPolicy' => [ 'summary' => 'Retrieves the access point policy configuration.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => ['description' => 'The access point name.', 'type' => 'string', 'required' => true, 'example' => 'ap-01', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The access point policy configuration.', '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" .' } ', 'title' => ''], ], ], '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' => 'Retrieve access point policy configuration', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketAccessMonitor' => [ 'summary' => 'Queries whether access tracking is enabled for 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' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body structure.', 'type' => 'object', 'properties' => [ 'AccessMonitorConfiguration' => ['description' => 'The container that stores the access tracking configuration of the bucket.', '$ref' => '#/components/schemas/AccessMonitorConfiguration', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => 'Query bucket access tracking status', 'changeSet' => [ ['createdAt' => '2025-10-21T08:46:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketAccessMonitor', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketAcl' => [ 'summary' => 'Configures lifecycle rules for a 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessControlPolicy' => [ 'type' => 'object', 'properties' => [ 'Owner' => ['$ref' => '#/components/schemas/Owner', 'description' => '', 'title' => '', 'example' => ''], 'AccessControlList' => [ 'type' => 'object', 'properties' => [ 'Grant' => ['$ref' => '#/components/schemas/BucketACL', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n \\n","type":"xml"}]', 'title' => 'Configure lifecycle rules for a bucket', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'description' => '- Only the bucket owner and Resource Access Management (RAM) users who have been granted the PutBucketLifecycle permission can initiate a request to configure lifecycle rules.'."\n" ."\n" .'- If no lifecycle rules have been configured for the bucket, this operation creates a new lifecycle rule. If lifecycle rules have been configured for the bucket, this operation overwrites the existing rule configurations.'."\n" ."\n" .'- PutBucketLifecycle uses overwrite semantics. To append lifecycle rules, invoke the GetBucketLifecycle operation to obtain the current lifecycle rule configurations, append the new lifecycle rule configurations, and then invoke the PutBucketLifecycle operation to update the lifecycle rule configurations.'."\n" ."\n" .'- The PutBucketLifecycle operation can configure expire times for objects and parts (parts that are uploaded by using multipart upload but are not committed in the final epoch).', 'translator' => 'machine', ], 'GetBucketCors' => [ 'summary' => 'Retrieves the current cross-origin resource sharing (CORS) rules of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CORSConfiguration' => [ 'description' => 'The container that stores the CORS rule configurations.', 'type' => 'object', 'properties' => [ 'CORSRule' => [ 'description' => 'The list of CORS rules.', 'type' => 'array', 'items' => ['description' => 'The container that stores a CORS rule.', '$ref' => '#/components/schemas/CORSRule', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'ResponseVary' => ['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" ."\n" .'false: The Vary: Origin header is not returned in any case.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n *\\n GET\\n Authorization\\n x-oss-test\\n 100\\n \\n true\\n","type":"xml"}]', 'title' => 'Retrieve the current CORS rules of a bucket', 'description' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketEncryption' => [ 'summary' => 'Retrieves the encryption rules of 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the server-side encryption rules.', 'type' => 'object', 'properties' => [ 'ServerSideEncryptionRule' => [ 'description' => 'The container that stores the server-side encryption rules.', 'type' => 'object', 'properties' => [ 'ApplyServerSideEncryptionByDefault' => ['description' => 'The server-side encryption rule information.', '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n AES256\\n 9468da86-3509-4f8d-a61e-6eab1eac****\\n SM4\\n \\n","type":"xml"}]', 'title' => 'Retrieve the encryption rules of a bucket', 'description' => 'Only the bucket owner and authorized Resource Access Management (RAM) users can retrieve the encryption rules of a bucket. Otherwise, a 403 error is returned. For more information about bucket encryption, see **[Server-side encryption](~~31871~~)**.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketEventNotification' => [ 'summary' => 'Retrieves the event notification configuration of 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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NotificationConfiguration' => ['title' => '', 'description' => 'The Function Compute service configuration of the bucket.', '$ref' => '#/components/schemas/EventNotificationConfiguration', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n 1\\n ObjectCreated:PutObject\\n \\n \\n prod\\n .jpb\\n \\n \\n \\n acs:fc:oss-ap-southeast-1:1993989758795198:services/qianwang-fc-test.LATEST/functions/fc-test\\n acs:ram::1993989758795198:role/AliyunOSSObjectFcForOSSDefaultRole\\n \\n \\n","type":"xml"}]', 'title' => 'Get bucket event notification configuration', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:40.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketEventNotification', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketHttpsConfig' => [ 'summary' => 'Calls the GetBucketHttpsConfig operation to query the TLS version settings 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' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response that contains the HTTPS configuration.', 'type' => 'object', 'properties' => [ 'HttpsConfiguration' => ['description' => 'The container that stores the HTTPS configuration.', '$ref' => '#/components/schemas/HttpsConfiguration', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n true\\n TLSv1.2\\n \\n","type":"xml"}]', 'title' => 'Query the HTTPS configuration of a bucket', 'description' => '- To query the TLS version settings of a bucket, you must have the oss:GetBucketHttpsConfig permission. For more information, see [Grant custom access policies to a RAM user through authorization](https://www.alibabacloud.com/help/en/oss/user-guide/common-examples-of-ram-policies#section-ucu-jv0-zip).'."\n" ."\n" .'- Each region has a corresponding endpoint. For more information about the mappings between regions and endpoints, see [Regions and endpoints](https://www.alibabacloud.com/help/en/oss/user-guide/regions-and-endpoints).', 'changeSet' => [ ['createdAt' => '2024-02-21T14:34:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketHttpsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketInfo' => [ 'summary' => 'Queries information about a bucket. Only the bucket owner can query the bucket information. This request can be initiated from any 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body of the GetBucketInfo operation.', 'type' => 'object', 'properties' => [ 'BucketInfo' => ['description' => 'The container that stores the bucket information.', '$ref' => '#/components/schemas/BucketInfo', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n Disabled\\n 2022-01-06T08:20:09.000Z\\n Disabled\\n oss-cn-hangzhou\\n test-bucket\\n Disabled\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n \\n \\n KMS\\n \\t\\n9468da86-3509-4f8d-a61e-6eab1eac****\\n SM4\\n \\n \\n example-bucket\\n log/\\n \\n \\n","type":"xml"}]', 'title' => 'Query bucket information', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketInventory' => [ 'summary' => 'Queries a specified inventory task in 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the inventory rule to query.', 'type' => 'string', 'required' => true, 'example' => 'list1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The inventory task configured for a bucket', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => ['description' => 'The inventory task information of the bucket.', '$ref' => '#/components/schemas/InventoryConfiguration', 'title' => '', 'example' => ''], ], 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n report1\\n true\\n \\n \\n 100000000000000\\n acs:ram::100000000000000:role/AliyunOSSRole\\n acs:oss:::bucket_0001\\n prefix1/\\n \\n \\n 9468da86-3509-4f8d-a61e-6eab1eac****\\n \\n \\n \\n \\n \\n \\n Pics/\\n 1637883649\\n 1638347592\\n 1024\\n 1048576\\n All\\n \\n All\\n \\n \\n true\\n \\n 600\\n \\n \\n Etag\\n \\n \\n","type":"xml"}]', 'title' => 'Query an inventory task of a bucket', 'description' => 'Before calling this operation, make sure that you have sufficient permissions to perform operations on the inventory task of the bucket. The bucket owner has this permission by default. If you do not have this permission, request the permission from the bucket owner.', 'changeSet' => [ ['createdAt' => '2024-03-05T07:08:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketLifecycle' => [ 'summary' => 'Queries the lifecycle rules of a bucket. Only the bucket owner has the permission to query the lifecycle rules of a 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' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'LifecycleConfiguration' => ['title' => '', 'description' => 'The container that stores the lifecycle rules of the bucket.', '$ref' => '#/components/schemas/LifecycleConfiguration', 'example' => ''], ], 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n rule1\\n tmp/\\n Enabled\\n \\n 2002-10-11T00:00:00.000Z\\n 1\\n true\\n \\n \\n 2002-10-11T00:00:00.000Z\\n 1\\n true\\n true\\n true\\n \\n \\n 1\\n 2002-10-11T00:00:00.000Z\\n \\n \\n testb\\n testv2\\n \\n \\n 5\\n \\n \\n 5\\n true\\n true\\n true\\n \\n \\n \\n logs/keep/\\n \\n testb\\n testv2\\n \\n \\n 10240\\n 10240\\n \\n 1626158525\\n \\n","type":"xml"}]', 'title' => 'Query lifecycle rules of a bucket', 'changeSet' => [ ['createdAt' => '2024-11-28T09:35:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketLocation' => [ 'summary' => 'Queries the location information of a bucket. Only the bucket owner can query the location information of a bucket.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The container that stores the bucket location information.', 'type' => 'object', 'properties' => [ 'LocationConstraint' => ['description' => 'The region in which the bucket is located.
'."\n" .'Valid values: oss-cn-hangzhou, oss-cn-shanghai, oss-cn-qingdao, oss-cn-beijing, oss-cn-zhangjiakouoss-cn-hongkong, oss-cn-shenzhen, oss-us-west-1, oss-us-east-1, oss-ap-southeast-1, and others.'."\n" ."\n" .'
For more information about the mappings between regions and data centers, see [Endpoints and data centers](~~31837~~).', 'type' => 'string', 'example' => 'oss-cn-hangzhou', 'title' => ''], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\noss-cn-hangzhou","type":"xml"}]', 'title' => 'Query the location information of a bucket', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLocation', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketLogging' => [ 'summary' => 'Queries the access logging configuration of a bucket. Only the bucket owner can query the access logging configuration 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BucketLoggingStatus' => ['title' => '', 'description' => 'The container for the access logging status information.', '$ref' => '#/components/schemas/BucketLoggingStatus', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n examplebucket\\n MyLog-\\n AliyunOSSLoggingDefaultRole\\n \\n","type":"xml"}]', 'title' => 'Query the access logging configuration of a bucket', 'changeSet' => [ ['createdAt' => '2025-10-21T02:39:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketObjectWormConfiguration' => [ 'path' => '/?objectWorm', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREoss2NCTTF'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'ObjectWormConfiguration' => ['title' => '', 'description' => 'The container that stores the object-level data retention policy.', '$ref' => '#/components/schemas/ObjectWormConfiguration', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query bucket object data retention policy configuration', 'summary' => 'Retrieves the object-level data retention policy configured on a bucket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Enabled\\n \\n \\n COMPLIANCE\\n 1\\n 1\\n \\n \\n","type":"xml"}]', 'translator' => 'machine', ], 'GetBucketPolicy' => [ 'summary' => 'Retrieves the access policy of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The object content in byte stream format.', 'type' => 'string', 'example' => '-', 'title' => ''], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\"-\\"","type":"json"}]', 'title' => 'Get bucket access policy', 'description' => '- Authorization to Resource Access Management (RAM) users of other accounts.'."\n" ."\n" .'You can grant RAM users of other accounts permissions to access your OSS resources.'."\n" ."\n" .'- Grant users with anonymity access permissions with specific IP conditions.'."\n" ."\n" .'In some scenarios, you need to grant users with anonymity access policies with IP restrictions. For example, ciphertext documents within an enterprise are allowed to be accessed only from within the enterprise network and not from other areas. Because the enterprise has a large number of internal users, configuring a RAM access policy for each user requires significant effort. In this case, you can configure IP address-restricted access policies in bucket policy settings to perform authorization efficiently.'."\n" ."\n" .'For details about bucket policy configurations and scenario examples, see [Use bucket policies to authorize other users to access OSS resources](~~85111~~). For more information about the access policy syntax, see [Access policy syntax and structure](~~93739~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketReferer' => [ 'summary' => 'Queries the hotlink protection (Referer) configurations of 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The container that stores the Referer configurations.', 'type' => 'object', 'properties' => [ 'RefererConfiguration' => ['$ref' => '#/components/schemas/RefererConfiguration', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n true\\n true\\n \\n http://www.aliyun.com\\n \\n \\n https://www.abc.com\\n \\n","type":"xml"}]', 'title' => 'Query hotlink protection configurations of a bucket', 'changeSet' => [ ['createdAt' => '2024-02-20T08:53:36.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReferer', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketReplication' => [ 'summary' => 'Retrieves 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ReplicationConfiguration' => [ 'description' => 'The list of replication rules.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'description' => 'The container that stores replication rules.', 'type' => 'array', 'items' => ['description' => 'The replication rule information.', '$ref' => '#/components/schemas/ReplicationRule', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n test_replication_1\\n \\n video\\n \\n PUT\\n \\n target-bucket\\n oss-cn-beijing\\n oss_acc\\n \\n starting\\n enabled\\n aliyunramrole\\n \\n \\n Enabled\\n \\n \\n \\n c4d49f85-ee30-426b-a5ed-95e9139dxxxxx\\n \\n \\n Enabled\\n \\n \\n","type":"xml"}]', 'title' => 'Set data replication rules for a bucket', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketReplicationLocation' => [ 'summary' => 'Retrieves the regions to which the data in a source bucket can be replicated. You can use the response to determine the destination region for data replication.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body for the request to retrieve replicable regions.', 'type' => 'object', 'properties' => [ 'ReplicationLocation' => [ 'description' => 'The container that stores the information about replicable regions.', 'type' => 'object', 'properties' => [ 'Location' => [ 'description' => 'The list of regions in which the destination bucket can reside.'."\n" ."\n" .'> If multiple destination regions are available, the response contains multiple Location elements. If no destination region is available, the returned Location is empty.', 'type' => 'array', 'items' => ['description' => 'The region in which the destination bucket can reside, such as oss-cn-beijing.', 'type' => 'string', 'example' => 'oss-cn-beijing', 'title' => ''], 'title' => '', 'example' => '', ], 'LocationTransferTypeConstraint' => [ 'description' => 'The container that stores the Location information with TransferType constraints.', 'type' => 'object', 'properties' => [ 'LocationTransferType' => [ 'description' => 'The container that stores the Location information that includes TransferType.', 'type' => 'array', 'items' => ['description' => 'The Location information that includes TransferType.', '$ref' => '#/components/schemas/LocationTransferType', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'LocationRTCConstraint' => [ 'description' => 'The container that stores the Location information with replication time control (RTC) constraints.', 'type' => 'object', 'properties' => [ 'Location' => [ 'description' => 'The list of Location information that supports RTC.', 'type' => 'array', 'items' => ['description' => 'The Location information that supports RTC.', 'type' => 'string', 'example' => 'oss-cn-beijing', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n oss-cn-beijing\\n \\n \\n oss-cn-beijing\\n \\n oss_acc\\n \\n \\n \\n \\n oss-cn-beijing\\n \\n","type":"xml"}]', 'title' => 'Query regions available for replication', 'changeSet' => [ ['createdAt' => '2024-03-05T07:08:19.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplicationLocation', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketReplicationProgress' => [ 'summary' => 'Retrieves the data replication progress 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'rule-id', 'in' => 'query', 'schema' => ['description' => 'The ID of the replication rule. You can obtain this ID from the GetBucketReplication operation.', 'type' => 'string', 'required' => true, 'example' => 'test_replication_1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the progress entry for each replication rule.', 'type' => 'object', 'properties' => [ 'ReplicationProgress' => [ 'description' => 'The list that contains the progress entry for each replication rule.', 'type' => 'object', 'properties' => [ 'Rule' => [ 'description' => 'The container that stores the replication rule progress information.', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/ReplicationProgressRule', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n rep01\\n \\n video\\n \\n PUT\\n \\n target-bucket\\n oss-cn-beijing\\n oss_acc\\n \\n doing\\n enabled\\n \\n 0.86\\n Thu, 24 Sep 2015 15:39:18 GMT\\n \\n \\n","type":"xml"}]', 'title' => 'Retrieve data replication progress of a bucket', 'changeSet' => [ ['createdAt' => '2024-03-05T07:08:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplicationProgress', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketRequestPayment' => [ 'summary' => 'Retrieves the pay-by-requester configuration of 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body for retrieving the pay by requester configuration.', 'type' => 'object', 'properties' => [ 'RequestPaymentConfiguration' => [ 'description' => 'The container for the pay by requester configuration.', 'type' => 'object', 'properties' => [ 'Payer' => [ 'description' => 'The payer of the bucket.'."\n" ."\n" .'Valid values:'."\n" .'- BucketOwner: The bucket owner pays.'."\n" .'- Requester: The requester pays.', 'enumValueTitles' => ['Requester' => 'Pay by requester.', 'BucketOwner' => 'Pay by bucket owner.'], 'type' => 'string', 'example' => 'Requester', 'title' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Requester\\n","type":"xml"}]', 'title' => 'Retrieve pay-by-requester configuration', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketRequestPayment', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketResourceGroup' => [ 'summary' => 'Retrieves the resource group ID of a bucket.', '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' => '', 'description' => 'The target bucket to query.', 'type' => 'string', 'required' => true, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body for retrieving the resource group ID.', 'type' => 'object', 'properties' => [ 'BucketResourceGroupConfiguration' => [ 'description' => 'The container for the resource group ID.', 'type' => 'object', 'properties' => [ 'ResourceGroupId' => ['title' => '', 'description' => 'The resource group ID of the bucket.', 'type' => 'string', 'example' => 'rg-asdfklj***'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n rg-asdfklj***\\n","type":"xml"}]', 'title' => 'Retrieve bucket resource group ID', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketStat' => [ 'summary' => 'Retrieves the storage capacity and the number of objects in a specified 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 name of the bucket to query.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body of the GetBucketStat operation.', 'type' => 'object', 'properties' => [ 'BucketStat' => ['description' => 'The container for the BucketStat structure.', '$ref' => '#/components/schemas/BucketStat', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 1600\\n 230\\n 40\\n 1250\\n 5990\\n 12323\\n 2034903\\n 39182324\\n 30423\\n 1643341269\\n 223\\n 12\\n 2312\\n 23\\n 342\\n 65754\\n","type":"xml"}]', 'title' => 'Retrieve bucket storage capacity and object count', 'description' => '- You must have the oss:GetBucketStat permission to call this operation.'."\n" .'- The data returned by this operation is not real-time. The latency can exceed one hour.'."\n" .'- The point in time of the storage information returned by this operation is not guaranteed to be the latest. The LastModifiedTime value returned by a subsequent call may be earlier than the LastModifiedTime value returned by a previous call.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketStat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketTags' => [ 'summary' => 'Retrieves 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => 'The container that stores the bucket tagging result.', 'type' => 'object', 'properties' => [ 'TagSet' => ['description' => 'The container that stores the tag set.', '$ref' => '#/components/schemas/TagSet', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n testb\\n testv2\\n \\n \\n","type":"xml"}]', 'title' => 'Retrieve bucket tags', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketTransferAcceleration' => [ 'summary' => 'Calls the GetBucketTransferAcceleration operation to query the transfer acceleration configuration 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TransferAccelerationConfiguration' => [ 'description' => 'The container that stores the transfer acceleration configuration.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Indicates whether transfer acceleration is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => 'Query the transfer acceleration configuration of a bucket', 'description' => '- Only the bucket owner and Resource Access Management (RAM) users who have been granted the oss:GetBucketTransferAcceleration permission can initiate a request to query the transfer acceleration configuration.'."\n" ."\n" .'- If transfer acceleration has not been configured for the bucket, the acceleration configuration status is not returned when you invoke this operation.'."\n" ."\n" .'For more information about transfer acceleration, see [Transfer acceleration](~~131312~~) in the developer guide.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketTransferAcceleration', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketVersioning' => [ 'summary' => 'Calls the GetBucketVersioning operation to retrieve the versioning status of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'VersioningConfiguration' => [ 'description' => 'The container that stores the versioning status.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The versioning status.', '$ref' => '#/components/schemas/BucketVersioningStatus', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Get the versioning status of a specified bucket', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketVersioning', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketWebsite' => [ 'summary' => 'Queries the static website hosting status and redirection rules of 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'WebsiteConfiguration' => ['description' => 'The container that stores the static website configuration.', '$ref' => '#/components/schemas/WebsiteConfiguration', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n index.html\\n false\\n 0\\n \\n \\n error.html\\n 404\\n \\n \\n \\n 1\\n \\n abc\\n .txt\\n 404\\n \\n test-header\\n test-value\\n \\n \\n \\n Mirror\\n true\\n http://example.com\\n true\\n false\\n true\\n false\\n \\n false\\n myheader-key1\\n myheader-key3\\n \\n myheader-key5\\n myheader-value5\\n \\n \\n http\\n example.com\\n def/\\n false\\n prefix/${key}.suffix\\n 301\\n false\\n \\n \\n \\n","type":"xml"}]', 'title' => 'Query static website hosting status and rules of a bucket', 'changeSet' => [ ['createdAt' => '2024-03-06T01:47:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetBucketWorm' => [ 'summary' => 'Queries the data retention policy information of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'WormConfiguration' => [ 'description' => 'The container that stores the data retention policy of the bucket.', 'type' => 'object', 'properties' => [ 'WormId' => ['description' => 'The ID of the data retention policy.', 'type' => 'string', 'example' => '1666E2CFB2B3418****', 'title' => ''], 'State' => ['description' => 'The state of data retention policy. Valid values:'."\n" ."\n" .'InProgress: After a retention policy is created, the policy is in the InProgress state by default. This state is valid for 24 hours.'."\n" ."\n" .'Locked: Data retention policy is locked.', '$ref' => '#/components/schemas/BucketWormState', 'title' => '', 'example' => ''], 'RetentionPeriodInDays' => ['description' => 'The specified retention period of the object, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'CreationDate' => ['description' => 'The time when the data retention policy was created.', 'type' => 'string', 'example' => '2020-10-15T15:50:32', 'title' => ''], 'ExpirationDate' => ['description' => 'The time when the data retention policy expires.', 'type' => 'string', 'example' => '2020-10-20T15:50:32'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 1666E2CFB2B3418****\\n 20\\n 2020-10-15T15:50:32\\n 2020-10-20T15:50:32\\n\\n","type":"xml"}]', 'title' => 'Query the data retention policy information of a bucket', 'description' => 'Object Storage Service (OSS) supports the Write Once Read Many (WORM) feature, which allows you to store and use data in a non-deletable and non-modifiable manner. OSS allows you to configure a time-based retention policy for a bucket. The protection period ranges from 1 day to 70 years.
'."\n" .'After a retention policy is locked, you can upload and read objects in the bucket. However, you cannot delete objects or data retention policy before the retention period of the objects expires. You can delete objects only after their retention period expires.'."\n" ."\n\n" .'> If the WORM ID specified for querying data retention policy of the bucket does not exist, 404 is returned.', 'changeSet' => [ ['createdAt' => '2024-03-05T07:08:19.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetCnameToken' => [ 'summary' => 'Obtains the created CnameToken.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'cname', 'in' => 'query', 'schema' => ['description' => 'The bound CNAME.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the CnameToken.', 'type' => 'object', 'properties' => [ 'CnameToken' => ['description' => 'The container that stores the CnameToken.', '$ref' => '#/components/schemas/CnameToken', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n examplebucket\\n example.com\\n be1d49d863dea9ffeff3df7d6455****\\n Wed, 23 Feb 2022 21:16:37 GMT\\n","type":"xml"}]', 'title' => 'GetCnameToken', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetCnameToken', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetLiveChannelHistory' => [ 'summary' => 'Retrieves the streaming records of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The LiveChannel name.', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the results of the GetLiveChannelHistory operation.', 'type' => 'object', 'properties' => [ 'LiveChannelHistory' => [ 'description' => 'The container that stores the results of the GetLiveChannelHistory operation.', 'type' => 'object', 'properties' => [ 'LiveRecord' => [ 'description' => 'The list of streaming records.', 'type' => 'array', 'items' => ['description' => 'The container that stores information about a streaming record.', '$ref' => '#/components/schemas/LiveRecord', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n 2016-07-30T01:53:21.000Z\\n 2016-07-30T01:53:31.000Z\\n 10.101.194.148:57632\\n \\n","type":"xml"}]', 'title' => 'Retrieve live streaming records', 'description' => 'The GetLiveChannelHistory operation returns up to 10 most recent streaming records of a specified LiveChannel.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannelHistory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'GetLiveChannelInfo' => [ 'summary' => 'Retrieves the configuration information of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'exsmplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The channel name. The name cannot contain forward slashes (/).', 'type' => 'string', 'required' => true, 'example' => 'channel_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the result of the GetLiveChannelInfo operation.', 'type' => 'object', 'properties' => [ 'LiveChannelConfiguration' => [ 'description' => 'The container that stores the result of the GetLiveChannelInfo operation.', 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description of the LiveChannel.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Status' => ['description' => 'The status of the LiveChannel. Valid values:'."\n" ."\n" .'enabled: The LiveChannel is enabled.'."\n" ."\n" .'disabled: The LiveChannel is disabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''], 'Target' => ['description' => 'The container that stores the storage configuration of the LiveChannel.', '$ref' => '#/components/schemas/LiveChannelTarget', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n test\\n enabled\\n \\n HLS\\n 5\\n 3\\n playlist.m3u8\\n \\n","type":"xml"}]', 'title' => 'Get live streaming configuration information', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'GetLiveChannelStat' => [ 'summary' => 'Queries the streaming status of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The LiveChannel name.', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the result of the GetLiveChannelStat operation.', 'type' => 'object', 'properties' => [ 'LiveChannelStat' => [ 'description' => 'The container that stores the result of the GetLiveChannelStat operation.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The current streaming status of the LiveChannel. Valid values: Disabled, Live, Idle.', 'type' => 'string', 'example' => 'Live', 'title' => ''], 'ConnectedTime' => ['description' => 'The time when the current client started streaming. This element is in ISO 8601 format. This element is returned only when Status is Live.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2016-08-25T06:25:15.000Z', 'title' => ''], 'RemoteAddr' => ['description' => 'The IP address of the current streaming client. This element is returned only when Status is Live.', 'type' => 'string', 'example' => '10.1.2.3:47745', 'title' => ''], 'Video' => ['description' => 'The container that stores video stream information. This container is returned only when Status is Live.'."\n" ."\n" .'>The Video and Audio containers are returned only when Status is Live. However, these two containers are not always returned when Status is Live. For example, if the client has connected to the LiveChannel but has not sent audio or video data, these two containers are not returned.', '$ref' => '#/components/schemas/LiveChannelVideo', 'title' => '', 'example' => ''], 'Audio' => ['description' => 'The container that stores audio stream information. This container is returned only when Status is Live.'."\n" ."\n" .'>The Video and Audio containers are returned only when Status is Live. However, these two containers are not always returned when Status is Live. For example, if the client has connected to the LiveChannel but has not sent audio or video data, these two containers are not returned.', '$ref' => '#/components/schemas/LiveChannelAudio', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Live\\n 2016-08-25T06:25:15.000Z\\n 10.1.2.3:47745\\n \\n \\n","type":"xml"}]', 'title' => 'Query the streaming status of a liveChannel', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannelStat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'GetMetaQueryStatus' => [ 'summary' => 'Retrieves the metadata index information of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response for retrieving metadata index information.', 'type' => 'object', 'properties' => [ 'MetaQueryStatus' => [ 'description' => 'The container that stores the metadata index information.', 'type' => 'object', 'properties' => [ 'State' => ['description' => 'The status of the metadata index. Valid values:'."\n" ."\n" .'Ready: being prepared after creation'."\n" ."\n" .'The metadata index is being prepared. You cannot query data by using the metadata index.'."\n" ."\n" .'Stop: paused'."\n" ."\n" .'Running: running'."\n" ."\n" .'Retrying: retrying after a creation failure'."\n" ."\n" .'Failed: creation failed'."\n" ."\n" .'Deleted: deleted.', 'type' => 'string', 'example' => 'Runing', 'title' => ''], 'Phase' => ['description' => 'The current scan type. Valid values:'."\n" ."\n" .'FullScanning: full scanning in progress'."\n" ."\n" .'IncrementalScanning: incremental scanning in progress.', 'type' => 'string', 'example' => 'FullScanning', 'title' => ''], 'CreateTime' => ['description' => 'The time when the metadata index was created. The time follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the date. 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', 'title' => ''], 'UpdateTime' => ['description' => 'The time when the metadata index was created. The time follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ss+TIMEZONE format. YYYY-MM-DD indicates the date. 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', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Runing\\n FullScanning\\n 2021-08-02T10:49:17.289372919+08:00\\n 2021-08-02T10:49:17.289372919+08:00\\n","type":"xml"}]', 'title' => 'Get metadata index information', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetMetaQueryStatus', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetObject' => [ 'summary' => 'Retrieves 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'], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'response-content-type', 'in' => 'query', 'schema' => ['description' => 'Specifies the content-type header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => 'image/jpg', 'title' => ''], ], [ 'name' => 'response-content-language', 'in' => 'query', 'schema' => ['description' => 'Specifies the content-language header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => '中文', 'title' => ''], ], [ 'name' => 'response-expires', 'in' => 'query', 'schema' => ['description' => 'Specifies the expires header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 24 Feb 2012 17:00:00 GMT', 'title' => ''], ], [ 'name' => 'response-cache-control', 'in' => 'query', 'schema' => ['description' => 'Specifies the cache-control header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => 'no-cache', 'title' => ''], ], [ 'name' => 'response-content-disposition', 'in' => 'query', 'schema' => ['description' => 'Specifies the content-disposition header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => 'attachment; filename:testing.txt', 'title' => ''], ], [ 'name' => 'response-content-encoding', 'in' => 'query', 'schema' => ['description' => 'Specifies the content-encoding header that OSS returns in the response.', 'type' => 'string', 'required' => false, 'example' => 'utf-8', 'title' => ''], ], [ 'name' => 'Range', 'in' => 'header', 'schema' => ['description' => 'The range of the file transfer.'."\n" .' - If the specified range is valid, the response includes the total size of the object and the range returned. Example: Content-Range: bytes 0~9/44, which indicates that the total size of the object is 44 bytes and the returned range is bytes 0 through 9.'."\n" .' - If the specified range is invalid, the entire file is transferred and the response does not include Content-Range.'."\n" ."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Content-Range: bytes 100-900/344606', 'title' => ''], ], [ 'name' => 'If-Modified-Since', 'in' => 'header', 'schema' => ['description' => 'If the specified time is earlier than the actual modification time or does not conform to the standard format, the object is returned with an HTTP 200 OK status code. If the specified time is equal to or later than the actual modification time, an HTTP 304 Not Modified status code is returned.'."\n" .'Time format: GMT. Example: `Fri, 13 Nov 2015 14:47:53 GMT`.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', 'title' => ''], ], [ 'name' => 'If-Unmodified-Since', 'in' => 'header', 'schema' => ['description' => 'If the specified time is equal to or later than the actual modification time of the object, the object is transferred and an HTTP 200 OK status code is returned. If the specified time is earlier than the actual modification time, an HTTP 412 Precondition Failed status code is returned.'."\n" .'Time format: GMT. Example: `Fri, 13 Nov 2015 14:47:53 GMT`.'."\n" .'You can specify both **If-Modified-Since** and **If-Unmodified-Since** in the same request.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', 'title' => ''], ], [ 'name' => 'If-Match', 'in' => 'header', 'schema' => ['description' => 'If the specified ETag matches the ETag of the object, the object is transferred and an HTTP 200 OK status code is returned. If the specified ETag does not match the ETag of the object, an HTTP 412 Precondition Failed status code is returned.'."\n" .'The ETag of an object is used to check whether the data has changed. You can use the ETag to verify data integrity.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'fba9dede5f27731c9771645a3986****', 'title' => ''], ], [ 'name' => 'If-None-Match', 'in' => 'header', 'schema' => ['description' => 'If the specified ETag does not match the ETag of the object, the object is transferred and an HTTP 200 OK status code is returned. If the specified ETag matches the ETag of the object, an HTTP 304 Not Modified status code is returned.'."\n" .'You can specify both **If-Match** and **If-None-Match** in the same request.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E0563E1B002CC607C****', 'title' => ''], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => ['description' => 'The encoding type of the client.'."\n" .'To use Gzip compression for the response content, you must explicitly include Accept-Encoding:gzip in the request header. OSS determines whether to return Gzip-compressed data based on the Content-Type and size of the object (at least 1 KB).'."\n" .'> - If Gzip compression is used, the ETag is not included in the response.'."\n" .'> - OSS supports Gzip compression for the following Content-Type values: 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', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object.', 'type' => 'string', 'required' => false, 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', 'title' => ''], ], ], '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 associated with the object. This parameter is returned only if you have the read tag permission.', 'type' => 'string', 'format' => 'binary', 'example' => '10', 'title' => ''], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\"10\\"","type":"json"}]', 'title' => 'Get an object', 'description' => '**Before you begin**'."\n" ."\n" .'- The GetObject operation can be accessed over HTTP and HTTPS by default. To set access to HTTPS only, use a bucket policy for authorization. For more information, see [Use bucket policies to authorize users to access specified resources](~~85111~~).'."\n" ."\n" .'- If the object is of the Archive storage class, you must first complete a RestoreObject request to restore the file, and the request must not timeout.'."\n" ."\n" .'**Versioning**'."\n" ."\n" .'By default, invoking the GetObject operation returns only the current version of an object.'."\n" .'If you specify the versionId of the object in the query parameters, the specified object version is returned. If versionId is set to null, the object version whose versionId is null is returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:ProcessImm'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:RestoreObjectVersion'], ['action' => 'oss:GetObjectVersionTagging'], ], ], ], 'translator' => 'machine', ], 'GetObjectAcl' => [ 'summary' => 'Queries the access permissions (ACL) of a file (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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The version of the object.', 'type' => 'string', 'required' => false, 'example' => 'list1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the ACL information.', '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', 'title' => '', 'example' => ''], 'AccessControlList' => [ 'description' => 'The container that stores the ACL information.', 'type' => 'object', 'properties' => [ 'Grant' => ['description' => 'The ACL of the object.', '$ref' => '#/components/schemas/ObjectACL', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n \\n","type":"xml"}]', 'title' => 'Get the access permissions of a file', 'description' => '**Versioning**'."\n" ."\n" .'When you invoke the GetObjectACL operation, only the ACL of the current version of the object is returned by default. You can specify the versionId parameter to query the ACL of a specific object version. If the specified version is a delete marker, OSS returns 404 Not Found.'."\n" ."\n" .'>If an ACL has never been configured in Settings for an object, the ObjectACL returned by invoking GetObjectACL is default, which indicates that the ACL of the object follows the bucket ACL. For example, if the access permissions of the bucket is private, the access permissions of the object is also private.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObjectAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectVersionAcl'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'GetObjectLegalHold' => [ 'summary' => 'Retrieves the legal hold status of an object.', 'path' => '/{key}?legalHold', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREoss2NCTTF'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the object.', 'type' => 'string', 'required' => true, 'example' => 'test.txt'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'LegalHold' => ['title' => '', 'description' => 'The container that stores the legal hold configuration of the object.', '$ref' => '#/components/schemas/LegalHold', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Get the legal hold status of an object', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n ON\\n","type":"xml"}]', 'translator' => 'machine', ], 'GetObjectMeta' => [ 'summary' => 'Retrieves the metadata of an object, including the ETag, Size, and LastModified information, without returning the object content.', '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', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object. This field is returned only when you query the metadata of a specific object version.', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgIDMh4mD0BYiIDUzNDA4OGNmZjBjYTQ0YmI4Y2I4ZmVlYzJlNGVk****', 'title' => ''], ], ], '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":"\\n","type":"xml"}]', 'title' => 'Retrieve object metadata', 'description' => '**Before you begin**'."\n" .'- Object metadata includes the ETag, Size, and LastModified information of the object. The object content is not returned. If the object is a symbolic link, the metadata of the symbolic link itself is returned.'."\n" .'- If versioning is not enabled for the bucket, you must have the oss:GetObject permission to retrieve the metadata of a file. If versioning is enabled for the bucket and you want to retrieve the metadata of a specific file version (by including the x-oss-version-id request header), you must have the oss:GetObjectVersion permission. For more information, see [Grant a Resource Access Management (RAM) user authorization with a custom RAM policy](~~199058~~).'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'By default, the GetObjectMeta operation retrieves the metadata of the current version of the object. If the current version is a delete marker, 404 Not Found is returned. If you specify the versionId in the request parameters, the metadata of the specified object version is returned.', 'changeSet' => [ ['createdAt' => '2024-10-10T07:15:12.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ], ], ], 'translator' => 'machine', ], 'GetObjectRetention' => [ 'summary' => 'Configures an object-level data retention policy on an object.', 'path' => '/{key}?retention', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREoss2NCTTF'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the object.', 'type' => 'string', 'required' => true, 'example' => 'test.txt'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Retention' => ['title' => '', 'description' => 'The container that stores the object data retention policy.', '$ref' => '#/components/schemas/Retention', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query the data retention policy of an object', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n COMPLIANCE\\n 2026-10-11T00:00:00.000Z\\n","type":"xml"}]', 'translator' => 'machine', ], 'GetObjectTagging' => [ 'summary' => 'Retrieves the tagging information 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the target object.', 'type' => 'string', 'required' => false, 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the tag set.', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => 'The container that stores the tag set.', 'type' => 'object', 'properties' => [ 'TagSet' => ['description' => 'The tag set.', '$ref' => '#/components/schemas/TagSet', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n testb\\n testv2\\n \\n \\n","type":"xml"}]', 'title' => 'Get object tagging information', 'description' => '**Versioning**'."\n" ."\n" .'When you call the GetObjectTagging operation, only the tagging information of the current version of the object is returned by default. You can specify the versionId parameter to retrieve the tagging information of a specific object version. If the specified version is a delete marker, OSS returns 404 Not Found.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:31.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectVersionTagging'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'GetPublicAccessBlock' => [ 'summary' => 'Obtains the block public access configuration at the user level.', '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' => 'The response body.', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => ['description' => 'The container that stores the block public access configuration.', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => 'Get user-level block public access configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetPublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetStyle' => [ 'summary' => 'Queries the information about a specified image style in 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => ['description' => 'The image style name.', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body that contains the retrieved image style information.', 'type' => 'object', 'properties' => [ 'Style' => ['description' => 'The container that stores the retrieved style information.', '$ref' => '#/components/schemas/StyleInfo', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Get an image style', 'changeSet' => [ ['createdAt' => '2024-04-23T06:42:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T07:26:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'GetSymlink' => [ 'summary' => 'Retrieves the symbolic link of a specified target object (TargetObject) in OSS.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object for which you want to retrieve the symbolic link.', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-symlink-target' => [ 'schema' => ['sdkPropertyName' => 'symlinkTargetKey', 'type' => 'string'], ], 'x-oss-version-id' => [ 'schema' => ['type' => 'string'], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Get symbolic link', 'description' => '**Versioning**'."\n" ."\n" .'The GetSymlink operation retrieves the current version of a symbolic link by default. You can retrieve a specific version by specifying versionId. If the current version of the symbolic link is a delete marker, OSS returns 404 Not Found and includes x-oss-delete-marker = true and the version ID x-oss-version-id in the response header. A delete marker has no associated data, so there is no TargetObject that the symbolic link points to.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectVersionTagging'], ], ], ], 'translator' => 'machine', ], 'GetUserAntiDDosInfo' => [ 'summary' => 'Queries the information about OSS DDoS protection instances under a specified 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' => '', 'description' => 'The response body that contains the list of Anti-DDoS instance information.', 'type' => 'object', 'properties' => [ 'AntiDDOSListConfiguration' => [ 'description' => 'The container that stores the list of Anti-DDoS instance information.', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => [ 'description' => 'The container that stores the Anti-DDoS instance information.', 'type' => 'array', 'items' => ['description' => 'The Anti-DDoS instance information.', '$ref' => '#/components/schemas/UserAntiDDOSInfo', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n cbcac8d2-4f75-4d6d-9f2e-c3447f73****\\n 114893010724****\\n 1626769503\\n 1626769840\\n 1626769845\\n Defending\\n \\n","type":"xml"}]', 'title' => 'Query OSS DDoS protection instance information', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetVodPlaylist' => [ 'summary' => 'Queries the playlist generated by stream pushing for a specified LiveChannel within a 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The name of the LiveChannel. The LiveChannel must exist.', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['description' => 'The end time for querying TS files. The value is a UNIX timestamp.'."\n" .'> EndTime must be greater than StartTime, and the time span cannot exceed one day.', 'type' => 'string', 'required' => true, 'example' => '1636618271', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['description' => 'The start time for querying TS files. The value is a UNIX timestamp.', 'type' => 'string', 'required' => true, 'example' => '1636600271', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The playlist generated by stream pushing.', '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', 'title' => ''], ], '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 of a live stream', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetVodPlaylist', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'HeadObject' => [ 'summary' => 'Retrieves 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object.', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgMCZov2D0BYiIDY4MDllOTc2YmY5MjQxMzdiOGI3OTlhNTU0ODIx****', 'title' => ''], ], [ 'name' => 'If-Modified-Since', 'in' => 'header', 'schema' => ['description' => 'If the time specified in this parameter is earlier than the actual modification time of the object, 200 OK and the object metadata are returned. Otherwise, 304 Not Modified is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 9 Apr 2021 14:47:53 GMT', 'title' => ''], ], [ 'name' => 'If-Unmodified-Since', 'in' => 'header', 'schema' => ['description' => 'If the time specified in this parameter is equal to or later than the actual modification time of the object, 200 OK and the object metadata are returned. Otherwise, 412 Precondition Failed is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Oct 2021 14:47:53 GMT', 'title' => ''], ], [ 'name' => 'If-Match', 'in' => 'header', 'schema' => ['description' => 'If the specified ETag matches the ETag of the object, 200 OK and the object metadata are returned. Otherwise, 412 Precondition Failed is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'fba9dede5f27731c9771645a3986****', 'title' => ''], ], [ 'name' => 'If-None-Match', 'in' => 'header', 'schema' => ['description' => 'If the specified ETag does not match the ETag of the object, 200 OK and the object metadata are returned. Otherwise, 304 Not Modified is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E0563E1B002CC607C****', 'title' => ''], ], ], '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":"\\n","type":"xml"}]', 'title' => 'Retrieve object metadata', 'description' => '- This operation does not return the object content.'."\n" ."\n" .'- The HeadObject operation retrieves the metadata of the current version of an object by default. If the current version of the object is a delete marker, 404 Not Found is returned. If you specify versionId in the request parameters, the metadata of the specified object version is returned.', 'changeSet' => [ ['createdAt' => '2024-10-10T07:15:12.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:GetObject'], ['action' => 'oss:GetObjectVersionTagging'], ], ], ], 'translator' => 'machine', ], 'InitBucketAntiDDosInfo' => [ 'summary' => 'Initializes bucket protection.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-defender-instance', 'in' => 'header', 'schema' => ['description' => 'The Anti-DDoS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', 'title' => ''], ], [ 'name' => 'x-oss-defender-type', 'in' => 'header', 'schema' => ['description' => 'The Anti-DDoS instance type. Set this parameter to AntiDDosPremimum.', 'type' => 'string', 'required' => true, 'example' => 'AntiDDosPremimum', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the Anti-DDoS instance configuration.', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => ['description' => 'The container that stores the Anti-DDoS instance configuration.', '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Initialize bucket protection', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'InitUserAntiDDosInfo' => [ 'summary' => 'Creates an Anti-DDoS Pro or Anti-DDoS Premium instance for OSS DDoS protection.', '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":"\\n","type":"xml"}]', 'title' => 'Create an OSS DDoS protection instance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'InitiateBucketWorm' => [ 'summary' => 'Creates a data 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'InitiateWormConfiguration' => ['description' => 'The configuration for the initialization of a data retention policy.', '$ref' => '#/components/schemas/InitiateWormConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-worm-id' => [ 'schema' => ['sdkPropertyName' => 'wormId', 'type' => 'string'], ], ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create a retention policy', 'description' => 'Object Storage Service (OSS) supports the Write Once Read Many (WORM) feature, which allows you to store and use data in a non-deletable and non-modifiable manner. OSS allows you to configure a time-data retention policy for a bucket with a protection period ranging from 1 day to 70 years.'."\n" ."\n" .'- If a time-data retention policy is not locked within 24 hours after it is created, the policy automatically expires. After a retention policy is locked, you can upload and read objects in the bucket. However, you cannot delete objects or the retention policy before the retention period of the objects expires. You can delete objects only after their retention periods expire. For more information about retention policies, see [Retention policy](~~90564~~).'."\n" ."\n" .'- Versioning and retention policies cannot be configured at the same time for the same bucket. If versioning is enabled for a bucket, you cannot configure a retention policy for the bucket. For more information about versioning, see [Overview of versioning](~~109685~~).', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitiateBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'InitiateMultipartUpload' => [ 'summary' => 'Notifies Object Storage Service (OSS) to initialize a multipart upload event.', '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 in which to initialize a multipart upload event.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The name of the object for which to initialize a multipart upload event.', 'type' => 'string', 'required' => true, 'example' => 'multipart.data', 'title' => ''], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => ['description' => 'The encoding type for the returned key. URL encoding is supported. Keys use UTF-8 characters, but XML 1.0 does not support parsing certain control characters, such as characters with ASCII values from 0 to 10. If a key contains control characters that are not supported by XML 1.0, specify encoding-type to encode the returned key.'."\n" .'Default value: null.'."\n" .'Valid value: **url**.', '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to overwrite an existing object with the same name during the InitiateMultipartUpload operation. When the destination bucket is in the enabled or suspended versioning state, the **x-oss-forbid-overwrite** request header is invalid, and existing objects with the same name can be overwritten.'."\n" .' - If **x-oss-forbid-overwrite** is not specified or is set to **false**, an existing object with the same name can be overwritten.'."\n" .' - If **x-oss-forbid-overwrite** is set to **true**, an existing object with the same name cannot be overwritten.'."\n" ."\n" .'Setting the **x-oss-forbid-overwrite** request header degrades QPS processing performance. If you need to use the **x-oss-forbid-overwrite** request header for a large number of operations (QPS > 1000), contact technical support to avoid impact on your business.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => ['description' => 'The storage class of the object.'."\n" .'For a bucket of any storage class, if you specify this value when uploading an object, the object is stored as the specified storage class. For example, if you set **x-oss-storage-class** to Standard when uploading an object to an Infrequent Access bucket, the object is stored as Standard.'."\n" .'Valid values:'."\n" ."\n" .'- Standard'."\n" .'- IA: Infrequent Access'."\n" .'- Archive'."\n" .'- ColdArchive: Cold Archive'."\n" ."\n" .'For more information about storage classes, see **[Overview of storage classes](~~51374~~)**.', '$ref' => '#/components/schemas/StorageClass', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => ['description' => 'The tags of the object. You can set multiple tags at the same time, for example, TagA=A&TagB=B.'."\n" .'> The key and value must be URL-encoded. If an entry does not contain `=`, the value is treated as an empty string.', 'type' => 'string', 'required' => false, 'example' => 'a:1', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => ['description' => 'The server-side encryption method used when uploading each part of the object.'."\n" .'Valid values: **AES256**, **KMS**, or **SM4**'."\n" .'> Before using the KMS encryption algorithm, activate Key Management Service (KMS).'."\n" ."\n\n" .'After you specify this parameter, the response header returns this parameter. OSS encrypts and stores each uploaded part. When you download the object, the response header includes x-oss-server-side-encryption, and the value is set to the encryption algorithm of the object.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => ['description' => 'The encryption algorithm for the object. If this option is not specified, the object is encrypted by using AES256. This option is valid only when **x-oss-server-side-encryption** is set to KMS.'."\n" .'Valid value: SM4.', 'type' => 'string', 'required' => false, 'example' => 'SM4', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => ['description' => 'The ID of the customer master key (CMK) hosted in KMS.'."\n" .'This parameter is valid only when **x-oss-server-side-encryption** is set to KMS.', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', 'title' => ''], ], [ 'name' => 'Cache-Control', 'in' => 'header', 'schema' => ['description' => 'The web page caching behavior when the object is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''], ], [ 'name' => 'Content-Disposition', 'in' => 'header', 'schema' => ['description' => 'The name of the object when it is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'attachment;filename=oss_download.jpg ', 'title' => ''], ], [ 'name' => 'Content-Encoding', 'in' => 'header', 'schema' => ['description' => 'The content encoding format of the object when it is downloaded. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'utf-8', 'title' => ''], ], [ 'name' => 'Expires', 'in' => 'header', 'schema' => ['description' => 'The expiration time, in milliseconds. For more information, see **[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 28 Feb 2012 05:38:42 GMT ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the result of the Initiate Multipart Upload request.', 'type' => 'object', 'properties' => [ 'InitiateMultipartUploadResult' => [ 'description' => 'The container that stores the result of the Initiate Multipart Upload request.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The name of the bucket in which to initialize a multipart upload event.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'Key' => ['description' => 'The name of the object for which to initialize a multipart upload event.', 'type' => 'string', 'example' => 'test.txt', 'title' => ''], 'UploadId' => ['description' => 'The ID that uniquely identifies this multipart upload event. This ID is used in subsequent calls to the UploadPart and CompleteMultipartUpload operations.', 'type' => 'string', 'example' => '0004B9894A22E5B1888A1E29F823****', 'title' => ''], 'EncodingType' => ['description' => 'The encoding type used in the response. If encoding-type is specified in the request parameters, the key in the response is encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n test.txt\\n 0004B9894A22E5B1888A1E29F823****\\n url\\n","type":"xml"}]', 'title' => 'Notify OSS to initialize a multipart upload event', 'description' => '- This operation returns a globally unique Upload ID created by the OSS server. This ID identifies the multipart upload event. You can use this ID to perform related operations, such as aborting or querying the multipart upload.'."\n" ."\n" .'- Initializing a multipart upload request does not affect an existing object with the same name.'."\n" ."\n" .'- When calculating the authentication signature for this operation, add `?uploads` to `CanonicalizedResource`.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'ListAccessPoints' => [ 'summary' => 'Retrieves access point information at the user level or bucket level.', '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' => ['title' => '', 'description' => 'The maximum number of access points to return. Valid values:'."\n" ."\n" .'- When retrieving user-level access points, the value must be greater than 0 and less than or equal to 1000.'."\n" ."\n" .'- When retrieving bucket-level access points, the value must be greater than 0 and less than or equal to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The token from which the list operation starts. You can obtain this token from NextContinuationToken in the response.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body of the ListAccessPoints operation.', 'type' => 'object', 'properties' => [ 'ListAccessPointsResult' => ['title' => '', 'description' => 'The container that stores the results of listing access point information.', '$ref' => '#/components/schemas/ListAccessPointsResult', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n abc**\\n 10107***1448150\\n \\n \\n oss-example\\n \\n vpc-t4nlw426y44rd3iq4****\\n \\n \\n \\n 10\\n","type":"xml"}]', 'title' => 'Retrieve access point information', 'changeSet' => [ ['createdAt' => '2024-11-28T15:04:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListAccessPoints', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'ListAccessPointsForObjectProcess' => [ 'summary' => 'Retrieves user-level Object FC Access Point information.', '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: greater than 0 and less than or equal to 1000.'."\n" ."\n" .'> If the results cannot be completely listed at a time due to the max-keys setting, the response includes a `` element as the continuation-token for the next listing operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => ['description' => 'The token from which the List operation must start. You can obtain this token from NextContinuationToken in the response.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'ListAccessPointsForObjectProcessResult' => [ 'description' => 'The container that stores the results of this Object FC Access Point listing operation.', 'type' => 'object', 'properties' => [ 'IsTruncated' => ['description' => 'Indicates whether the results returned in the request are truncated. Valid values:'."\n" ."\n" .'- true: Not all results are returned in this request.'."\n" .'- false: All results are returned in this request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'NextContinuationToken' => ['description' => 'Indicates that this ListAccessPointsForObjectProcess request contains subsequent results. Set continuation-token to NextContinuationToken to continue retrieving results.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'AccountId' => ['description' => 'The UID of the Alibaba Cloud account to which the Object FC Access Point belongs.', 'type' => 'string', 'example' => '111933544165****', 'title' => ''], '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' => 'The container that stores information about a single Object FC Access Point.', 'type' => 'object', 'properties' => [ 'AccessPointNameForObjectProcess' => ['description' => 'The name of the Object FC Access Point.', 'type' => 'string', 'example' => 'fc-ap-01', 'title' => ''], 'AccessPointForObjectProcessAlias' => ['description' => 'The alias of the Object FC Access Point.', 'type' => 'string', 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', 'title' => ''], 'AccessPointName' => ['description' => 'The name of the access point.', 'type' => 'string', 'example' => 'fc-01', 'title' => ''], 'Status' => ['description' => 'The status of the Object FC Access Point. Valid values:'."\n" ."\n" .'- enable: The Object FC Access Point is created.'."\n" .'- disable: The Object FC Access Point is disabled.'."\n" .'- creating: The Object FC Access Point is being created.'."\n" .'- deleting: The Object FC Access Point is deleted.', 'type' => 'string', 'example' => 'enable', 'title' => ''], 'AllowAnonymousAccessForObjectProcess' => ['description' => 'Indicates whether anonymous access is allowed.'."\n" ."\n" .'> After you enable this option, anonymous accounts are allowed to access your bucket through the Object FC Access Point. This incurs fees.', 'type' => 'string', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n abc\\n 111933544165****\\n \\n \\n fc-ap-01\\n fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias\\n fc-01\\n enable\\n false\\n \\n \\n","type":"xml"}]', 'title' => 'List object FC access points', 'description' => 'An Alibaba Cloud account has the permission to retrieve Object FC Access Point information by default. To retrieve Object FC Access Point information by using a Resource Access Management (RAM) user or Security Token Service (STS), you must have the `oss:ListAccessPointsForObjectProcess` permission.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListAccessPointsForObjectProcess', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListBucketAntiDDosInfo' => [ 'summary' => 'Retrieves the list of bucket protection information.', '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' => 'Specifies the marker after which Anti-DDoS instances are returned in alphabetical order.'."\n" ."\n" .'> For the first request, set marker to an empty string. If IsTruncated in the response is true, use the marker value from the response as the parameter for the next request.', 'type' => 'string', 'required' => false, 'example' => 'nextMarker', 'title' => ''], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['description' => 'The maximum number of Anti-DDoS instances to return.'."\n" ."\n" .'Valid values: [1,100]'."\n" ."\n" .'Default value: 100.', 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'AntiDDOSListConfiguration' => [ 'description' => 'The container that stores the list of bucket protection information.', 'type' => 'object', 'properties' => [ 'Marker' => ['description' => 'The Anti-DDoS instances returned in alphabetical order after the specified marker.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'IsTruncated' => ['description' => 'Indicates whether all Anti-DDoS instances are returned.'."\n" ."\n" .'true: Not all Anti-DDoS instances are returned in this request.'."\n" ."\n" .'false: All Anti-DDoS instances are returned in this request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AntiDDOSConfiguration' => [ 'description' => 'The list that stores Anti-DDoS instance information.', 'type' => 'array', 'items' => ['description' => 'The container that stores Anti-DDoS instance information.', '$ref' => '#/components/schemas/BucketAntiDDOSInfo', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n abc\\n true\\n \\n cbcac8d2-4f75-4d6d-9f2e-c3447f73****\\n 114893010724****\\n examplebucket\\n 1626769503\\n 1626769840\\n 1626769845\\n Defending\\n AntiDDosPremimum\\n \\n abc1.example.cn\\n \\n \\n","type":"xml"}]', 'title' => 'Retrieve bucket protection information list', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListBucketDataRedundancyTransition' => [ 'summary' => 'Lists all data redundancy type conversion tasks for a bucket.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data redundancy type conversion tasks for the bucket.', 'type' => 'object', 'properties' => [ 'ListBucketDataRedundancyTransition' => [ 'description' => 'The container for the data redundancy type conversion tasks.', 'type' => 'object', 'properties' => [ 'BucketDataRedundancyTransition' => ['description' => 'The information about the data redundancy type conversion task.', '$ref' => '#/components/schemas/BucketDataRedundancyTransition', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n example-bucket\\n 751f5243f8ac4ae89f34726534d1****\\n Queueing\\n 2023-11-17T09:14:39.000Z\\n 2023-11-17T09:14:39.000Z\\n 2023-11-17T09:14:39.000Z\\n 88\\n 10\\n \\n","type":"xml"}]', 'title' => 'List bucket data redundancy type conversion tasks', 'description' => '- To list all data redundancy type conversion tasks for a bucket, you must have the `oss:ListBucketDataRedundancyTransition` permission. For more information, see [Grant a custom authorization policy to a RAM user](~~199058~~).'."\n" .'- Each region has a corresponding endpoint. For more information about the mappings between regions and endpoints, see [Endpoints and data centers](~~31837~~).', 'changeSet' => [ ['createdAt' => '2024-04-29T06:25:57.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'ListBucketInventory' => [ 'summary' => 'Retrieves all inventory rules 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' => 'list'], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => ['description' => 'The token from which the List operation must start. You can obtain this token from the NextContinuationToken in the ListBucketInventory response.', 'type' => 'string', 'required' => false, 'example' => 'first', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ListInventoryConfigurationsResult' => [ 'description' => 'The container that stores the inventory configuration parameters.', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => [ 'description' => 'The container that stores the inventory configuration parameters.', 'type' => 'array', 'items' => ['description' => 'The inventory configuration.', '$ref' => '#/components/schemas/InventoryConfiguration', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'IsTruncated' => ['description' => 'Indicates whether all inventory rules are listed.'."\n" ."\n" .'Valid values: true or false.'."\n" ."\n" .'If the value is false, all inventory rules in the bucket are listed.'."\n" ."\n" .'If the value is true, not all inventory rules in the bucket are listed. You can use the value of the NextContinuationToken field as the continuation-token parameter in the next list request to retrieve the next page of inventory configurations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'NextContinuationToken' => ['description' => 'When IsTruncated in the response is true and NextContinuationToken is not empty, use this field as the continuation-token parameter in the next list request.', 'type' => 'string', 'example' => '当响应中的IsTruncated为true且NextContinuationToken非空时,使用该字段作为下一次list请求的continuation-token参数。', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n report1\\n true\\n \\n \\n 100000000000000\\n acs:ram::100000000000000:role/AliyunOSSRole\\n acs:oss:::bucket_0001\\n prefix1/\\n \\n \\n 9468da86-3509-4f8d-a61e-6eab1eac****\\n \\n \\n \\n \\n \\n \\n Pics/\\n 1637883649\\n 1638347592\\n 1024\\n 1048576\\n All\\n \\n All\\n \\n \\n true\\n \\n 600\\n \\n \\n Etag\\n \\n \\n \\n true\\n 当响应中的IsTruncated为true且NextContinuationToken非空时,使用该字段作为下一次list请求的continuation-token参数。\\n","type":"xml"}]', 'title' => 'List all inventory rules of a bucket', 'description' => '- A single request returns up to 100 inventory configuration items. To retrieve more than 100 inventory configuration items, send multiple requests and retain the corresponding token as a parameter for the next request.'."\n" ."\n" .'- Before calling this operation, make sure that you have sufficient permissions to manage inventory rules for the bucket. The bucket owner has this permission by default. If you do not have this permission, request it from the bucket owner.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:GetBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'ListBuckets' => [ 'summary' => 'Lists all buckets owned by the 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' => '', 'description' => 'Limits the returned bucket names to those that begin with the specified prefix. If this parameter is not specified, no prefix filtering is applied.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'my'], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies that results are returned in alphabetical order starting from the first bucket after the marker value. If this parameter is not specified, results are returned from the beginning.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'mybucket10'], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies the maximum number of buckets to return in this request.'."\n" .'Valid values: 1 to 1000.'."\n" .'Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ 'name' => 'x-oss-resource-group-id', 'in' => 'header', 'schema' => ['title' => '', 'description' => 'The resource group ID to which the bucket belongs.', '$ref' => '#/components/schemas/ResourceGroupId', 'required' => false, 'example' => ''], ], [ 'name' => 'tag-key', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies the bucket tag key. Only buckets that have the specified tag are included in the results.', 'type' => 'string', 'required' => false, 'example' => 'test-key'], ], [ 'name' => 'tag-value', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies the bucket tag value. If this parameter is specified, the tag-value parameter must also be specified. Only buckets that have the specified tag key-value pair are included in the results.', 'type' => 'string', 'required' => false, 'example' => 'test-value'], ], [ 'name' => 'tagging', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies a tag list, for example, "k1":"v1","k2":"v2". Only buckets that match all tag key-value pairs in the list are included in the results.'."\n" .'The tagging parameter cannot be used together with the tag-key and tag-value parameters.', 'type' => 'string', 'required' => false, 'example' => '"test-key":"test-value"'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body of the ListBuckets (GetService) operation.', 'type' => 'object', 'properties' => [ 'ListAllMyBucketsResult' => [ 'title' => '', 'description' => 'The container that stores the results of the ListBuckets (GetService) request.', 'type' => 'object', 'properties' => [ 'Owner' => ['title' => '', 'description' => 'The container that stores the information about the bucket owner.', '$ref' => '#/components/schemas/Owner', 'example' => ''], 'Prefix' => ['title' => '', 'description' => 'The prefix used to filter the query results.', 'type' => 'string', 'example' => 'logs/'], 'Marker' => ['title' => '', 'description' => 'The marker used as the starting point for this ListBuckets (GetService) request.', 'type' => 'string', 'example' => 'abc'], 'MaxKeys' => ['title' => '', 'description' => 'The maximum number of results returned in the response.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'IsTruncated' => [ 'title' => '', 'description' => 'Indicates whether all results have been returned. Valid values:'."\n" .'- true: Not all results were returned in this request.'."\n" .'- false: All results were returned in this request.', 'enumValueTitles' => ['true' => 'Not all results were returned in this request.', 'false' => 'All results were returned in this request.'], 'type' => 'boolean', 'example' => 'true', ], 'NextMarker' => ['title' => '', 'description' => 'The marker for the next ListBuckets (GetService) request. You can assign this value to the marker parameter to retrieve the remaining results.', 'type' => 'string', 'example' => 'def'], 'Buckets' => [ 'title' => '', 'description' => 'The container that stores the list of bucket information.', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '', 'description' => 'The list that stores information about multiple buckets.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The container that stores the bucket information.', '$ref' => '#/components/schemas/Bucket', 'example' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], '5xx' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n logs/\\n abc\\n 20\\n true\\n def\\n \\n \\n 2014-05-15T11:18:32.000Z\\n oss-cn-hangzhou.aliyuncs.com\\n oss-cn-hangzhou-internal.aliyuncs.com\\n oss-cn-hangzhou\\n mybucket01\\n cn-hangzhou\\n \\n \\n","type":"xml"}]', 'title' => 'List buckets', 'description' => '- You can also use the prefix, marker, or max-keys parameter to list buckets that meet specified conditional criteria.'."\n" .'- To list buckets, you must have the oss:GetService (ListBuckets) authorization. For more information, see [Grant a custom access policy to a Resource Access Management (RAM) user](https://help.aliyun.com/document_detail/199058.htm?spm=a2c4g.11186623.0.0.48be7590hCA8LI#section-ucu-jv0-zip).'."\n" .'- When you invoke this operation, if all buckets have been returned, the Prefix, Marker, MaxKeys, IsTruncated, and NextMarker response elements are not included in the XML body of the response.', 'changeSet' => [ ['createdAt' => '2024-12-04T06:51:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-28T14:34:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-22T06:45:47.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListBuckets', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListCname' => [ 'summary' => 'Queries the list of all custom domain names (CNAMEs) bound 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body for querying the CNAME information list.', 'type' => 'object', 'properties' => [ 'ListCnameResult' => [ 'description' => 'The container for the CNAME information list.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'Owner' => ['description' => 'The user ID of the bucket owner.', 'type' => 'string', 'example' => '133413***273506', 'title' => ''], 'Cname' => [ 'description' => 'The list of CNAME information.', 'type' => 'array', 'items' => ['description' => 'The container for CNAME information.', '$ref' => '#/components/schemas/CnameInfo', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n 133413***273506\\n \\n example.com\\n 2021-09-15T02:35:07.000Z\\n Enabled\\n \\n CAS\\n 493****-cn-hangzhou\\n Enabled\\n Wed, 15 Sep 2021 02:35:06 GMT\\n DE:01:CF:EC:7C:A7:98:CB:D8:6E:FB:1D:97:EB:A9:64:1D:4E:**:**\\n Wed, 12 Apr 2023 10:14:51 GMT\\n Mon, 4 May 2048 10:14:51 GMT\\n \\n \\n","type":"xml"}]', 'title' => 'Query custom domain name list', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'ListDataLakeStorageTransferJob' => [ 'summary' => 'List data lake metadata transformation jobs ', '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, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'DataLakeStorageTransferJobs' => ['$ref' => '#/components/schemas/DataLakeStorageTransferJobs', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [ ['createdAt' => '2025-04-18T07:13:44.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListDataLakeStorageTransferJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n false\\n test-bucket\\n abcdef03370a4b32ac6bc69eb1123456\\n \\n abcdef87e3c04af2af290ec52d123456\\n abcdef87e3c04af2af290ec52d123456\\n bucket1\\n 1\\n REPLICATION_JOB_IDLE\\n 1727162332\\n 1727164655\\n \\n \\n \\n abc/\\n \\n \\n tag\\n AliyunOSSRole\\n log/\\n false\\n \\n \\n 50\\n \\n \\n","type":"xml"}]', 'title' => '', 'translator' => 'machine', ], 'ListLiveChannel' => [ 'summary' => 'Lists the 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => ['description' => 'Specifies that results are returned starting from the first LiveChannel alphabetically after the marker value.', 'type' => 'string', 'required' => false, 'example' => 'channel-1', 'title' => ''], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['description' => 'The maximum number of LiveChannels to return. The value of max-keys cannot exceed 1000.'."\n" .'Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => ['description' => 'Specifies that only LiveChannels whose names start with the specified prefix are returned. When you use prefix for a query, the returned keys still contain the prefix.', 'type' => 'string', 'required' => false, 'example' => 'fun/', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the results of the ListLiveChannel request.', 'type' => 'object', 'properties' => [ 'ListLiveChannelResult' => [ 'description' => 'The container that stores the results of the ListLiveChannel request.', 'type' => 'object', 'properties' => [ 'Prefix' => ['description' => 'The prefix used in this query.', 'type' => 'string', 'example' => 'Channel', 'title' => ''], 'Marker' => ['description' => 'The marker used as the starting point for this ListLiveChannel operation.', 'type' => 'string', 'example' => 'new', 'title' => ''], 'MaxKeys' => ['description' => 'The maximum number of results returned in the response.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'IsTruncated' => ['description' => 'Indicates whether all results have been returned. Valid values:'."\n" ."\n" .'- true: All results have been returned.'."\n" ."\n" .'- false: Not all results have been returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'NextMarker' => ['description' => 'If not all results are returned, the response includes the NextMarker element, which indicates the Marker value for the next request.', 'type' => 'string', 'example' => 'channel-0', 'title' => ''], 'LiveChannel' => [ 'description' => 'The list of returned LiveChannel information.', 'type' => 'array', 'items' => ['description' => 'The container that stores the LiveChannel information.', '$ref' => '#/components/schemas/LiveChannel', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Channel\\n new\\n 20\\n true\\n channel-0\\n \\n channel-0\\n test\\n enabled\\n ISO8601\\n \\n rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/test-channel\\n \\n \\n http://test-bucket.oss-cn-hangzhou.aliyuncs.com/test-channel/playlist.m3u8\\n \\n \\n","type":"xml"}]', 'title' => 'List specified live streams', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:ListLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListMultipartUploads' => [ 'summary' => 'Lists all in-progress multipart upload events.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => ['description' => 'The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a CommonPrefixes element.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], ], [ 'name' => 'max-uploads', 'in' => 'query', 'schema' => ['description' => 'The maximum number of multipart upload events to return. Default value: 1000. Maximum value: 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'key-marker', 'in' => 'query', 'schema' => ['description' => 'Used together with the upload-id-marker parameter to specify the starting position of the returned results.'."\n" .' - If the upload-id-marker parameter is not set, the query results include all multipart upload events whose object names are lexicographically greater than the key-marker parameter value.'."\n" .' - If the upload-id-marker parameter is set, the query results include:'."\n" .' - All multipart upload events whose object names are lexicographically greater than the key-marker parameter value.'."\n" .' - Multipart upload events whose object names are equal to the key-marker parameter value but whose UploadId is greater than the upload-id-marker parameter value.', 'type' => 'string', 'required' => false, 'example' => 'test1.avi', 'title' => ''], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => ['description' => 'Specifies that the returned object keys must be prefixed with this value. Note that when you use the prefix parameter for a query, the returned keys still contain the prefix.'."\n" .'> Use the prefix parameter to group and manage objects in a bucket (similar to a folder feature).', 'type' => 'string', 'required' => false, 'example' => 'fun/', 'title' => ''], ], [ 'name' => 'upload-id-marker', 'in' => 'query', 'schema' => ['description' => 'Used together with the key-marker parameter to specify the starting position of the returned results.'."\n" .' - If the key-marker parameter is not set, OSS ignores the upload-id-marker parameter.'."\n" .' - If the key-marker parameter is set, the query results include:'."\n" .' - All multipart upload events whose object names are lexicographically greater than the key-marker parameter value.'."\n" .' - Multipart upload events whose object names are equal to the key-marker parameter value but whose UploadId is greater than the upload-id-marker parameter value.', 'type' => 'string', 'required' => false, 'example' => '0004B99B8E707874FC2D692FA5D7****', 'title' => ''], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => ['description' => 'Specifies the encoding type for the returned content. Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key use UTF-8 characters, but XML 1.0 does not support parsing certain control characters, such as characters with ASCII values from 0 to 10. For control characters that are not supported by the XML 1.0 standard, you can specify encoding-type to encode the returned Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key.'."\n" ."\n" .'Default value: none.', '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the results of the ListMultipartUpload request.', 'type' => 'object', 'properties' => [ 'ListMultipartUploadsResult' => [ 'description' => 'The container that stores the results of the ListMultipartUpload request.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'EncodingType' => ['description' => 'The encoding type used in the returned results. If the encoding-type request parameter is specified, the returned Delimiter, KeyMarker, Prefix, NextKeyMarker, and Key elements are encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'KeyMarker' => ['description' => 'The starting object position of the list.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'UploadIdMarker' => ['description' => 'The starting UploadId position of the list.', 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D6****', 'title' => ''], 'NextKeyMarker' => ['description' => 'If not all results are returned, the response includes the NextKeyMarker element, which indicates the KeyMarker value for the next request.', 'type' => 'string', 'example' => 'oss.avi', 'title' => ''], 'NextUploadIdMarker' => ['description' => 'If not all results are returned, the response includes the NextUploadMarker element, which indicates the UploadMarker value for the next request.', 'type' => 'string', 'example' => '0004B99B8E707874FC2D692FA5D77D3F', 'title' => ''], 'MaxUploads' => ['description' => 'The maximum number of uploads returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'IsTruncated' => ['description' => 'Indicates whether the returned multipart upload result list is truncated. Valid values:'."\n" ."\n" .'true: Not all results are returned.'."\n" ."\n" .'false (default): All results are returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Prefix' => ['description' => 'The prefix used in this query.', 'type' => 'string', 'example' => 'logs/', 'title' => ''], 'Delimiter' => ['description' => 'The object name grouping character used in this query.', 'type' => 'string', 'example' => '/', 'title' => ''], 'Upload' => [ 'description' => 'The list that stores multipart upload event information.', 'type' => 'array', 'items' => ['description' => 'The container that stores multipart upload event information.', '$ref' => '#/components/schemas/Upload', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'CommonPrefixes' => [ 'description' => 'The list that stores common prefixes of object names in the listing results.', 'type' => 'array', 'items' => ['description' => 'The container that stores common prefixes of object names in the listing results.', '$ref' => '#/components/schemas/CommonPrefix', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n url\\n abc\\n 0004B999EF5A239BB9138C6227D6****\\n oss.avi\\n 0004B99B8E707874FC2D692FA5D77D3F\\n 20\\n true\\n logs/\\n /\\n \\n multipart.data\\n 0004B999EF5A239BB9138C6227D6****\\n 2012-02-23T04:18:23.000Z\\n \\n \\n fun/\\n \\n","type":"xml"}]', 'title' => 'List in-progress multipart upload events', 'description' => 'Calls the ListMultipartUploads operation to list all in-progress multipart upload events, which are events that have been initiated but have not been completed (Complete) or aborted (Abort).', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListMultipartUploads', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'ListObjectVersions' => [ 'summary' => 'Lists the version information of all objects in a bucket, including 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The character used to group object names. All objects whose names contain the specified prefix and appear before the first occurrence of the delimiter character are grouped as a single element (CommonPrefixes).'."\n" .'If you set prefix to a folder name and set delimiter to a forward slash (/), only the objects in the folder are returned. The names of the subfolders in the folder are returned in CommonPrefixes. Objects and folders in the subfolders are not displayed recursively.'."\n" ."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '/'], ], [ 'name' => 'key-marker', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies that results are returned in alphabetical order starting after the value of key-marker. This parameter is used together with version-id-marker.'."\n" .'The value of this parameter must be less than 1,024 bytes in length.'."\n" ."\n" .'Default value: null'."\n" ."\n" .'>If version-id-marker is not empty, key-marker cannot be empty.', 'type' => 'string', 'required' => false, 'example' => 'example'], ], [ 'name' => 'version-id-marker', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies that results are returned starting after the version specified by version-id-marker for the object specified by key-marker, sorted from the newest to the oldest version. If version-id-marker is not specified, results start from the first version of the next key after key-marker in alphabetical order.'."\n" ."\n" .'Default value: null'."\n" ."\n" .'Valid values: version ID.', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****'], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of objects to return in this request.'."\n" .'If not all results can be returned in a single request due to the max-keys setting, the response includes NextKeyMarker and NextVersionIdMarker as markers for the next request. The values of NextKeyMarker and NextVersionIdMarker are included in the response.'."\n" .'Valid values: greater than 0 and less than 1000.'."\n" .'Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies that only objects whose keys start with the prefix are returned.'."\n" ."\n" .'- The value of prefix must be less than 1,024 bytes in length.'."\n" .'- If you use prefix for a query, the keys in the returned results still include the prefix.'."\n" ."\n" .'If you set prefix to a folder name, all objects whose keys start with this prefix are listed, including all objects and subfolders in the folder recursively.'."\n" ."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'fun'], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The encoding type of the returned content.'."\n" .'Default value: null'."\n" .'Valid values: URL'."\n" .'>The delimiter, marker, prefix, NextMarker, and Key values use UTF-8 characters. If these values contain control characters that are not supported by XML 1.0, you can specify encoding-type to encode the Delimiter, Marker, Prefix, NextMarker, and Key values in the response.', '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body of the GetBucketVersions operation.', 'type' => 'object', 'properties' => [ 'ListVersionsResult' => [ 'description' => 'The container that stores the results of the GetBucketVersions request.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket'], 'Prefix' => ['title' => '', 'description' => 'The prefix used in this query.', 'type' => 'string', 'example' => 'logs/'], 'KeyMarker' => ['title' => '', 'description' => 'The object that marks the starting point of the GetBucketVersions request.', 'type' => 'string', 'example' => 'abc'], 'VersionIdMarker' => ['title' => '', 'description' => 'Used together with the KeyMarker parameter to specify the starting point of the ListObjectVersions (GetBucketVersions) request.', 'type' => 'string', 'example' => 'CAEQGBiBgIC_jq7P9xYiIDRiZWJkNjY2Y2Q4NDQ5ZTI5ZGE5ODIxMTIyZThl****'], 'MaxKeys' => ['title' => '', 'description' => 'The maximum number of results returned in the response.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'Delimiter' => ['description' => 'The character used to group object names. All objects whose names contain the specified prefix and appear before the first occurrence of the Delimiter character are grouped as a single element (CommonPrefixes).', 'type' => 'string', 'example' => '/', 'title' => ''], 'IsTruncated' => ['title' => '', 'description' => 'Indicates whether all results are returned.'."\n" ."\n" .'true: Not all results are returned in this request.'."\n" ."\n" .'false: All results are returned in this request.', 'type' => 'boolean', 'example' => 'true'], 'EncodingType' => ['description' => 'The encoding type used in the response. If encoding-type is specified in the request, the Delimiter, Marker, Prefix, NextMarker, and Key values in the response are encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'NextKeyMarker' => ['description' => 'If not all results are returned, the NextKeyMarker element is included in the response to indicate the value of key-marker for the next request.', 'type' => 'string', 'example' => 'def', 'title' => ''], 'NextVersionIdMarker' => ['description' => 'If not all results are returned, the NextVersionIdMarker element is included in the response to indicate the value of version-id-marker for the next request.', 'type' => 'string', 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****', 'title' => ''], 'Version' => [ 'title' => '', 'description' => 'The list of object version information, excluding delete markers.', 'type' => 'array', 'items' => ['description' => 'The container that stores the version information of an object, excluding delete markers.', '$ref' => '#/components/schemas/ObjectVersion', 'title' => '', 'example' => ''], 'example' => '', ], 'DeleteMarker' => [ 'title' => '', 'description' => 'The list of delete marker information.', 'type' => 'array', 'items' => ['description' => 'The container that stores delete marker information.', '$ref' => '#/components/schemas/DeleteMarkerEntry', 'title' => '', 'example' => ''], 'example' => '', ], 'CommonPrefixes' => [ 'title' => '', 'description' => 'If the delimiter parameter is specified in the request, the response contains the CommonPrefixes element. This element indicates the set of object names that end with the delimiter and share a common prefix.', 'type' => 'array', 'items' => ['description' => 'The object names that end with the delimiter and share a common prefix.', '$ref' => '#/components/schemas/CommonPrefix', 'title' => '', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n logs/\\n abc\\n CAEQGBiBgIC_jq7P9xYiIDRiZWJkNjY2Y2Q4NDQ5ZTI5ZGE5ODIxMTIyZThl****\\n 20\\n /\\n true\\n url\\n def\\n CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****\\n \\n example\\n CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****\\n true\\n 2019-04-09T07:27:28.000Z\\n 250F8A0AE989679A22926A875F0A2****\\n 93731\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n \\n \\n example\\n CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****\\n true\\n 2019-04-09T07:27:28.000Z\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n \\n \\n fun/\\n \\n","type":"xml"}]', 'title' => 'List object versions', 'description' => '- The GetBucket (ListObjects) operation returns only the current version of each object, and the current version cannot be a delete marker.'."\n" .'- The GetBucketVersions (ListObjectVersions) operation returns all versions of all objects in a bucket.'."\n" ."\n" .'Objects are returned in alphabetical order. Versions of the same object are sorted from the newest to the oldest, regardless of the alphabetical order of version IDs.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListObjectVersions', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'ListObjects' => [ 'summary' => 'Lists 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => ['description' => 'The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a single element (CommonPrefixes).', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => ['description' => 'Specifies the object after which the listing begins in alphabetical order.'."\n" .'
The marker parameter is used to implement pagination. The value of this parameter must be less than 1,024 bytes in length.'."\n" .'
When performing a conditional query, even if the marker does not exist in the list, the listing starts from the next object that follows the marker in alphabetical order.', 'type' => 'string', 'required' => false, 'example' => 'test1.txt', 'title' => ''], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['description' => 'The maximum number of objects to return. If the listing cannot be completed at one time because of the max-keys setting, a NextMarker element is included in the response as the marker for the next listing.
Valid values: greater than 0 and less than 1000.
Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => ['description' => 'Specifies that only objects whose keys start with the prefix are returned.'."\n" ."\n" .'- The prefix parameter must be less than 1,024 bytes in length.'."\n" ."\n" .'- If you use a prefix for the query, the returned keys still contain the prefix.'."\n" ."\n" .'If you set the prefix to a folder name, all objects that start with this prefix are listed, including all objects and subfolders in the folder recursively.
'."\n" .'If you also set the delimiter to a forward slash (/), only the objects in the folder are listed. The subfolders in the folder are returned in CommonPrefixes, and the objects and folders in the subfolders recursively are not displayed.
'."\n" .'For example, a bucket contains three objects: fun/test.jpg, fun/movie/001.avi, and fun/movie/007.avi. If you set the prefix to fun/, all three objects are returned. If you set the prefix to fun/ and the delimiter to a forward slash (/), fun/test.jpg and fun/movie/ are returned.', 'type' => 'string', 'required' => false, 'example' => 'fun', 'title' => ''], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'description' => 'The encoding type of the content in the response.'."\n" ."\n" .'> The delimiter, marker, prefix, NextMarker, and Key values use UTF-8 encoding. If the delimiter, marker, prefix, NextMarker, or Key value contains control characters that are not supported by XML 1.0, you can specify encoding-type to encode the Delimiter, Marker, Prefix, NextMarker, and Key values in the response.', 'enumValueTitles' => [], '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body of the GetBucket (ListObjects) operation.', 'type' => 'object', 'properties' => [ 'ListBucketResult' => [ 'description' => 'The container that stores the results of the GetBucket request.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket'], 'Prefix' => ['title' => '', 'description' => 'The prefix used in this query.', 'type' => 'string', 'example' => 'logs/'], 'Marker' => ['title' => '', 'description' => 'The marker that indicates the starting point of this GetBucket (ListObjects) request.', 'type' => 'string', 'example' => 'abc'], 'MaxKeys' => ['title' => '', 'description' => 'The maximum number of returned results in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'Delimiter' => ['title' => '', 'description' => 'The character used to group object names. All objects whose names contain the specified prefix and between which the Delimiter character appears for the first time are grouped as a single CommonPrefixes element.', 'type' => 'string', 'example' => '/'], 'IsTruncated' => [ 'title' => '', 'description' => 'Indicates whether the returned results are truncated.'."\n" ."\n" .'Valid values: true, false.'."\n" ."\n" .'true: Not all results are returned in this request.'."\n" ."\n" .'false: All results are returned in this request.', 'enumValueTitles' => ['true' => 'Not all results are returned in this request.', 'false' => 'All results are returned in this request.'], 'type' => 'boolean', 'example' => 'true', ], 'EncodingType' => ['description' => 'The encoding type used in the response. If encoding-type is specified in the request, the Delimiter, Marker, Prefix, NextMarker, and Key values in the response are encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'NextMarker' => ['description' => 'The marker for the next listing.', 'type' => 'string', 'example' => 'def', 'title' => ''], 'Contents' => [ 'title' => '', 'description' => 'The container that stores the metadata of each returned object.', 'type' => 'array', 'items' => ['description' => 'The container that stores the object metadata.', '$ref' => '#/components/schemas/ObjectSummary', 'title' => '', 'example' => ''], 'example' => '', ], 'CommonPrefixes' => [ 'title' => '', 'description' => 'If the Delimiter parameter is specified in the request, the response contains the CommonPrefixes element. This element indicates a set of object names that end with the Delimiter and share a common prefix.', 'type' => 'array', 'items' => ['description' => 'The object names that end with the Delimiter and share a common prefix.', '$ref' => '#/components/schemas/CommonPrefix', 'title' => '', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n logs/\\n abc\\n 20\\n /\\n true\\n url\\n def\\n \\n fun/test.jpg\\n 2012-02-24T08:42:32.000Z\\n 5B3C1A2E053D763E1B002CC607C5A0FE1****\\n Normal\\n 344606\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n ongoing-request=\\"true”\\n \\n \\n fun/\\n \\n","type":"xml"}]', 'title' => 'List information about all objects in a bucket', 'description' => '- The GetBucket (ListObjects) operation has been revised to GetBucketV2 (ListObjectsV2). Use the newer version GetBucketV2 (ListObjectsV2) when developing applications. For backward compatibility, Object Storage Service (OSS) continues to support GetBucket (ListObjects). For more information about GetBucketV2 (ListObjectsV2), see [GetBucketV2 (ListObjectsV2)](~~187544~~).'."\n" ."\n" .'- A GetBucket (ListObjects) request does not return user metadata of objects.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListObjects', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'ListObjectsV2' => [ 'summary' => 'Lists 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The character used to group objects by name. All objects whose names contain the specified prefix and that appear between the first occurrence of the delimiter character are grouped as a single element in CommonPrefixes.', 'type' => 'string', 'required' => false, 'example' => '/'], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of objects to return.
Valid values: greater than 0 and less than 1000.
Default value: 100.'."\n" ."\n" .'> If the number of objects exceeds the Max-keys value and not all objects can be listed in a single request, a element is included in the response as the Continuation-token for the next listing request.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies that only objects whose keys start with the specified prefix are returned.
'."\n" ."\n" .'- The value of this parameter must be less than 1,024 bytes in length.'."\n" ."\n" .'- If you use a prefix for a query, the returned keys still contain the prefix.'."\n" ."\n" .'If you set Prefix to the name of a folder, all objects whose names start with this prefix are listed, which includes all objects and subfolders in the folder in a recursive manner.
'."\n" .'If you also set Delimiter to a forward slash (/) in addition to Prefix, only the objects in the folder are listed. The subfolders in the folder are returned as CommonPrefixes elements. All objects and folders in the subfolders are not displayed.
'."\n" .'For example, a bucket contains three objects: fun/test.jpg, fun/movie/001.avi, and fun/movie/007.avi. If you set Prefix to fun/, all three objects are returned. If you set Prefix to fun/ and Delimiter to a forward slash (/), fun/test.jpg and fun/movie/ are returned.', 'type' => 'string', 'required' => false, 'example' => 'a'], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The encoding type of the content in the response.'."\n" ."\n" .'> Delimiter, Start-after, Prefix, NextContinuationToken, and Key use UTF-8 encoding. If Delimiter, Start-after, Prefix, NextContinuationToken, or Key contains control characters that are not supported by XML 1.0, you can specify Encoding-type to encode Delimiter, Start-after, Prefix, NextContinuationToken, and Key in the response.', 'enumValueTitles' => [], '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'example' => '', ], ], [ 'name' => 'fetch-owner', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to include owner information in the response. Valid values:'."\n" ."\n" .'- true: The response includes owner information.'."\n" ."\n" .'- false: The response does not include owner information.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], ], [ 'name' => 'start-after', 'in' => 'query', 'schema' => ['description' => 'Specifies that objects are returned in alphabetical order starting after the value of Start-after.
'."\n" .'Start-after is used to implement pagination. The value of this parameter must be less than 1,024 bytes in length.'."\n" .'
When you perform a conditional query, objects are listed starting from the next object in alphabetical order after Start-after, even if Start-after does not exist in the list.', 'type' => 'string', 'required' => false, 'example' => 'b', 'title' => ''], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => ['description' => 'Specifies the token from which the list operation starts. You can obtain this token from the NextContinuationToken element in the ListObjectsV2 response.', 'type' => 'string', 'required' => false, 'example' => 'test1.txt', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body of the ListObjectsV2 operation.', 'type' => 'object', 'properties' => [ 'ListBucketResult' => [ 'description' => 'The container that stores the metadata of the returned objects.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket'], 'Prefix' => ['title' => '', 'description' => 'The prefix used in this query.', 'type' => 'string', 'example' => 'logs/'], 'StartAfter' => ['description' => 'The StartAfter element is included in the response if the StartAfter parameter is specified in the request.', 'type' => 'string', 'example' => 'test.txt', 'title' => ''], 'MaxKeys' => ['title' => '', 'description' => 'The maximum number of results returned in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'Delimiter' => ['description' => 'The character used to group objects by name. All objects whose names contain the specified prefix and that appear between the first occurrence of the delimiter character are grouped as a single element in CommonPrefixes.', 'type' => 'string', 'example' => '/', 'title' => ''], 'IsTruncated' => [ 'title' => '', 'description' => 'Indicates whether the results returned in the request are truncated.'."\n" ."\n" .'Valid values: true and false.'."\n" ."\n" .'true: Not all results are returned in this request.'."\n" ."\n" .'false: All results are returned in this request.', 'enumValueTitles' => ['true' => 'Not all results are returned in this request.', 'false' => 'All results are returned in this request.'], 'type' => 'boolean', 'example' => 'true', ], 'KeyCount' => ['description' => 'The number of keys returned in this request. If Delimiter is specified, KeyCount is the sum of the Key and CommonPrefixes elements.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'EncodingType' => ['description' => 'The encoding type used in the response. If the Encoding-type parameter is specified in the request, the values of Delimiter, StartAfter, Prefix, NextContinuationToken, and Key in the response are encoded.', 'type' => 'string', 'example' => 'url', 'title' => ''], 'ContinuationToken' => ['description' => 'The ContinuationToken element is included in the response if the ContinuationToken parameter is specified in the request.', 'type' => 'string', 'example' => 'CgJiYw--', 'title' => ''], 'NextContinuationToken' => ['description' => 'Indicates that this ListObjectsV2 (GetBucketV2) request contains subsequent results. To retrieve the remaining results, specify NextContinuationToken as the ContinuationToken.', 'type' => 'string', 'example' => 'CgJiYw--', 'title' => ''], 'Contents' => [ 'title' => '', 'description' => 'The container that stores the metadata of each returned object.', 'type' => 'array', 'items' => ['description' => 'The container that stores the metadata of a single object.', '$ref' => '#/components/schemas/ObjectSummary', 'title' => '', 'example' => ''], 'example' => '', ], 'CommonPrefixes' => [ 'title' => '', 'description' => 'The CommonPrefixes element is included in the response if the Delimiter parameter is specified in the request. This element indicates the set of object names that end with the delimiter and share a common prefix.', 'type' => 'array', 'items' => ['description' => 'The object names that end with the delimiter and share a common prefix.', '$ref' => '#/components/schemas/CommonPrefix', 'title' => '', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n logs/\\n test.txt\\n 20\\n /\\n true\\n 6\\n url\\n CgJiYw--\\n CgJiYw--\\n \\n fun/test.jpg\\n 2012-02-24T08:42:32.000Z\\n 5B3C1A2E053D763E1B002CC607C5A0FE1****\\n Normal\\n 344606\\n \\n ut_test_bucket\\n ut_test_bucket\\n \\n ongoing-request=\\"true”\\n \\n \\n fun/\\n \\n","type":"xml"}]', 'title' => 'List information about all objects in a bucket V2', 'description' => 'Custom object metadata is not returned when you call the GetBucketV2 (ListObjectsV2) operation.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListObjects', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'ListParts' => [ 'summary' => 'Lists all parts that have been successfully uploaded for 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => ['description' => 'The ID of the multipart upload event.', 'type' => 'string', 'required' => true, 'example' => '0004B999EF5A239BB9138C6227D69F95', 'title' => ''], ], [ 'name' => 'max-parts', 'in' => 'query', 'schema' => ['description' => 'The maximum number of parts in the OSS response.'."\n" ."\n" .'Default value: **1,000**'."\n" ."\n" .'Maximum value: **1,000**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'part-number-marker', 'in' => 'query', 'schema' => ['description' => 'The starting position of the list. Only parts with part numbers greater than the value of this parameter are listed.'."\n" .'Default value: None.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'encoding-type', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The encoding type for the returned content. Keys use UTF-8 characters, but the XML 1.0 standard does not support parsing certain control characters, such as characters with ASCII values from 0 to 10. If a key contains control characters that are not supported by the XML 1.0 standard, you can specify Encoding-type to encode the returned keys.'."\n" ."\n" .'Default value: None'."\n" ."\n" .'Valid values: **url**.', '$ref' => '#/components/schemas/EncodeType', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the results of the List Part request.', 'type' => 'object', 'properties' => [ 'ListPartResult' => [ 'description' => 'The container that stores the results of the List Part request.', 'type' => 'object', 'properties' => [ 'Bucket' => ['description' => 'The bucket name.', 'type' => 'string', 'example' => 'example-bucket', 'title' => ''], 'Key' => ['description' => 'The object name.', 'type' => 'string', 'example' => 'multipart.data', 'title' => ''], 'UploadId' => ['description' => 'The upload event ID.', 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D69F95', 'title' => ''], 'PartNumberMarker' => ['description' => 'The starting part number position of the current list result.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'NextPartNumberMarker' => ['description' => 'If not all results are returned, the response includes the NextPartNumberMarker element, which indicates the value of PartNumberMarker for the next request.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'MaxParts' => ['description' => 'The maximum number of parts in the request response.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], 'IsTruncated' => ['description' => 'Indicates whether the returned ListParts result list is truncated. A value of "true" indicates that not all results are returned. A value of "false" indicates that all results are returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Part' => [ 'description' => 'The list that stores part information.', 'type' => 'array', 'items' => ['description' => 'The container that stores part information.', '$ref' => '#/components/schemas/Part', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n multipart.data\\n 0004B999EF5A239BB9138C6227D69F95\\n 10\\n 5\\n 20\\n true\\n \\n 3349DC700140D7F86A0784842780****\\n 1\\n 6291456\\n 2012-02-23T07:01:34.000Z\\n \\n","type":"xml"}]', 'title' => 'List all successfully uploaded parts', 'description' => '- OSS returns results in ascending order by part number.'."\n" ."\n" .'- Because network transmission errors may occur, do not use the Part Number and ETag values in the ListParts response to generate a list of successfully uploaded parts.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListParts', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'ListStyle' => [ 'summary' => 'Queries all image styles that have been created for a specified 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 bucket name.', 'type' => 'string', 'required' => false, 'example' => 'examplebucket'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains image style information.', 'type' => 'object', 'properties' => [ 'StyleList' => [ 'description' => 'The container that stores the list of image style information.', 'type' => 'object', 'properties' => [ 'Style' => [ 'description' => 'The list of image style information.', 'type' => 'array', 'items' => ['description' => 'The image style information.', '$ref' => '#/components/schemas/StyleInfo', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n","type":"xml"}]', 'title' => 'Query image styles', 'changeSet' => [ ['createdAt' => '2024-02-21T07:26:17.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'OpenMetaQuery' => [ 'summary' => 'Enables the metadata management feature. After the metadata management feature is enabled, Object Storage Service (OSS) creates a metadata index library for the bucket and builds metadata indexes for all objects in the bucket. After the metadata index library is created, OSS continues to perform near-real-time incremental tracking scans on new objects in the bucket and builds 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' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n"], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The retrieve mode. Valid values:'."\n" ."\n" .'basic (default): scalar retrieve'."\n" ."\n" .'semantic: AISearch', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'role', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The name of the RAM role used to access OSS. You can grant permissions to the role in the console to implement secure access.', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ 'MetaQuery' => ['title' => '', 'description' => 'The request body parameters for enabling the metadata management feature for the bucket.', '$ref' => '#/components/schemas/MetaQueryOpenRequest', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Enable the metadata management feature', 'changeSet' => [ ['createdAt' => '2025-11-11T05:50:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-31T01:55:14.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:OpenMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'OptionObject' => [ 'summary' => 'Before sending a cross-origin request, the browser sends a preflight request (Options) to OSS with specific information such as the origin domain, HTTP method, and headers to determine whether to send the actual 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'Origin', 'in' => 'header', 'schema' => ['description' => 'The origin domain of the request, which identifies a cross-origin request.'."\n" .'You can specify only one origin domain for this request header in the actual request.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com', 'title' => ''], ], [ 'name' => 'Access-Control-Request-Method', 'in' => 'header', 'schema' => ['description' => 'The method that will be used in the actual request.'."\n" .'You can specify only one method for this request header in the actual request.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'PUT', 'title' => ''], ], [ 'name' => 'Access-Control-Request-Headers', 'in' => 'header', 'schema' => ['description' => 'The headers other than simple headers that will be used in the actual request.'."\n" .'You can specify multiple headers for this request header in the actual request. Separate multiple headers with commas (,).'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'x-oss-test1,x-oss-test2', 'title' => ''], ], ], '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":"\\n","type":"xml"}]', 'title' => 'Send a preflight request', 'description' => 'The Options request is automatically sent by the browser based on whether the request is cross-origin.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'PostObject' => [ 'summary' => 'Upload a file (Object) to a specified bucket by using an HTML form.', 'path' => '/', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['multipart/form-data'], 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['description' => 'The name of the bucket.', 'example' => 'examplebucket', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'key', 'in' => 'formData', 'schema' => ['description' => 'The name of the Object to upload, without encoding. If the name includes a path, such as destfolder/example.jpg, OSS automatically creates the corresponding folders. Default Value: None', 'type' => 'string', 'required' => false, 'example' => 'example.jpg', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Upload files by using an HTML form', 'description' => '- The size of an Object uploaded through PostObject cannot exceed 5 GB.'."\n" ."\n" .'- The Post request requires write permission on the bucket. If the bucket is public-read-write, signature information does not need to be included. Otherwise, the operation must be signed for authentication.'."\n" ."\n" .'- Unlike the Put operation, the Post operation uses the AccessKey secret to sign the Policy and computes a signature string, which is used as the value of the Signature form field. OSS validates this value to verify the signature\'s legitimacy.'."\n" ."\n" .'- The URL for submitting the form is the bucket domain name. You do not need to specify the Object in the URL. That is, the request line must be `POST / HTTP/1.1`, not `POST /ObjectName HTTP/1.1`.'."\n" ."\n" .'- If a POST request includes header-based or URL-based signature information, OSS does not validate such information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'PostVodPlaylist' => [ 'summary' => 'Generates a video-on-demand (VOD) playlist for a 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The name of the LiveChannel. The LiveChannel must exist.', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', 'title' => ''], ], [ 'name' => 'playlist', 'in' => 'path', 'schema' => ['description' => 'The name of the VOD playlist to generate. The name must end with ".m3u8".', 'type' => 'string', 'required' => true, 'example' => 'playlist.m3u8', 'title' => ''], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['description' => 'The end time for querying TS files.'."\n" .'Format: UNIX timestamp.'."\n" .'>EndTime must be greater than StartTime, and the time span cannot exceed one day.', 'type' => 'string', 'required' => true, 'example' => '1636618271', 'title' => ''], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['description' => 'The start time for querying TS files. Format: UNIX timestamp.', 'type' => 'string', 'required' => true, 'example' => '1636600271', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Generate a VOD playlist for a live stream', 'description' => 'OSS queries the TS files generated by the specified LiveChannel within the specified time range and assembles them into an M3U8 playlist.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => false, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => ['description' => 'The access point name.', 'type' => 'string', 'required' => false, 'example' => 'ap-01', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The access point policy configuration.', '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" .' } ', 'title' => ''], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure access point policy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutAccessPointPublicAccessBlock' => [ 'summary' => 'Modifies the Block Public Access configuration of a specified 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' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'query', 'schema' => ['description' => 'The access point name.', 'type' => 'string', 'required' => true, 'example' => 'ap-01', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => ['description' => 'The container that stores the Block Public Access configuration.', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify block public access configuration for an access point', 'changeSet' => [ ['createdAt' => '2024-05-08T05:41:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], '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' => '', 'description' => 'The bucket name. Bucket naming conventions:'."\n" ."\n" .'- Can contain only lowercase letters, digits, and hyphens (-).'."\n" .'- Must start and end with a lowercase letter or digit.'."\n" .'- Must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'], ], [ 'name' => 'x-oss-acl', 'in' => 'header', 'schema' => [ 'title' => '', 'description' => 'Settings for the access permissions ACL of the bucket. Valid values:'."\n" ."\n" .'- public-read-write: public-read-write'."\n" ."\n" .'- public-read: public-read'."\n" ."\n" .'- private: private (default)'."\n" ."\n" .'For more information about bucket ACLs, see [Settings for bucket access permissions ACL](~~31843~~).', 'enumValueTitles' => [], 'required' => false, '$ref' => '#/components/schemas/BucketACL', 'example' => '', ], ], [ 'name' => 'x-oss-resource-group-id', 'in' => 'header', 'schema' => ['title' => '', 'description' => 'The resource group ID.'."\n" .'- If you include this header and specify a resource group ID, the created bucket belongs to the specified resource group. If the resource group ID is set to rg-default-id, the created bucket belongs to the default resource group.'."\n" .'- If you do not include this header, the created bucket belongs to the default resource group.'."\n" ."\n" .'You can obtain the resource group ID from 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" .'> Configuring a resource group is not supported when creating an Anywhere Bucket.', '$ref' => '#/components/schemas/ResourceGroupId', 'required' => false, 'example' => ''], ], [ 'name' => 'x-oss-bucket-tagging', 'in' => 'header', 'schema' => ['title' => '', 'description' => 'The bucket tags, such as 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 bucket creation information.', 'type' => 'object', 'properties' => [ 'CreateBucketConfiguration' => ['title' => '', 'description' => 'The configuration information used to create the bucket.', '$ref' => '#/components/schemas/CreateBucketConfiguration', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create a bucket', 'description' => '- You can create up to 100 buckets in each region within the same Alibaba Cloud account.'."\n" .'- Each region has a corresponding endpoint. For more information about the mappings between regions and endpoints, see [Regions and endpoints](~~31837~~).', 'extraInfo' => 'The following SDKs are available for this operation:'."\n" .'- Java'."\n" .'- Python'."\n" .'- PHP'."\n" .'- Go'."\n" .'- C'."\n" .'- .NET'."\n" .'- Android'."\n" .'- iOS'."\n" .'- Node.js'."\n" .'- Ruby.', 'changeSet' => [ ['createdAt' => '2024-12-05T08:32:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-04T06:51:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-28T14:34:37.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:29.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutBucket', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:x-oss-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutBucketAcl'], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for modifying the access tracking status configuration.', 'type' => 'object', 'properties' => [ 'AccessMonitorConfiguration' => ['description' => 'The container that stores the access tracking status configuration of the bucket.', '$ref' => '#/components/schemas/AccessMonitorConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify bucket access tracking status', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketAccessMonitor', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketAcl' => [ 'summary' => 'Sets or modifies the access permissions (ACL) of 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'x-oss-acl', 'in' => 'header', 'schema' => [ 'description' => 'Sets the access permissions (ACL) of the bucket. The PutBucketAcl operation sets the ACL by using the x-oss-acl request header in the PUT request. If this header is not included, the ACL settings do not take effect.'."\n" .'
Valid values:'."\n" ."\n" .'- public-read-write: All users have read and write access permissions on the files in the bucket. Exercise caution when you set this ACL.'."\n" .'- public-read: The bucket owner and authorized users have read and write access permissions on the files in the bucket. Other users have only read permissions on the files in the bucket. Exercise caution when you set this ACL.'."\n" .'- private: The bucket owner and authorized users have read and write access permissions on the files in the bucket. Other users have no permissions on the files in the bucket.', 'enumValueTitles' => ['private' => 'private.', 'public-read' => 'public-read.', 'public-read-write' => 'public-read-write.'], 'required' => true, '$ref' => '#/components/schemas/BucketACL', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set or modify the access permissions of a bucket', 'description' => '- The requester must have the `oss:PutBucketAcl` permission to write the ACL of the bucket.'."\n" ."\n" .'- PutBucketAcl uses overwrite semantics. The new ACL overwrites the existing ACL.'."\n" ."\n" .'- If the specified bucket does not exist, calling this operation creates a new bucket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:x-oss-acl'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketCommonHeader' => [ 'summary' => 'Sets the custom HTTP response header 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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body of the operation.', 'type' => 'object', 'properties' => [ 'CommonHeaders' => ['title' => '', 'description' => 'The custom HTTP response header configuration.', '$ref' => '#/components/schemas/CommonHeaders', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set custom response header configuration for a bucket', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketCommonHeader', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketCors' => [ 'summary' => 'Configures cross-origin resource sharing (CORS) rules for a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for configuring CORS rules.', 'type' => 'object', 'properties' => [ 'CORSConfiguration' => ['description' => 'The container that stores the CORS rules for the bucket.', '$ref' => '#/components/schemas/CORSConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure CORS rules for a bucket', 'description' => "\n" .'- CORS is disabled by default'."\n" .'
CORS is disabled for a bucket by default. Origins of all cross-origin requests are not allowed.'."\n" ."\n" .'- Overwrite semantics'."\n" .'
PutBucketCors uses overwrite semantics. A new CORS rule configuration overwrites the existing CORS rule configuration.'."\n" ."\n" .'- Use CORS in applications'."\n" .'
To use CORS in an application, manually upload CORS rules by calling the PutBucketCors operation to enable CORS.'."\n" .'
For example, to access OSS from `example.com` by using the `XMLHttpRequest` function of a browser, manually upload CORS rules by calling this operation. The CORS rules must be described in an XML document.'."\n" ."\n" .'- CORS rule matching'."\n" .'
When OSS receives a cross-origin request or an OPTIONS request, it reads the CORS rules configured for the bucket and then performs permission checks. OSS checks each rule in sequence and uses the first matching rule to allow the request and return the corresponding headers. If no rule matches, no CORS-related headers are included in the response.'."\n" .'
A CORS rule match must meet all three of the following conditions:'."\n" .' - The Origin of the request must match an `AllowedOrigin` entry.'."\n" ."\n" .' - The request method (such as GET or PUT) or the method that corresponds to the `Access-Control-Request-Method` header of the OPTIONS request must match an `AllowedMethod` entry.'."\n" ."\n" .' - Each header included in the `Access-Control-Request-Headers` header of the OPTIONS request must match an `AllowedHeader` entry.', 'extraInfo' => '### SDK'."\n" ."\n" .'- [Java](~~32018~~)'."\n" .'- [Python](~~32036~~)'."\n" .'- [PHP](~~32110~~)'."\n" .'- [Go](~~32156~~)'."\n" .'- [C](~~89705~~)'."\n" .'- [C++](~~103198~~)'."\n" .'- [.NET](~~32095~~)'."\n" .'- [Node.js](~~142900~~)'."\n" .'- [Ruby](~~32128~~)'."\n" ."\n" .'### Error codes'."\n" .'|Error code|HTTP status code|Description|'."\n" .'|--|--|--|'."\n" .'|InvalidDigest|400|After you upload the Content-MD5 request header, OSS calculates the Content-MD5 of the message body and checks for consistency. This error code is returned if the values are inconsistent.|.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for configuring server-side encryption rules.', 'type' => 'object', 'properties' => [ 'ServerSideEncryptionRule' => ['description' => 'The container for server-side encryption rules.', '$ref' => '#/components/schemas/ServerSideEncryptionRule', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure the encryption rule for a bucket', 'summary' => 'Configures the encryption rule for a bucket.', 'description' => 'Only the bucket owner and authorized RAM users can set encryption rules for a bucket. Otherwise, a 403 error is returned. For more information about bucket encryption, see [Server-side encryption](~~31871~~).', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketHash' => [ 'summary' => 'Modifies the hash algorithm configuration of 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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body of the operation.', 'type' => 'object', 'properties' => [ 'ObjectHashConfiguration' => ['title' => '', 'description' => 'The object hash algorithm configuration.', '$ref' => '#/components/schemas/ObjectHashConfiguration', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify bucket hash algorithm configuration', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:25.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketHash', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketHttpsConfig' => [ 'summary' => 'Calls the PutBucketHttpsConfig operation to enable or disable TLS version settings 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' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the HTTPS configuration.', 'type' => 'object', 'properties' => [ 'HttpsConfiguration' => ['description' => 'The container that stores the HTTPS configuration.', '$ref' => '#/components/schemas/HttpsConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify bucket HTTPS configuration', 'changeSet' => [ ['createdAt' => '2024-02-21T14:34:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketHttpsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketInventory' => [ 'summary' => 'Configures an inventory rule for a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the inventory rule.', 'type' => 'string', 'required' => true, 'example' => 'report1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the inventory configuration.', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => ['description' => 'The container that stores the inventory configuration.', '$ref' => '#/components/schemas/InventoryConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure an inventory rule for a bucket', 'description' => "\n" .'- Only the bucket owner and users who have been granted the PutBucketInventory permission can initiate a request to configure an inventory rule.'."\n" ."\n" .'- Before configuring an inventory rule, create a RAM role that has the permissions to read all objects in the source bucket and write objects to the destination bucket. If you use the inventory feature for the first time, configure the inventory rule in the OSS console. After the inventory rule is configured, you can obtain a RAM role that has all required permissions. For more information about the permissions of the RAM role in an inventory rule, see [Bucket inventory](~~163489~~).'."\n" ."\n" .'- You can configure up to 1,000 inventory rules for a single bucket.'."\n" ."\n" .'- The source bucket for which the inventory is configured and the destination bucket that stores the inventory lists must be in the same region.', 'extraInfo' => '### SDK'."\n" .'- [Java](~~177804~~)'."\n" .'- [Python](~~177819~~)'."\n" .'- [Go](~~177811~~)'."\n" .'- [C++](~~177809~~)'."\n" .'- [.NET](~~178701~~)'."\n" .'- [Node.js](~~186530~~)'."\n" ."\n" .'### Error codes'."\n" .'|Error code|HTTP status code|Description|'."\n" .'|--|--|--|'."\n" .'|InvalidArgument|400|Invalid parameters are specified.|'."\n" .'|InventoryExceedLimit|400|The number of inventory rules exceeds the upper limit.|'."\n" .'|AccessDenied|403|
**·**No authentication information is included in the PutBucketInventory request.
**·**The user does not have the required permissions.|'."\n" .'|InventoryAlreadyExist|409|The specified inventory rule already exists.|.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketLifecycle' => [ 'summary' => 'Configures lifecycle rules for a bucket.', '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'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'x-oss-allow-same-action-overlap', 'in' => 'header', 'schema' => ['description' => 'Specifies whether lifecycle rules allow prefix overlap. Valid values:'."\n" ."\n" .'true: Prefix overlap is allowed.'."\n" ."\n" .'false: Prefix overlap is not allowed.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that stores the lifecycle configurations.', 'type' => 'object', 'properties' => [ 'LifecycleConfiguration' => ['description' => 'The container for lifecycle configurations. A maximum of 1000 rules can be configured.', '$ref' => '#/components/schemas/LifecycleConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure lifecycle rules for a bucket', 'description' => '- Only the bucket owner and Resource Access Management (RAM) users who have been granted the PutBucketLifecycle permission can initiate a request to configure lifecycle rules.'."\n" ."\n" .'- If no lifecycle rules have been set for the bucket, this operation creates a new lifecycle rule. If lifecycle rules have been set for the bucket, this operation overwrites the existing rule configurations.'."\n" ."\n" .'- PutBucketLifecycle uses overwrite semantics. To append lifecycle rules, invoke the GetBucketLifecycle operation to obtain the current lifecycle rule configurations, append the new lifecycle rule configurations, and then invoke the PutBucketLifecycle operation to update the lifecycle rule configurations.'."\n" ."\n" .'- The PutBucketLifecycle operation can set the expire time for objects and parts (parts that are uploaded by using multipart upload but are not committed).', 'changeSet' => [ ['createdAt' => '2024-03-05T07:08:18.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketLogging' => [ 'summary' => 'Enables the logging feature for a bucket. Access logs are generated as log files on an hourly basis based on a fixed naming convention and written to a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the access logging status information.', 'type' => 'object', 'properties' => [ 'BucketLoggingStatus' => ['description' => 'The container that stores the access logging status information.', '$ref' => '#/components/schemas/BucketLoggingStatus', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Enable bucket logging', 'description' => '- The source bucket that generates logs and the destination bucket that stores logs can be the same or different, but they must belong to the same account and reside in the same region.'."\n" ."\n" .'- Log files are generated on an hourly basis. However, this does not mean that a log file for a specific time period contains all requests made during that period. Some requests may appear in the log file of the previous or next time period.'."\n" .'For more information about log file naming conventions and log formats, see [Logging](~~31868~~).'."\n" ."\n" .'- Log files are continuously generated until you disable the logging feature. Delete log files that are no longer needed promptly to reduce storage costs.'."\n" .'You can use lifecycle rules to periodically delete log files. For more information, see [Overview of lifecycle rules](~~31863~~).'."\n" ."\n" .'- OSS may append fields to the end of logs as needed. Consider compatibility when developing log processing tools.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObject'], ], ], ], 'translator' => 'machine', ], 'PutBucketObjectWormConfiguration' => [ 'path' => '/?objectWorm', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREoss2NCTTF'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ObjectWormConfiguration' => ['title' => '', 'description' => 'The container that stores the object-level data retention policy.', '$ref' => '#/components/schemas/ObjectWormConfiguration', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify bucket object retention policy configuration', 'summary' => 'Enables object retention on a bucket and configures the default data retention policy.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'translator' => 'machine', ], 'PutBucketPolicy' => [ 'summary' => 'Sets an access policy for a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request body.', 'type' => 'string', 'format' => 'binary', 'required' => true, 'example' => '二进制内容', 'title' => ''], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set a bucket access policy', 'description' => '- Grant access permissions to Resource Access Management (RAM) users of other accounts.'."\n" ."\n" .'You can grant RAM users of other accounts access permissions to your OSS resources.'."\n" ."\n" .'- Grant access permissions to anonymous users with IP address-based restrictions.'."\n" ."\n" .'In some scenarios, you need to grant anonymous users an access policy with IP address restrictions. For example, confidential documents within an enterprise are allowed to be accessed only from within the enterprise network and not from other areas. Because the enterprise has a large number of internal users, configuring a RAM policy for each user requires significant effort. In this case, you can configure a bucket policy with IP address restrictions to efficiently perform authorization.'."\n" ."\n" .'For details about bucket policy configurations and scenario examples, see [Use bucket policies to authorize other users to access OSS resources](~~85111~~). For details about the policy syntax, see [Access policy syntax and structure](~~93739~~).', 'changeSet' => [ ['createdAt' => '2025-11-20T03:52:56.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketReferer' => [ 'summary' => 'Configures the hotlink protection (Referer) whitelist at the bucket level. You can specify whether to allow requests with an empty Referer field and whether to allow requests with a truncated query string to access OSS.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the Referer configuration.', 'type' => 'object', 'properties' => [ 'RefererConfiguration' => ['description' => 'The container that stores the Referer configuration.', '$ref' => '#/components/schemas/RefererConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure hotlink protection for a bucket', 'changeSet' => [ ['createdAt' => '2024-02-20T08:53:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketReferer', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketReplication' => [ 'summary' => 'Specifies a data replication rule 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.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that specifies the data replication configuration.', 'type' => 'object', 'properties' => [ 'ReplicationConfiguration' => [ 'description' => 'The container that stores the data replication configuration.', 'type' => 'object', 'properties' => [ 'Rule' => ['$ref' => '#/components/schemas/ReplicationRule', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-replication-rule-id' => [ 'schema' => ['title' => '新增数据复制规则的ID', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Specify a data replication rule for a bucket', 'description' => 'Data replication asynchronously (near real-time) replicates objects in a source bucket and operations such as object creation, update, and deletion to a destination bucket. Before you begin:'."\n" ."\n" .'- Data replication is asynchronous. The time required to replicate data to the destination bucket varies from minutes to hours, depending on the data size.'."\n" ."\n" .'- The source bucket and the destination bucket must have different names.'."\n" ."\n" .'- For CRR, the source bucket and the destination bucket must be in different regions. For SRR, the source bucket and the destination bucket must be in the same region.'."\n" ."\n" .'For more information about data replication, see [Cross-area replication](https://help.aliyun.com/document_detail/31864.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-zjp-31z-5db) and [Same-region replication (SRR)](https://help.aliyun.com/document_detail/254865.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-2067125).', 'changeSet' => [ ['createdAt' => '2025-11-20T03:48:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-24T08:04:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObject', 'validationType' => 'conditional'], ['action' => 'oss:ReplicateGet', 'validationType' => 'conditional'], ], ], ], 'translator' => 'machine', ], 'PutBucketRequestPayment' => [ 'summary' => 'Settings the pay-by-requester pattern 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for configuring pay-by-requester.', 'type' => 'object', 'properties' => [ 'RequestPaymentConfiguration' => ['description' => 'The container that stores the pay-by-requester configuration.', '$ref' => '#/components/schemas/RequestPaymentConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set pay-by-requester pattern', 'description' => '- Anonymous access is not allowed: If you enable pay-by-requester for a bucket, anonymous access to the bucket is not allowed. The requester must provide identity verification information so that OSS can identify the requester and charge the requester instead of the bucket owner for the fees incurred by the request.'."\n" .'If the requester requests data by assuming a RAM role, the account to which the role belongs is charged for the request.'."\n" ."\n" .'- The requester must include x-oss-request-payer: If you enable pay-by-requester for a bucket, the requester must include x-oss-request-payer:requester in the request header of POST, GET, and HEAD requests to acknowledge that the requester is aware of the fees incurred by the request and data download. Otherwise, the request fails to authenticate.'."\n" .'The data owner does not need to include the x-oss-request-payer header when accessing the bucket. When the data owner accesses the bucket as the requester, the data owner (who is also the requester) is charged for the fees incurred by the request.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketRequestPayment', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketResourceGroup' => [ 'summary' => 'Modifies the resource group ID of a bucket.', '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' => '', 'description' => 'The target bucket to modify.', 'type' => 'string', 'required' => false, 'example' => 'example-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the resource group ID configuration.', 'type' => 'object', 'properties' => [ 'BucketResourceGroupConfiguration' => ['description' => 'The container for the resource group ID configuration.', '$ref' => '#/components/schemas/BucketResourceGroupConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify bucket resource group', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketRtc' => [ 'summary' => 'Enables or shuts down the replication time control (RTC) feature for an existing cross-region replication rule.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the RTC configuration rule.', 'type' => 'object', 'properties' => [ 'ReplicationRule' => ['description' => 'The container that stores the RTC configuration rule.', '$ref' => '#/components/schemas/RtcConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set RTC', 'changeSet' => [ ['createdAt' => '2024-04-24T08:04:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketTags' => [ 'summary' => 'Adds or modifies tags for 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for setting the bucket TagSet.', 'type' => 'object', 'properties' => [ 'Tagging' => ['description' => 'The container for setting the bucket TagSet.', '$ref' => '#/components/schemas/Tagging', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Add or modify tags for a bucket', 'description' => '- Only the bucket owner and authorized RAM users can set tags for a bucket. Otherwise, a 403 Forbidden error with the AccessDenied error code is returned.'."\n" ."\n" .'- You can set up to 20 tags (key-value pairs) for a bucket.'."\n" ."\n" .'- PutBucketTags uses overwrite semantics. New tags completely overwrite existing tags.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketTransferAcceleration' => [ 'summary' => 'Calls the PutBucketTransferAcceleration operation to configure transfer acceleration for a bucket. After transfer acceleration is enabled, users across the globe can access Object Storage Service (OSS) at higher speeds. This feature is suitable for scenarios such as remote data transfer and upload or download of large files that are measured in GB or TB.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body for the transfer acceleration configuration.', 'type' => 'object', 'properties' => [ 'TransferAccelerationConfiguration' => ['description' => 'The container for the transfer acceleration configuration.', '$ref' => '#/components/schemas/TransferAccelerationConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure transfer acceleration for a bucket', 'description' => '- Only the bucket owner and Resource Access Management (RAM) users who are granted the oss:PutBucketTransferAcceleration permission can configure transfer acceleration.'."\n" ."\n" .'- After transfer acceleration is enabled, the bucket retains the default endpoint and is assigned an acceleration endpoint. However, access speed is improved only when you use the acceleration endpoint of OSS.'."\n" ."\n" .'- When you use the acceleration endpoint to access a bucket, OSS charges transfer acceleration fees. For details, see [Transfer acceleration fees](~~173539~~).'."\n" ."\n" .'For more information about transfer acceleration, see [Transfer acceleration](~~131312~~) in the developer guide.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutBucketTransferAcceleration', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketVersioning' => [ 'summary' => 'Configures the versioning state of a specified 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'VersioningConfiguration' => ['description' => 'The container that stores the versioning configuration.', '$ref' => '#/components/schemas/VersioningConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set the versioning state of a bucket', 'description' => '- To configure versioning, you must have the PutBucketVersioning permission.'."\n" ."\n" .'- A bucket can be in one of three versioning states: unversioned, Enabled, or Suspended. By default, a bucket is in the unversioned state.'."\n" ."\n" .'- When a bucket is in the Enabled versioning state, all newly added objects have a unique version ID, and Object Storage Service (OSS) accumulates multiple versions of the added objects.'."\n" ."\n" .'- When a bucket is in the Suspended versioning state, all newly added objects have a version ID of null, and OSS no longer accumulates more versions for objects added in this state.'."\n" ."\n" .'For more information about versioning, see [Versioning overview](~~109695~~).', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketVersioning', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutBucketWebsite' => [ 'summary' => 'Configures a bucket for static website hosting and sets redirection rules (RoutingRule).', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The container that stores the static website configuration.', 'type' => 'object', 'properties' => [ 'WebsiteConfiguration' => ['description' => 'The container that stores the static website configuration.', '$ref' => '#/components/schemas/WebsiteConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Configure a bucket for static website hosting and set redirection rules', 'description' => '- Feature support: This operation is used to configure the default homepage, default 404 page, and RoutingRules. RoutingRules specify 3xx redirection rules and mirroring-based back-to-origin rules. Mirroring-based back-to-origin is supported in the China (Beijing) and Finance Cloud regions.'."\n" ."\n" .'- Access a static website by using a custom domain name: To use a custom domain name to access a static website hosted on a bucket, configure a CNAME record for the domain name. For more information, refer to Bindcustom domain name.'."\n" ."\n" .'- Index page and error page: When you configure a bucket for static website hosting, if you specify an index page or an error page, the specified page must be an object in the bucket.'."\n" ."\n" .'- Anonymous access to the root domain of a static website: After you configure a bucket for static website hosting, Object Storage Service (OSS) returns the index page for anonymous access to the root domain of the static website. OSS returns the result of GetBucket (ListObjects) for signed access to the root domain of the static website.', 'changeSet' => [ ['createdAt' => '2024-02-22T03:34:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutChannel' => [ 'summary' => 'Creates an 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' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Channel' => ['title' => '', 'description' => 'The container that stores the image processing channel configurations.', '$ref' => '#/components/schemas/Channel', 'required' => false, 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create an image processing channel', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketImage', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutCname' => [ 'summary' => 'Binds a custom domain name 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the CNAME configuration.', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => ['description' => 'The container that stores the CNAME configuration.', '$ref' => '#/components/schemas/BucketCnameConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Bind custom domain name', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutDataLakeCachePrefetchJob' => [ 'summary' => 'Configure OSS accelerator asynchronous prefetch rules ', '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' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'x-oss-datalake-job-id', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'CreateDataLakeCachePrefetchJob' => ['title' => '', '$ref' => '#/components/schemas/CreateDataLakeCachePrefetchJob', 'description' => '', 'example' => ''], ], 'description' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'DataLakeCachePrefetchJobID' => [ 'type' => 'object', 'properties' => [ 'ID' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [ ['createdAt' => '2025-04-08T10:59:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutDataLakeCachePrefetchJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n","type":"xml"}]', 'title' => '', 'translator' => 'machine', ], 'PutLiveChannel' => [ 'summary' => 'Creates a LiveChannel, which is required before you upload audio and video data by using the RTMP protocol.', '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', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The name of the channel. The name cannot contain forward slashes (/).', 'type' => 'string', 'required' => true, 'example' => 'ChannelName', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the LiveChannel configurations.', 'type' => 'object', 'properties' => [ 'LiveChannelConfiguration' => ['description' => 'The container that stores the LiveChannel configurations.', '$ref' => '#/components/schemas/LiveChannelConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body that contains the result of the CreateLiveChannel request.', 'type' => 'object', 'properties' => [ 'CreateLiveChannelResult' => [ 'description' => 'The container that stores the result of the CreateLiveChannel request.', 'type' => 'object', 'properties' => [ 'PublishUrls' => ['description' => 'The container that stores the ingest URLs.', '$ref' => '#/components/schemas/LiveChannelPublishUrls', 'title' => '', 'example' => ''], 'PlayUrls' => ['description' => 'The container that stores the playback URLs.', '$ref' => '#/components/schemas/LiveChannelPlayUrls', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/test-channel\\n \\n \\n http://test-bucket.oss-cn-hangzhou.aliyuncs.com/test-channel/playlist.m3u8\\n \\n","type":"xml"}]', 'title' => 'Create a live stream channel', 'description' => 'Before you upload audio and video data by using the RTMP protocol, call this operation to create a LiveChannel. This operation returns an RTMP ingest URL and the corresponding playback URLs.'."\n" .'
You can use the returned URLs for stream ingest and playback. You can also perform related operations based on the LiveChannel name, such as querying the stream ingest status, querying the stream ingest history, and disabling stream ingest.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'PutLiveChannelStatus' => [ 'summary' => 'Switches a LiveChannel between the enabled and disabled states.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => ['description' => 'The name of the LiveChannel. The LiveChannel must exist.', 'type' => 'string', 'required' => true, 'example' => 'exmplechannel', 'title' => ''], ], [ 'name' => 'status', 'in' => 'query', 'schema' => ['description' => 'The status of the LiveChannel.'."\n" .'Valid values:'."\n" .'- enabled: enables the LiveChannel'."\n" .'- disabled: disables the LiveChannel.', 'type' => 'string', 'required' => true, 'example' => 'enabled', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Switch live streaming status', 'description' => '- When a LiveChannel is in the disabled state, OSS prohibits you from streaming to the LiveChannel. If you are streaming to the LiveChannel, the streaming client is forcibly disconnected (with a delay of approximately 10 seconds).'."\n" .'- When no client is streaming to the LiveChannel, you can call PutLiveChannelStatus to re-create the LiveChannel to change the Status.'."\n" .'- When a client is streaming to the LiveChannel, you can only change the LiveChannel status to disabled. You cannot call PutLiveChannelStatus to re-create the LiveChannel.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutLiveChannelStatus', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'translator' => 'machine', ], 'PutObject' => [ 'summary' => 'Uploads 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to overwrite an existing object with the same name when you call the PutObject operation. When the destination bucket is in the enabled or suspended versioning state, the **x-oss-forbid-overwrite** request header is invalid, and existing objects with the same name are overwritten.'."\n" .' - If you do not specify **x-oss-forbid-overwrite** or set **x-oss-forbid-overwrite** to **false**, an existing object with the same name is overwritten.'."\n" .' - If you set **x-oss-forbid-overwrite** to **true**, an existing object with the same name cannot be overwritten.'."\n" ."\n" .'Setting the **x-oss-forbid-overwrite** request header decreases the QPS processing performance. If you want to use the **x-oss-forbid-overwrite** request header in a large number of operations (QPS > 1000), contact technical support to avoid impact on your business.'."\n" .'Default value: **false**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => ['description' => 'Specifies the server-side encryption method when the object is created.'."\n" ."\n" .'Valid values: **AES256**, **KMS**, or **SM4**'."\n" ."\n" .'If you specify this header, it is returned in the response. OSS encrypts the uploaded object and stores it. When you download the object, the response contains the **x-oss-server-side-encryption** header, and its value is set to the encryption algorithm of the object.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => ['description' => 'Specifies the server-side encryption method when the object is created.'."\n" ."\n" .'Valid values: **AES256**, **KMS**, or **SM4**'."\n" ."\n" .'If you specify this header, it is returned in the response. OSS encrypts the uploaded object and stores it. When you download the object, the response contains the **x-oss-server-side-encryption** header, and its value is set to the encryption algorithm of the object.', 'type' => 'string', 'required' => false, 'example' => 'AES256', 'title' => ''], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => ['description' => 'The ID of the customer master key (CMK) hosted on Key Management Service (KMS).'."\n" .'This parameter is valid only when **x-oss-server-side-encryption** is set to KMS.', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', 'title' => ''], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => ['description' => 'The access control list (ACL) of the object to create.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- default: The object inherits the ACL of the bucket.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have read and access permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have read and access permissions on the object. Other users have only read permissions on the object. Exercise caution when you set the ACL to this value.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have read and access permissions on the object. Exercise caution when you set the ACL to this value.'."\n" ."\n" .'For more information about ACLs, see **[ACL](~~100676~~)**.', '$ref' => '#/components/schemas/ObjectACL', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => ['description' => 'The storage class of the object. For a bucket of any storage class, if you specify this parameter when you upload an object, the object is stored as the specified storage class. For example, if you specify x-oss-storage-class as Standard when you upload an object to an Infrequent Access (IA) bucket, the object is stored as Standard. Valid values: Standard, IA, Archive, and Cold Archive. For more information about storage classes, see Overview of storage classes.', '$ref' => '#/components/schemas/StorageClass', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => ['description' => 'The tag of the object. You can configure multiple tags at the same time, for example, TagA=A&TagB=B.'."\n" .'> The key and value must be URL-encoded. If a tag does not contain an equal sign (=), the tag value is considered an empty string.', 'type' => 'string', 'required' => false, 'example' => 'a:1', 'title' => ''], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => 'When you call the PutObject operation, if a parameter is prefixed with **x-oss-meta-***, the parameter is considered as user metadata, for example, `x-oss-meta-location`. An object can have multiple similar parameters. However, the total size of all user metadata cannot exceed 8 KB.'."\n" ."\n" .'User metadata supports hyphens (-), digits, and lowercase letters (a to z). Uppercase letters are converted to lowercase letters. Other characters, including underscores (_), are not supported.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => '使用PutObject接口时,如果配置以**x-oss-meta-***为前缀的参数,则该参数视为元数据,例如`x-oss-meta-location`。一个Object可以有多个类似的参数,但所有的元数据总大小不能超过8 KB。'."\n" ."\n" .'元数据支持短划线(-)、数字、英文字母(a~z)。英文字符的大写字母会被转成小写字母,不支持下划线(_)在内的其他字符。', 'type' => 'string', 'example' => 'x-oss-meta-location', 'title' => ''], 'example' => 'x-oss-meta-location', 'title' => '', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request body.', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', 'title' => ''], ], ], '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' => '**Before you begin**'."\n" ."\n" .'- The size of the object to upload cannot exceed 5 GB.'."\n" ."\n" .'- By default, if an object with the same name already exists and you have access permissions on the object, the newly uploaded object overwrites the existing object, and 200 OK is returned.'."\n" ."\n" .'- Object Storage Service (OSS) does not use folders. All resources are stored as objects. However, you can create a simulated folder by creating an object whose name ends with a forward slash (/) and whose size is 0.'."\n" ."\n" .'**Versioning**'."\n" ."\n" .'- In a versioning-enabled bucket, OSS automatically generates a unique version ID for the newly uploaded object and returns the version ID in the x-oss-version-id response header.'."\n" .'- In a versioning-suspended bucket, the version ID of the newly uploaded object is null. OSS ensures that only one version with a null version ID exists for the same object.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:DeleteObject'], ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'PutObjectAcl' => [ 'summary' => 'Modifies the access permissions (ACL) of a file (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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => ['description' => 'The access control list of the object when OSS creates the object.'."\n" .'Valid values:'."\n" ."\n" .'- default (default): The object inherits the ACL of the bucket in which the object is stored.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have the access control list permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have the access control list permissions on the object. Other users have only read permissions on the object. Exercise caution when you set the ACL to this value.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have the access control list permissions on the object. Exercise caution when you set the ACL to this value.'."\n" ."\n" .'For more information about access permissions, see [Access control list ACL](~~100676~~).', 'required' => true, '$ref' => '#/components/schemas/ObjectACL', 'title' => '', 'example' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object.', 'type' => 'string', 'required' => false, 'example' => 'CAEQMhiBgIC3rpSD0BYiIDBjYTk5MmIzN2JlNjQxZTFiNGIzM2E3OTliODA0****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => ['title' => 'The version of a object', 'type' => 'string'], ], ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify the access permissions of a file', 'description' => '**Before you begin**.'."\n" ."\n" .'Only the bucket owner can execute this operation, and the bucket owner must have the access control list permissions on the object.'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'When you call the PutObjectACL operation, the ACL of the current version of the object is configured by default. You can specify the versionId parameter to configure the ACL of a specific object version. If the specified version is a delete marker, OSS returns 404 Not Found.'."\n" ."\n" .'**ACL description**.'."\n" ."\n" .'The PutObjectACL operation uses the `x-oss-object-acl` request header in the PUT request to configure the object ACL. The following four access permissions are supported for objects.'."\n" ."\n" .'- private: The object is a private resource. Only the owner of the object has the access control list permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. The object owner has the access control list permissions on the object. Other users have only read permissions on the object.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have the access control list permissions on the object.'."\n" .'- default: The object inherits the access control list of the bucket in which the object is stored.'."\n" ."\n" .'>**Note**'."\n" .'- The ACL of an object takes precedence over the ACL of the bucket in which the object is stored. For example, if the bucket ACL is private and the object ACL is public-read-write, all users have access permissions on the object, even if the bucket is a private bucket. If no ACL is configured for an object, the access permissions of the object are determined by the ACL of the bucket.'."\n" .'- Read operations on an object include GetObject, HeadObject, CopyObject, and the read operation on the source object in UploadPartCopy. Write operations on an object include PutObject, PostObject, AppendObject, DeleteObject, DeleteMultipleObjects, CompleteMultipartUpload, and the write operation on the destination object in CopyObject.'."\n" .'- You can also include the x-oss-object-acl request header in the request when you perform write operations on an object to configure the object access permissions. This has the same effect as calling PutObjectACL. For example, you can include the x-oss-object-acl request header in a PutObject request to configure the access permissions of the object when you upload the object.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutObjectAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ['action' => 'oss:PutObjectVersionAcl'], ], ], ], 'translator' => 'machine', ], 'PutObjectLegalHold' => [ 'path' => '/{key}?legalHold', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREoss2NCTTF'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the object.', 'type' => 'string', 'required' => true, 'example' => 'test.txt'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'LegalHold' => ['title' => '', 'description' => 'The container that stores the legal hold information of the object.', '$ref' => '#/components/schemas/LegalHold', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify the legal hold status of an object', 'summary' => 'Configures the legal hold on an object.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'translator' => 'machine', ], 'PutObjectRetention' => [ 'path' => '/{key}?retention', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/xml'], 'produces' => ['application/xml'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREossMTB3XG'], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The bucket name.', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The object name.', 'type' => 'string', 'required' => true, 'example' => 'test.txt'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Retention' => ['title' => '', 'description' => 'The container that stores the object data retention policy.', '$ref' => '#/components/schemas/Retention', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query the data retention policy of an object', 'summary' => 'Configures an object-level data retention policy on an object.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'translator' => 'machine', ], 'PutObjectTagging' => [ 'summary' => 'Sets or updates the tags (Tagging) 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the tag set.', 'type' => 'object', 'properties' => [ 'Tagging' => ['description' => 'The tag set.', '$ref' => '#/components/schemas/Tagging', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => ['type' => 'string'], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Set or update object tags', 'description' => '**Before you begin**.'."\n" ."\n" .'- Object tagging uses a set of key-value pairs to tag objects.'."\n" .'- You can configure up to 10 tags for each object. Tag keys must be unique.'."\n" .'- Each key can be up to 128 characters in length. Each value can be up to 256 characters in length.'."\n" .'- Keys and values are case-sensitive.'."\n" .'- Valid characters for tags include uppercase and lowercase letters, digits, spaces, and the following special characters:'."\n" .'+‑=._:/'."\n" .'If you set tags by using HTTP headers and the tags contain arbitrary characters, you must URL-encode the tag keys and values.'."\n" .'- Changing tag information does not update the Last-Modified time of the object.'."\n" ."\n" .'For more information about object tagging, see [Object tagging](~~106678~~).'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'When you call the PutObjectTagging operation, tags are set for the current version of the object by default. You can specify the versionId parameter to set tags for a specific version of the object. If the specified version is a delete marker, Object Storage Service (OSS) returns 404 Not Found.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObjectVersionTagging'], ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'PutProcessConfiguration' => [ 'summary' => 'Modifies the media processing configuration of a bucket.', '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' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'BucketProcessConfiguration' => ['title' => '', 'description' => 'The image processing configuration of the bucket.', 'required' => true, '$ref' => '#/components/schemas/BucketProcessConfiguration', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify bucket media processing configuration', 'changeSet' => [ ['createdAt' => '2025-03-07T07:20:40.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketImage', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutPublicAccessBlock' => [ 'summary' => 'Modifies the Block Public Access configuration at the OSS global level.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => ['description' => 'The container that stores the Block Public Access configuration.', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Modify user-level block public access configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutPublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'PutStyle' => [ 'summary' => 'Creates an image style. An image style can contain 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => ['description' => 'The image style name.', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', 'title' => ''], ], [ 'name' => 'category', 'in' => 'query', 'schema' => ['description' => 'The style category.'."\n" ."\n" .'Valid values: image, document, and video.', 'type' => 'string', 'required' => false, 'example' => 'image', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the image style information.', 'type' => 'object', 'properties' => [ 'Style' => ['description' => 'The container that stores the image style information list.', '$ref' => '#/components/schemas/Style', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create an image style', 'changeSet' => [ ['createdAt' => '2024-04-23T06:42:53.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-02-21T07:26:17.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'translator' => 'machine', ], 'PutSymlink' => [ 'summary' => 'Creates a symbolic link (symlink) for a target object (TargetObject) in OSS.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'x-oss-symlink-target', 'in' => 'header', 'schema' => ['description' => 'The target object to which the symbolic link points.'."\n" .'Valid values: The naming conventions are the same as those for objects.'."\n" .' - Similar to ObjectName, TargetObjectName must be URL-encoded.'."\n" .' - The type of the target object cannot be a symbolic link.', 'type' => 'string', 'required' => true, 'example' => 'oss.jpg', 'title' => ''], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => ['description' => 'The access control list (ACL) of the object that OSS creates.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- default: The object inherits the ACL of the bucket in which the object is stored.'."\n" .'- private: The object is a private resource. Only the object owner and authorized users have read and access permissions on the object. Other users do not have permissions to perform operations on the object.'."\n" .'- public-read: The object is a public-read resource. Only the object owner and authorized users have read and access permissions on the object. Other users have only read permissions on the object. Exercise caution when you set the ACL to this value.'."\n" .'- public-read-write: The object is a public-read-write resource. All users have read and access permissions on the object. Exercise caution when you set the ACL to this value.'."\n" ."\n" .'For more information about ACLs, see **[ACL](~~100676~~)**.', '$ref' => '#/components/schemas/ObjectACL', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => ['description' => 'The storage class of the object.'."\n" .'If you specify this parameter when you upload an object to a bucket of any storage class, the object is stored as the specified storage class. For example, if you specify **x-oss-storage-class** as Standard when you upload an object to an Infrequent Access (IA) bucket, the object is stored as Standard.'."\n" ."\n" .'Valid values:'."\n" .'- Standard'."\n" .'- IA: Infrequent Access'."\n" .'- Archive'."\n" ."\n" .'If the size of an object of the IA or Archive storage class is smaller than 64 KB, the object is billed for 64 KB. We recommend that you do not set the storage class of an object to IA or Archive when you call the PutSymlink operation.'."\n" .'For more information about storage classes, see **[Overview of storage classes](~~51374~~)**.', '$ref' => '#/components/schemas/StorageClass', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => ['description' => 'Specifies whether to overwrite an existing object with the same name when you call the PutSymlink operation.'."\n" .' - If you do not specify **x-oss-forbid-overwrite** or set **x-oss-forbid-overwrite** to **false**, an existing object with the same name is overwritten.'."\n" .' - If you set **x-oss-forbid-overwrite** to **true**, an existing object with the same name is not overwritten.'."\n" ."\n" .'Setting the **x-oss-forbid-overwrite** request header decreases the QPS processing performance. If you need to use the **x-oss-forbid-overwrite** request header in a large number of operations (QPS > 1,000), contact technical support to avoid impacts on your business.'."\n" .'> If versioning is enabled or suspended for the destination bucket, the **x-oss-forbid-overwrite** request header does not take effect. In this case, an existing object with the same name is overwritten.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => ['type' => 'string'], ], ], ], '5XX' => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Create a symbolic link for an OSS target object', 'description' => '**Before you begin**.'."\n" ."\n" .'- The PutSymlink operation does not check whether the target object exists, whether the target object type is valid, or whether you access permissions to access the target object.'."\n" .'- The access control list (ACL) of the symlink itself and the ACL of the target object are checked only when an API operation such as GetObject that requires access to the target object is called.'."\n" .'- If you specify parameters prefixed with x-oss-meta- when you call the PutSymlink operation, the parameters are considered user metadata. For example, x-oss-meta-location. An object can have multiple user metadata parameters, but the total size of all user metadata cannot exceed 8 KB.'."\n" .'- By default, if the object that you want to add already exists and you access permissions to access the object, the new object overwrites the existing object. After the object is added, 200 OK is returned.'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'You can create a symlink for a TargetObject. The symlink points to the current version of the TargetObject.'."\n" .'A symlink can also have multiple versions. Each version can point to a different TargetObject. The version ID is automatically generated by OSS and returned in the x-oss-version-id response header.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ], ], ], 'translator' => 'machine', ], 'RestoreObject' => [ 'summary' => 'Restores an Archive or Cold Archive object.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => ['description' => 'The version ID of the object to restore.', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the restore request information.', 'type' => 'object', 'properties' => [ 'RestoreRequest' => ['description' => 'The container for the restore request information.', '$ref' => '#/components/schemas/RestoreRequest', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], '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":"\\n","type":"xml"}]', 'title' => 'Restore an archive or cold archive object', 'description' => '**Versioning**.'."\n" ."\n" .'Each version of an object can have a different storage class. By default, calling the RestoreObject operation restores the current version of the object. You can restore a specific version by specifying the versionId parameter.'."\n" ."\n" .'>- The RestoreObject operation applies only to Archive or Cold Archive objects. It does not apply to Standard or Infrequent Access objects.'."\n" .'- If you call the RestoreObject operation on the object for the first time, 202 is returned.'."\n" .'- If you have already called the RestoreObject operation and the object has been restored, 200 OK is returned.'."\n" ."\n" .'**Restore process**.'."\n" ."\n" .'To read an Archive or Cold Archive object, you must restore it in advance. Restoring an Archive object has a latency of minutes. Restoring a Cold Archive object has a latency of hours.'."\n" ."\n" .'The following describes the state transitions of an Archive or Cold Archive object before and after a restore operation:'."\n" ."\n" .'1. The object is initially in the frozen state.'."\n" ."\n" .'2. After you submit a restore request, the object enters the restoring state.'."\n" ."\n" .'3. After the server completes the restore task, the object enters the restored state, and you can read the object.'."\n" .'- For an Archive object, the restored state lasts 24 hours by default. If you call the RestoreObject operation again within 24 hours, the restored state is automatically extended by 24 hours. You can call the RestoreObject operation up to 7 times during a single restore process for a maximum restored state duration of 7 days. You can also specify a restored state duration of up to 7 days in a single RestoreObject call by passing in the number of days.'."\n" .'- For a Cold Archive object, you can specify the number of restore days and the restore priority. The minimum number of restore days is 1 and the maximum is 7. The time to retrieve the first byte varies by restore priority:'."\n" ."\n" .' - Expedited: The restore is completed within 1 hour.'."\n" .' - Standard: The restore is completed within 2 to 5 hours. If you do not specify the JobParameters node, the default priority is Standard.'."\n" .' - Bulk: The restore is completed within 5 to 12 hours.'."\n" ."\n" .'4. After the restored state expires, the object returns to the frozen state.'."\n" ."\n" .'**Billing**.'."\n" ."\n" .'The following fees are incurred during the state transition process:'."\n" .'- Restoring an object in the frozen state incurs data retrieval fees.'."\n" .'- The restored state can be extended for up to 7 days. No additional data retrieval fees are charged during this period.'."\n" .'- After the restored state expires, the object returns to the frozen state. Restoring the object again incurs data retrieval fees.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:RestoreObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:RestoreObjectVersion'], ], ], ], 'translator' => 'machine', ], 'SealAppendObject' => [ 'summary' => 'Seals an appendable object that was created by using the AppendObject operation. The SealAppendable operation prevents further appends to the appendable object. After this operation is performed, you can configure a lifecycle rule to convert the storage class of the 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' => ['title' => '', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test-bucket'], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the appendable object.', 'type' => 'string', 'required' => true, 'example' => 'test-appendable-object'], ], [ 'name' => 'position', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The expected length of the object at the time of sealing.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1024'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-sealed-time' => [ 'schema' => ['title' => '该Object执行SealAppendable操作的GMT时间。 若该Object未执行过SealAppendable操作,则返回本次操作时间。 若该Object执行过SealAppendable操作,则返回对应的操作时间。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Seal an appendable object', 'changeSet' => [ ['createdAt' => '2025-11-28T06:11:10.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'SelectObject' => [ 'summary' => 'Executes an SQL statement on a specified object and returns the execution result.', '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', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', 'title' => ''], ], [ 'name' => 'x-oss-process', 'in' => 'query', 'schema' => ['description' => 'Set this parameter to csv/select for CSV files or json/select for JSON files.', 'type' => 'string', 'required' => true, 'example' => 'csv/select', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The container that stores the SelectObject request.', 'type' => 'object', 'properties' => [ 'SelectRequest' => ['description' => 'The container that stores the Select request.', '$ref' => '#/components/schemas/SelectRequest', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => '- If the value of the x-oss-select-output-raw header is true, the returned result is the raw object data instead of data wrapped in frames. In this case, the client can retrieve data in the same way as calling the GetObject operation.'."\n" .'- If the value of x-oss-select-output-raw is false, the result is returned in frames.'."\n" .'The format of a frame is `Version|Frame-Type | Payload Length | Header Checksum | Payload | Payload Checksum<1 byte><--3 bytes--><---4 bytes----><-------4 bytes--><----4bytes---------->`.'."\n" ."\n\n" .'>All checksums are CRC32. All integers in a frame are encoded in big endian. The current Version is 1.', 'type' => 'string', 'format' => 'binary', 'example' => '无', 'title' => ''], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\"无\\"","type":"json"}]', 'title' => 'Execute an SQL statement on an object and return the result', 'description' => '- This operation requires read permissions on the object.'."\n" .'- If the operation is successful, the API returns HTTP status code 206. If the SQL statement is incorrect or does not match the object, HTTP status code 400 is returned.'."\n" .'- For more information about SelectObject, see [Use SelectObject to query objects](~~106082~~).', 'changeSet' => [ ['createdAt' => '2025-03-04T06:20:03.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObjectTagging'], ], ], ], 'translator' => 'machine', ], 'StartDataLakeCachePrefetchJob' => [ 'summary' => 'Start an asynchronous prefetch job for the OSS accelerator', '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' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => ''], ], [ 'name' => 'x-oss-datalake-job-id', 'in' => 'query', 'schema' => ['title' => '', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [ ['createdAt' => '2025-04-08T10:59:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:StartDataLakeCachePrefetchJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '', 'translator' => 'machine', ], 'UpdateBucketAntiDDosInfo' => [ 'summary' => 'Updates the protection status 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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", 'title' => ''], ], [ 'name' => 'x-oss-defender-instance', 'in' => 'header', 'schema' => ['description' => 'The Anti-DDoS instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', 'title' => ''], ], [ 'name' => 'x-oss-defender-status', 'in' => 'header', 'schema' => ['description' => 'The status of the Anti-DDoS instance to update. Valid values:'."\n" ."\n" .'- Init: Initializes the protection status. In instance status, you must specify the custom domain name to be protected.'."\n" ."\n" .'- Defending: Protection is active. In instance status, specifying the custom domain name to be protected is optional.'."\n" ."\n" .'- HaltDefending: Removes the protection status. In instance status, you do not need to specify the custom domain name to be protected.', 'type' => 'string', 'required' => true, 'example' => 'Init', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => 'The request body that contains the Anti-DDoS instance configuration.', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => ['description' => 'The container that stores the Anti-DDoS instance configuration.', '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Update bucket protection status', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:UpdateBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UpdateUserAntiDDosInfo' => [ 'summary' => 'Changes the instance status of an OSS DDoS protection 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 instance ID of the Anti-DDoS instance.', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', 'title' => ''], ], [ 'name' => 'x-oss-defender-status', 'in' => 'header', 'schema' => ['description' => 'The instance status to which you want to change the OSS DDoS protection instance. Valid values:'."\n" ."\n" .'- HaltDefending: disables protection.', 'type' => 'string', 'required' => true, 'example' => 'HaltDefending', 'title' => ''], ], ], 'responses' => [ 200 => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Change the instance status of an OSS DDoS protection instance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:UpdateUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UploadPart' => [ 'summary' => 'Uploads data in parts based on a specified object name and upload ID.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'partNumber', 'in' => 'query', 'schema' => ['description' => 'The number that identifies each uploaded part (partNumber).'."\n" ."\n" .'Valid values: 1 to 10000.'."\n" ."\n" .'The size of a single part is limited to 100 KB to 5 GB.'."\n" .'> In a multipart upload event, all parts except the last part must be greater than or equal to 100 KB. Because it is uncertain whether a part is the last one, the UploadPart operation does not immediately validate the size of the uploaded part. The size is validated only when CompleteMultipartUpload is called.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => ['description' => 'The upload ID that uniquely identifies which object the uploaded part belongs to.', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6EC98E36', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request body.', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', 'title' => ''], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => 'Upload part data', 'description' => '- Before calling the UploadPart operation to upload part data, you must first call the InitiateMultipartUpload operation to obtain the upload ID generated by the OSS server.'."\n" ."\n" .'- If you upload new data with the same part number, the existing part data corresponding to that part number in OSS is overwritten.'."\n" ."\n" .'- OSS returns the MD5 hash of the part data received by the server in the ETag header.'."\n" ."\n" .'- If you specified the x-oss-server-side-encryption request header when calling the InitiateMultipartUpload operation, the uploaded part is encrypted. The x-oss-server-side-encryption header is returned in the UploadPart response header, and its value indicates the server-side encryption algorithm used for the part. For more information, see [InitiateMultipartUpload](~~31992~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject'], ], ], ], 'translator' => 'machine', ], 'UploadPartCopy' => [ 'summary' => 'Copies data from an existing object to upload a part.', '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 bucket name.', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', 'title' => ''], ], [ 'name' => 'key', 'in' => 'path', 'schema' => ['description' => 'The full path of the object.', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', 'title' => ''], ], [ 'name' => 'x-oss-copy-source', 'in' => 'header', 'schema' => ['description' => 'The address of the copy source. You must have read permissions on the source object.', 'type' => 'string', 'required' => true, 'example' => '/oss-example/ src-object', 'title' => ''], ], [ 'name' => 'partNumber', 'in' => 'query', 'schema' => ['description' => 'The number that identifies the uploaded part (partNumber).'."\n" ."\n" .'Valid values: 1 to 10000.'."\n" ."\n" .'The size of a single part ranges from 100 KB to 5 GB.'."\n" .'> In a multipart upload event, all parts except the last part must be greater than or equal to 100 KB. Because it is uncertain whether a part is the last part, the UploadPart operation does not immediately verify the size of the uploaded part. The size is verified only when CompleteMultipartUpload is called.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => ['description' => 'The upload ID that uniquely identifies the object to which the uploaded part belongs.', 'type' => 'string', 'required' => true, 'example' => '0004B999EF5A239BB9138C6227D69F95', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-range', 'in' => 'header', 'schema' => ['description' => 'The byte range of the source object to copy. For example, if you set this parameter to bytes=0~9, the first 10 bytes (byte 0 through byte 9) are copied.'."\n" .'Default value: null.'."\n" .' - If you do not specify this request header, the entire source object is copied.'."\n" .' - If you specify this request header, the response message includes the total length of the file and the copy range. Example: Content-Range: bytes 0~9/44, which indicates that the total file length is 44 and the copy range is byte 0 through byte 9.'."\n" .' - If the specified range does not conform to the specification, the entire source object is copied and Content-Range is not included in the response.', 'type' => 'string', 'required' => false, 'example' => 'bytes=100-6291756', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-match', 'in' => 'header', 'schema' => ['description' => 'If the ETag value of the source object matches the ETag value provided by the user, the copy operation is performed. Otherwise, HTTP error code 412 (Precondition Failed) is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-none-match', 'in' => 'header', 'schema' => ['description' => 'If the ETag value provided does not match the ETag of the object, the file is transferred normally and 200 OK is returned. Otherwise, 304 Not Modified is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-unmodified-since', 'in' => 'header', 'schema' => ['description' => 'If the time specified in the parameter is equal to or later than the actual modification time of the file, the file is transferred normally and 200 OK is returned. Otherwise, 412 Precondition Failed is returned.'."\n" .'Default value: null.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Oct 2015 14:47:53 GMT', 'title' => ''], ], [ 'name' => 'x-oss-copy-source-if-modified-since', 'in' => 'header', 'schema' => ['description' => 'If the specified time is earlier than the actual modification time, the file is transferred normally and 200 OK is returned. Otherwise, 304 Not Modified is returned.'."\n" .'Default value: null.'."\n" .'Time format: GMT. Example: Fri, 13 Nov 2015 14:47:53 GMT.', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-copy-source-version-id' => [ 'schema' => ['type' => 'string'], ], ], 'schema' => [ 'description' => 'The response body of the UploadPartCopy request.', 'type' => 'object', 'properties' => [ 'CopyPartResult' => [ 'description' => 'The container that stores the UploadPartCopy result.', 'type' => 'object', 'properties' => [ 'LastModified' => ['description' => 'The time when the object was last modified.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2014-07-17T06:27:54.000Z', 'title' => ''], 'ETag' => ['description' => 'The ETag value of the copied object.', 'type' => 'string', 'example' => '"5B3C1A2E053D763E1B002CC607C5****"', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 2014-07-17T06:27:54.000Z\\n \\"5B3C1A2E053D763E1B002CC607C5****\\"\\n","type":"xml"}]', 'title' => 'Copy data to upload a part', 'description' => 'This operation calls the UploadPartCopy API by adding the x-oss-copy-source request header to an UploadPart request. This copies data from an existing object to upload a part.'."\n" ."\n" .'**Usage notes**'."\n" .'
To copy an object larger than 1 GB, you must use UploadPartCopy. To copy an object smaller than 1 GB in a single operation, see [CopyObject](https://help.aliyun.com/document_detail/31979.htm?spm=a2c4g.11186623.0.0.49aa29d6oRCP8o#t4696.html).'."\n" .'
When you use the UploadPartCopy operation, take note of the following items:'."\n" ."\n" .'- You cannot copy objects uploaded by using AppendObject.'."\n" ."\n" .'- The source bucket and destination bucket of the UploadPartCopy operation must be in the same region.'."\n" ."\n" .'- Before you call this operation to upload part data, you must call the InitiateMultipartUpload operation to obtain an upload ID issued by the OSS server.'."\n" ."\n" .'- If you specify the x-oss-server-side-encryption request header when you call the InitiateMultipartUpload operation, the uploaded part is encrypted. The UploadPart response header returns x-oss-server-side-encryption, whose value indicates the server-side encryption algorithm of the part. For more information, see [InitiateMultipartUpload](~~31992~~).'."\n" ."\n" .'- A multipart upload requires that all parts except the last part are larger than 100 KB. Because it is uncertain whether a part is the last part, the UploadPart operation does not immediately verify the size of the uploaded part. The size is verified only when CompleteMultipartUpload is called.'."\n" ."\n" .'**Versioning**.'."\n" ."\n" .'By default, UploadPartCopy copies data from the current version of an existing object to upload a part. You can add the versionId subcondition to the x-oss-copy-source request header to copy data from a specific version of the object. Example: x-oss-copy-source : /SourceBucketName/SourceObjectName?versionId=111111.'."\n" .'>SourceObjectName must be URL-encoded. The response returns the versionId of the copied object: x-oss-copy-source-version-id.'."\n" ."\n" .'If versionId is not specified and the current version of the object is a delete marker, OSS returns 404 Not Found. If you specify a versionId to copy a delete marker, OSS returns 400 Bad Request.', 'changeSet' => [ ['createdAt' => '2024-02-21T14:29:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], 'additionalActions' => [ ['action' => 'oss:GetObject', 'validationType' => 'always'], ['action' => 'oss:GetObjectVersion'], ], ], ], 'translator' => 'machine', ], ], 'endpoints' => [ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-northeast-1.aliyuncs.com', 'endpoint' => 'oss-ap-northeast-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-northeast-2.aliyuncs.com', 'endpoint' => 'oss-ap-northeast-2.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-1.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-2.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-2.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-3.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-3.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-5.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-5.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-6.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-6.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-ap-southeast-7.aliyuncs.com', 'endpoint' => 'oss-ap-southeast-7.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-beijing.aliyuncs.com', 'endpoint' => 'oss-cn-beijing.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-chengdu.aliyuncs.com', 'endpoint' => 'oss-cn-chengdu.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-fuzhou.aliyuncs.com', 'endpoint' => 'oss-cn-fuzhou.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-guangzhou.aliyuncs.com', 'endpoint' => 'oss-cn-guangzhou.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-hangzhou.aliyuncs.com', 'endpoint' => 'oss-cn-hangzhou.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-heyuan.aliyuncs.com', 'endpoint' => 'oss-cn-heyuan.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-hongkong.aliyuncs.com', 'endpoint' => 'oss-cn-hongkong.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-huhehaote.aliyuncs.com', 'endpoint' => 'oss-cn-huhehaote.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-nanjing.aliyuncs.com', 'endpoint' => 'oss-cn-nanjing.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-qingdao.aliyuncs.com', 'endpoint' => 'oss-cn-qingdao.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-shanghai.aliyuncs.com', 'endpoint' => 'oss-cn-shanghai.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-shenzhen.aliyuncs.com', 'endpoint' => 'oss-cn-shenzhen.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'oss-cn-wuhan-lr.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-wulanchabu.aliyuncs.com', 'endpoint' => 'oss-cn-wulanchabu.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'oss-cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'oss-cn-zhangjiakou.aliyuncs.com', 'vpc' => ''], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oss-us-west-1.aliyuncs.com', 'endpoint' => 'oss-us-west-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oss-us-east-1.aliyuncs.com', 'endpoint' => 'oss-us-east-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oss-eu-west-1.aliyuncs.com', 'endpoint' => 'oss-eu-west-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'oss-eu-central-1.aliyuncs.com', 'endpoint' => 'oss-eu-central-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'oss-me-east-1.aliyuncs.com', 'endpoint' => 'oss-me-east-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'oss-ap-south-1.aliyuncs.com', 'endpoint' => 'oss-ap-south-1.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oss-cn-shenzhen-finance-1-internal.aliyuncs.com', 'endpoint' => 'oss-cn-shenzhen-finance-1-internal.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oss-cn-shanghai-finance-1-internal.aliyuncs.com', 'endpoint' => 'oss-cn-shanghai-finance-1-internal.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oss-cn-hzjbp-b-console.aliyuncs.com', 'endpoint' => 'oss-cn-hzjbp-b-console.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'oss-cn-beijing-finance-1-internal.aliyuncs.com', 'endpoint' => 'oss-cn-beijing-finance-1-internal.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'AbnormalBucketOwnerStatus', 'message' => null, 'http_code' => null, 'description' => 'An account status exception occurred. Account fees may be overdue.'], ['code' => 'AccessDenied', 'message' => null, 'http_code' => null, 'description' => 'There is no corresponding access rights.'], ['code' => 'AccessForbidden', 'message' => null, 'http_code' => null, 'description' => 'Access is forbidden.'], ['code' => 'aclAccessDenied', 'message' => null, 'http_code' => null, 'description' => 'You are not authorized to GetBucketAcl. Request for GetBucketAcl authorization and try again .'], ['code' => 'AclNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'ACL cannot be empty.'], ['code' => 'AllowedHeaderMoreThanOneAsterisk', 'message' => null, 'http_code' => null, 'description' => 'Only one asterisk (*) is allowed per AllowedHeader origin.'], ['code' => 'AllowedMethodNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'AllowedMethod cannot be empty.'], ['code' => 'AllowedOriginMoreThanOneAsterisk', 'message' => null, 'http_code' => null, 'description' => 'Only one asterisk (*) is allowed per AllowedOrigin origin.'], ['code' => 'AllowedOriginNotAllowEmpty', 'message' => null, 'http_code' => null, 'description' => 'AlowedOrigin cannot be empty.'], ['code' => 'BadParamters', 'message' => null, 'http_code' => null, 'description' => 'The specified parameter is invalid.'], ['code' => 'BindDomainInRiskControlBlackList', 'message' => null, 'http_code' => null, 'description' => 'This domain is currently protected and cannot be bound.'], ['code' => 'BindDomainMustAliyunJoinUp', 'message' => null, 'http_code' => null, 'description' => 'Domain names not recorded by or joined to Alibaba Cloud cannot be bound.'], ['code' => 'BindDomainNoHaveIcpNo', 'message' => null, 'http_code' => null, 'description' => 'This domain name has not been registered and it cannot be bound to this bucket. Register the domain name and try again.'], ['code' => 'BindDomainNotAllowedContainsChinese', 'message' => null, 'http_code' => null, 'description' => 'Binding of Chinese language domain names is not supported. You can bind only English language domain names.'], ['code' => 'BindedBucketCNameDeleteFail', 'message' => null, 'http_code' => null, 'description' => 'Deletion of the bound domain name failed. Please try again.'], ['code' => 'BucketAlreadyExists', 'message' => null, 'http_code' => null, 'description' => 'This bucket already exists or is in use by other users.'], ['code' => 'BucketAlreadyExists', 'message' => 'The requested bucket name is not available.', 'http_code' => null, 'description' => 'The specified Bucket already exists or is in use by another user.'], ['code' => 'BucketAlreadyHasReplicationConfiguration', 'message' => null, 'http_code' => null, 'description' => 'The target bucket already has replication configuration. Choose another bucket.'], ['code' => 'BucketCorsRuleAlreadyExist', 'message' => null, 'http_code' => null, 'description' => 'The specified CORS rule already exists.'], ['code' => 'BucketDisable', 'message' => null, 'http_code' => null, 'description' => 'Bucket disabled.'], ['code' => 'BucketMetaIsNull', 'message' => null, 'http_code' => null, 'description' => 'This bucket has no metadata.'], ['code' => 'BucketNameNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'BucketName cannot be empty.'], ['code' => 'BucketNotBelongTo', 'message' => null, 'http_code' => null, 'description' => 'This bucket belongs to another user.'], ['code' => 'BucketNotEmpty', 'message' => null, 'http_code' => null, 'description' => 'This bucket is not empty. Check whether this bucket contains undeleted objects or multipart fragments.'], ['code' => 'BucketReplicationAlreadyExist', 'message' => null, 'http_code' => null, 'description' => 'The specified Bucket has enabled cross zone data replication.'], ['code' => 'CachedTimeTooLarge', 'message' => null, 'http_code' => null, 'description' => 'The cached time is too large.'], ['code' => 'CallbackFailed', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'CannotGenerateValidateFile', 'message' => null, 'http_code' => null, 'description' => 'The checksum file cannot be downloaded.'], ['code' => 'CapacityOverLimit', 'message' => null, 'http_code' => null, 'description' => 'The data write capacity exceeds the limit.'], ['code' => 'cdnRefreshError', 'message' => null, 'http_code' => null, 'description' => 'The CDN cache refresh failed. The URLs may be wrong, or the refresh limit may be reached. Try again later.'], ['code' => 'CNameAlreadyBindedByOtherUser', 'message' => null, 'http_code' => null, 'description' => 'This domain name has already been bound. Enter another domain name and try again.'], ['code' => 'CNameNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The bound domain name cannot be empty.'], ['code' => 'CNameRecordNotExist', 'message' => null, 'http_code' => null, 'description' => 'This record does not exist. Check the query parameters and try again.'], ['code' => 'CNameStatusNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The bound domain name status cannot be empty.'], ['code' => 'codeTypeNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'Enter risk management type.'], ['code' => 'ConfigurationConflict', 'message' => null, 'http_code' => null, 'description' => 'Configuration conflict.'], ['code' => 'ConnectionRefused', 'message' => null, 'http_code' => null, 'description' => 'Connection Refused'], ['code' => 'ConnectionTimeout', 'message' => null, 'http_code' => null, 'description' => 'Connection Timeout'], ['code' => 'ConsoleCommonErrorInvokeAkException', 'message' => null, 'http_code' => null, 'description' => 'An exception occurred in AccessKeys acquisition.'], ['code' => 'ConsoleCommonErrorNoEnabledKeys', 'message' => null, 'http_code' => null, 'description' => 'No enabled keys. 'ConsoleCommonErrorUserDisabled', 'message' => null, 'http_code' => null, 'description' => 'The OSS service has been disabled. 'ConsoleCommonErrorUserNotFound', 'message' => null, 'http_code' => null, 'description' => 'The OSS service has not been activated yet. 'ConsoleCommonErrorUserServiceException', 'message' => null, 'http_code' => null, 'description' => 'An exception has occurred in the OSS service status. Contact customer services. 'ConsoleNeedLogin', 'message' => null, 'http_code' => null, 'description' => 'This request is unsuccessful. Please try again. 'ConsoleServiceNotSupport', 'message' => null, 'http_code' => null, 'description' => 'An associated template or module cannot be found.'], ['code' => 'ConsoleSysError', 'message' => null, 'http_code' => null, 'description' => 'This request was unsuccessful. Please refresh and retry.'], ['code' => 'CORSRuleBeyondLimit', 'message' => null, 'http_code' => null, 'description' => 'The number of CORS rules exceeds the limit.'], ['code' => 'CORSRuleIdNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The CORS rule ID cannot be empty.'], ['code' => 'CreateAccesskeysFailed', 'message' => null, 'http_code' => null, 'description' => 'accessKey creation failed.'], ['code' => 'Default', 'message' => null, 'http_code' => null, 'description' => 'An error has occurred with the request. Please try again later.'], ['code' => 'DeletingPartIsNull', 'message' => null, 'http_code' => null, 'description' => 'The batch deletion of objects failed.'], ['code' => 'DisallowEmptyReferNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'DisallowEmptyRefer cannot be empty.'], ['code' => 'DomainAlreadyBindedOtherBucket', 'message' => null, 'http_code' => null, 'description' => 'Other users have already bound this domain name to bucket(%s). Switch to another domain name to bind.'], ['code' => 'DomainAlreadyExist', 'message' => null, 'http_code' => null, 'description' => 'The domain name already exists in the CDN. Delete the domain name in the CDN and bind it again.'], ['code' => 'DomainIdNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'domainId cannot be empty.'], ['code' => 'domainInCdn', 'message' => null, 'http_code' => null, 'description' => 'This domain name exists on the CDN service. Change the domain name and try again.'], ['code' => 'DomainLengthMoreThanAllowed', 'message' => null, 'http_code' => null, 'description' => 'This domain name exceeds the limit. Domain names must be between 3-63 characters long.'], ['code' => 'DomainNetWorkVisitedException', 'message' => null, 'http_code' => null, 'description' => 'An exception occurred in the domain name network access.'], ['code' => 'DomainNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The domain name cannot be empty.'], ['code' => 'DomainNotJoinUpByAliyun', 'message' => null, 'http_code' => null, 'description' => 'Domains that are not recorded by or joined to Alibaba Cloud cannot be bound to top-level domain names.'], ['code' => 'DomainValidateFileContentNotMatch', 'message' => null, 'http_code' => null, 'description' => 'The content of the domain name verification file does not match.'], ['code' => 'DomainValidateFileNotExist', 'message' => null, 'http_code' => null, 'description' => 'This domain name verification file does not exist.'], ['code' => 'DomainValidateFileVisitedException', 'message' => null, 'http_code' => null, 'description' => 'An exception occurred in access to the domain name verification file network.'], ['code' => 'DownloadTrafficRateLimitExceeded', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'DubboServiceInvokeError', 'message' => null, 'http_code' => null, 'description' => 'Remote call service failed.'], ['code' => 'EndpointInvalid', 'message' => null, 'http_code' => null, 'description' => 'This Endpoint HTTP address is invalid. Use of an internal IP is forbidden.'], ['code' => 'EntityTooLarge', 'message' => null, 'http_code' => null, 'description' => 'This entity is too large.'], ['code' => 'EntityTooSmall', 'message' => null, 'http_code' => null, 'description' => 'This entity is too small.'], ['code' => 'ExpireDaysRuleMaxMoreThanZero', 'message' => null, 'http_code' => null, 'description' => 'The days overdue must be greater than 0.'], ['code' => 'ExpireTimeMustLessThanTenYears', 'message' => null, 'http_code' => null, 'description' => 'The expiration time cannot exceed 10 years.'], ['code' => 'ExpireTimeMustOverThanOneSecond', 'message' => null, 'http_code' => null, 'description' => 'The expiration time must be over 1 second.'], ['code' => 'ExpireTimeNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The expiration time of signing url cannot be empty.'], ['code' => 'FetchCacheDataError', 'message' => null, 'http_code' => null, 'description' => 'Failed to fetch data from cache.'], ['code' => 'FieldItemTooLong', 'message' => null, 'http_code' => null, 'description' => 'The form field in Post request is too long.'], ['code' => 'fileContentError', 'message' => null, 'http_code' => null, 'description' => 'The file content is invalid. Please try again.'], ['code' => 'FileGroupTooLarge', 'message' => null, 'http_code' => null, 'description' => 'This file group is too large.'], ['code' => 'FilePartInterity', 'message' => null, 'http_code' => null, 'description' => 'This file part has changed.'], ['code' => 'FilePartNotExist', 'message' => null, 'http_code' => null, 'description' => 'This file part does not exist.'], ['code' => 'FilePartStale', 'message' => null, 'http_code' => null, 'description' => 'This file part is stale.'], ['code' => 'fileUploadFailed', 'message' => null, 'http_code' => null, 'description' => 'This file failed to upload. Please try again.'], ['code' => 'FolderDeletedFail', 'message' => null, 'http_code' => null, 'description' => 'The deletion of the virtual folder failed.'], ['code' => 'FolderDeleting', 'message' => null, 'http_code' => null, 'description' => 'The specified folder is being deleted. Please wait…'], ['code' => 'ForbidRedirect', 'message' => null, 'http_code' => null, 'description' => 'This bucket node location information is incorrect.'], ['code' => 'GetBucketListFailed', 'message' => null, 'http_code' => null, 'description' => 'The acquisition of the bucket list failed.'], ['code' => 'GetServiceDenied', 'message' => null, 'http_code' => null, 'description' => 'You do not have operation authorization for the GetService gateway.'], ['code' => 'GetSignUrlException', 'message' => null, 'http_code' => null, 'description' => 'The retrieval of the signature URL encountered an exception.'], ['code' => 'IlegalDomain', 'message' => null, 'http_code' => null, 'description' => '(%s) is an invalid domain name. Input a valid domain name.'], ['code' => 'IllegalLocationConstraintException', 'message' => null, 'http_code' => null, 'description' => 'The location information and endpoint do not match.'], ['code' => 'IllegalOperation', 'message' => null, 'http_code' => null, 'description' => 'Invalid domain. Operation is not permitted.'], ['code' => 'ImageStyleNameError', 'message' => null, 'http_code' => null, 'description' => 'Image style name error. The image style name can only contain alphanumeric characters, underscores (_), hyphens (-) and periods (.). Length must be between 1-63 bytes.'], ['code' => 'ImageWatermarkNeedObject', 'message' => null, 'http_code' => null, 'description' => 'The image watermark must contain an object name.'], ['code' => 'IncorrectNumberOfFilesInPOSTRequest', 'message' => null, 'http_code' => null, 'description' => 'The number of files in the Post request is invalid.'], ['code' => 'IndexFileMustBeSetted', 'message' => null, 'http_code' => null, 'description' => 'To set the error page, it is mandatory to set the default home page.'], ['code' => 'InitContextError', 'message' => null, 'http_code' => null, 'description' => 'Context initialization failed.'], ['code' => 'InitOMSFailed', 'message' => null, 'http_code' => null, 'description' => 'OMS initialization failed.'], ['code' => 'InsertDomainDataFail', 'message' => null, 'http_code' => null, 'description' => 'Domain name binding data failed to write. Please try again.'], ['code' => 'InternalError', 'message' => null, 'http_code' => null, 'description' => 'The server is busy. Please try again.'], ['code' => 'InvalidAccessKeyId', 'message' => null, 'http_code' => null, 'description' => 'The AccessId is invalid.'], ['code' => 'InvalidAllowedOriginOrMehotd', 'message' => null, 'http_code' => null, 'description' => 'The request origin or request method cannot be empty.'], ['code' => 'InvalidArgument', 'message' => null, 'http_code' => null, 'description' => 'Parameter format error.'], ['code' => 'InvalidBindBucketName', 'message' => null, 'http_code' => null, 'description' => 'This bucket name contains underscores (_). It cannot be used as an OSS level three domain name.'], ['code' => 'InvalidBucketAclParamter', 'message' => null, 'http_code' => null, 'description' => 'Acl is invalid, can only select from [private,public-read,public-read-write]'], ['code' => 'InvalidBucketLocationParamter', 'message' => null, 'http_code' => null, 'description' => 'This location information is incorrect.'], ['code' => 'InvalidBucketName', 'message' => null, 'http_code' => null, 'description' => 'This bucket name is invalid.'], ['code' => 'InvalidBucketName', 'message' => 'The specified bucket is not valid.', 'http_code' => null, 'description' => 'This bucket name is invalid.'], ['code' => 'InvalidBucketOwner', 'message' => null, 'http_code' => null, 'description' => 'You are not the owner of this bucket.'], ['code' => 'InvalidBuckets', 'message' => null, 'http_code' => null, 'description' => 'Bucket list acquisition failed.'], ['code' => 'InvalidDigest', 'message' => null, 'http_code' => null, 'description' => 'Invalid digest'], ['code' => 'InvalidDomain', 'message' => null, 'http_code' => null, 'description' => 'The rules for naming domains are invalid. Enter a valid domain name.'], ['code' => 'InvalidDomain.Configure_failed', 'message' => null, 'http_code' => null, 'description' => 'The configuration of the provided domain failed. Unable to refresh.'], ['code' => 'InvalidDomain.NotFound', 'message' => null, 'http_code' => null, 'description' => 'This domain does not exist or does not belong to the current user.'], ['code' => 'InvalidDomain.Offline', 'message' => null, 'http_code' => null, 'description' => 'This domain is offline.'], ['code' => 'InvalidDomainName.Format', 'message' => null, 'http_code' => null, 'description' => 'Domain name format error'], ['code' => 'InvalidDomainSuffix', 'message' => null, 'http_code' => null, 'description' => 'This domain name suffix is invalid. Use a valid domain name suffix.'], ['code' => 'InvalidEncryptionAlgorithmError', 'message' => null, 'http_code' => null, 'description' => 'Invalid signature algorithm'], ['code' => 'InvalidHostPutBucket', 'message' => null, 'http_code' => null, 'description' => 'Invalid host'], ['code' => 'InvalidLifeCycleStatusParameters', 'message' => null, 'http_code' => null, 'description' => 'This status content is invalid. Status can only be either Enabled or Disabled. There is a strict distinction between uppercase and lowercase letters.'], ['code' => 'InvalidLinkName', 'message' => null, 'http_code' => null, 'description' => 'The object link has the same name as the object referred to.'], ['code' => 'InvalidLocationConstraint', 'message' => null, 'http_code' => null, 'description' => 'This location information is incorrect.'], ['code' => 'InvalidObjectName', 'message' => null, 'http_code' => null, 'description' => 'This object name is invalid.'], ['code' => 'InvalidObjectPath.Malformed', 'message' => null, 'http_code' => null, 'description' => 'This specified value of the ObjectPath parameter is malformed. Check and try again.'], ['code' => 'InvalidObjectType.ValueNotSupported', 'message' => null, 'http_code' => null, 'description' => 'This specified value of ObjectType is not supported. Check and try again.'], ['code' => 'InvalidOCMResponse', 'message' => null, 'http_code' => null, 'description' => 'The response was in valid. Please try again.'], ['code' => 'InvalidOSSEndPoint', 'message' => null, 'http_code' => null, 'description' => 'This OSS API endpoint configuration is invalid.'], ['code' => 'InvalidParameterOfAliUid', 'message' => null, 'http_code' => null, 'description' => 'This user ID is invalid.'], ['code' => 'InvalidParameters', 'message' => null, 'http_code' => null, 'description' => 'This parameter is invalid.'], ['code' => 'InvalidPart', 'message' => null, 'http_code' => null, 'description' => 'Invalid Part'], ['code' => 'InvalidPartOrder', 'message' => null, 'http_code' => null, 'description' => 'Invalid Part Order'], ['code' => 'InvalidPolicyDocument', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'InvalidRange', 'message' => null, 'http_code' => null, 'description' => 'The specified range is invalid.'], ['code' => 'InvalidRegion', 'message' => null, 'http_code' => null, 'description' => 'Parameter Error. Region or aliUid is empty.'], ['code' => 'InvalidRequestParameters', 'message' => null, 'http_code' => null, 'description' => 'The request parameters are invalid. Check request parameters and try again.'], ['code' => 'InvalidResponse', 'message' => null, 'http_code' => null, 'description' => 'Invalid Response'], ['code' => 'InvalidRiskControlCodeType', 'message' => null, 'http_code' => null, 'description' => 'Risk control type is not set correctly'], ['code' => 'InvalidTargetBucket', 'message' => null, 'http_code' => null, 'description' => 'The target bucket does not exist.'], ['code' => 'InvalidTargetBucketForLogging', 'message' => null, 'http_code' => null, 'description' => 'The chosen bucket is invalid for logging.'], ['code' => 'InvalidTargetLocation', 'message' => null, 'http_code' => null, 'description' => 'The selected target region does not exist.'], ['code' => 'InvalidXMLFormat', 'message' => null, 'http_code' => null, 'description' => 'Invalid XML format.'], ['code' => 'InvokeAkException', 'message' => null, 'http_code' => null, 'description' => 'Failed to acquire AccessKeys.'], ['code' => 'InvokeAKServiceFailed', 'message' => null, 'http_code' => null, 'description' => 'The specified request for access key service is invalid.'], ['code' => 'InvokeLocationServiceFailed', 'message' => null, 'http_code' => null, 'description' => 'Failed to call location service.'], ['code' => 'InvokeOmsFailed', 'message' => null, 'http_code' => null, 'description' => 'Failed to acquire bucket measurement data.'], ['code' => 'lifeCyclePrefixOverlap', 'message' => null, 'http_code' => null, 'description' => 'When adding a new LifeCycle to the Bucket level, first delete other LifeCycles. When setting the lifecycle of the prefix, first ensure there are no prefix conflicts.'], ['code' => 'LifeCycleRuleIdNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'lifeCycle rule ID cannot be empty.'], ['code' => 'LifeCycleRulePrefixOverLap', 'message' => null, 'http_code' => null, 'description' => 'Prefix rules conflict.'], ['code' => 'LifeCycleStatusNotAlllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The specified LifeCycle status cannot be left blank.'], ['code' => 'LinkPartNotExist', 'message' => null, 'http_code' => null, 'description' => 'The object linked to by this object link does not exist.'], ['code' => 'LoadDataFromOmsFailed', 'message' => null, 'http_code' => null, 'description' => 'Failed to acquire report data on basic resources.'], ['code' => 'LoadDataFromOtsFailed', 'message' => null, 'http_code' => null, 'description' => 'Data acquisition failed. Please try again.'], ['code' => 'LoadingDataFail', 'message' => null, 'http_code' => null, 'description' => 'There is a high request volume. Data failed to load. Please try again later.'], ['code' => 'LoadRegionConfigError', 'message' => null, 'http_code' => null, 'description' => 'Failed to load region configuration information.'], ['code' => 'LoadReportDataFailed', 'message' => null, 'http_code' => null, 'description' => 'Failed to acquire report data. Please try again.'], ['code' => 'MalformedPOSTRequest', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'MalformedXML', 'message' => null, 'http_code' => null, 'description' => 'This XML file is malformed.'], ['code' => 'MaxPOSTPreDataLengthExceededError', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'MaxPOSTPreDataLengthExceededError', 'message' => 'Your POST request fields preceding the upload file were too large.', 'http_code' => null, 'description' => ' '], ['code' => 'MaxUplodsNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'maxUploads cannot be empty.'], ['code' => 'MethodNotAllowed', 'message' => null, 'http_code' => null, 'description' => 'This request method is not allowed.'], ['code' => 'MissingArgument', 'message' => null, 'http_code' => null, 'description' => 'A parameter is missing.'], ['code' => 'MissingContentLength', 'message' => null, 'http_code' => null, 'description' => 'The content-length parameter is missing.'], ['code' => 'MissingContentLength', 'message' => 'You must provide the Content-Length HTTP header.', 'http_code' => null, 'description' => 'The specified PostObject is missing body length. Check the PostObject request parameters and try again.'], ['code' => 'MissingInitOCMParams', 'message' => null, 'http_code' => null, 'description' => 'Enter a value for the parameters.'], ['code' => 'MissingParameter', 'message' => null, 'http_code' => null, 'description' => 'The input parameter ObjectPath that is mandatory for processing this request is not supplied. Please check and try again later.'], ['code' => 'NoAnyAccesskeys', 'message' => null, 'http_code' => null, 'description' => 'No accessKey has been created. Please 'NoDeletingItemSelected', 'message' => null, 'http_code' => null, 'description' => 'No object has been selected for deletion.'], ['code' => 'NoEnabledAccessKey', 'message' => null, 'http_code' => null, 'description' => 'No enabled access keys.'], ['code' => 'NoEnabledAKPair', 'message' => null, 'http_code' => null, 'description' => 'No enabled accessKeys.'], ['code' => 'noLocation', 'message' => null, 'http_code' => null, 'description' => 'This region is not currently available for use as a replication target region. Refer to the official announcement.'], ['code' => 'NonRepeatableRequest', 'message' => null, 'http_code' => null, 'description' => 'Do not repeat request submission.'], ['code' => 'NoOnlineRegionConfig', 'message' => null, 'http_code' => null, 'description' => 'There is no available region configuration.'], ['code' => 'NoRegionConfig', 'message' => null, 'http_code' => null, 'description' => 'There is no region configuration or region configuration is null.'], ['code' => 'NoSuchBucket', 'message' => null, 'http_code' => null, 'description' => 'This bucket does not exist.'], ['code' => 'NoSuchBucket', 'message' => 'The specified bucket does not exist.', 'http_code' => null, 'description' => 'The specified Bucket does not exist.'], ['code' => 'NoSuchChannel', 'message' => null, 'http_code' => null, 'description' => 'The specified channel does not exist.'], ['code' => 'NoSuchCname', 'message' => null, 'http_code' => null, 'description' => 'This CNAME is not available.'], ['code' => 'NoSuchCORSConfiguration', 'message' => null, 'http_code' => null, 'description' => 'CORS has not been set up for this bucket.'], ['code' => 'NoSuchKey', 'message' => null, 'http_code' => null, 'description' => 'This object does not exist.'], ['code' => 'NoSuchLifecycle', 'message' => null, 'http_code' => null, 'description' => 'LifeCycle has not been set up for this bucket.'], ['code' => 'NoSuchQuota', 'message' => null, 'http_code' => null, 'description' => 'This quota information is not available.'], ['code' => 'NoSuchReplicationRule', 'message' => null, 'http_code' => null, 'description' => 'This replication rule does not exist.'], ['code' => 'NoSuchRule', 'message' => null, 'http_code' => null, 'description' => 'This rule does not exist.'], ['code' => 'NoSuchStyle', 'message' => null, 'http_code' => null, 'description' => 'This style does not exist.'], ['code' => 'NoSuchUpload', 'message' => null, 'http_code' => null, 'description' => 'This multipart upload ID does not exist.'], ['code' => 'NoSuchUser', 'message' => null, 'http_code' => null, 'description' => 'This user does not exist.'], ['code' => 'NoSuchWebsiteConfiguration', 'message' => null, 'http_code' => null, 'description' => 'This website has not been configured on the bucket.'], ['code' => 'NotAllowedContainsAsterisk', 'message' => null, 'http_code' => null, 'description' => 'Asterisks (*) are not allowed in the response header of the ExposeHeader application.'], ['code' => 'NotAllowedSetAllBucketLifeCycle', 'message' => null, 'http_code' => null, 'description' => 'A LifeCycle already exists. Void it and add a bucket level LifeCycle again.'], ['code' => 'NotAllowedWebSiteRule', 'message' => null, 'http_code' => null, 'description' => 'This default home page or 404 page is invalid. Names must be between 1-63 alphanumeric characters and end in htm(l) or be left empty.'], ['code' => 'NotImplemented', 'message' => null, 'http_code' => null, 'description' => 'This request method has not been implemented.'], ['code' => 'NotModified', 'message' => null, 'http_code' => null, 'description' => 'Not Modified'], ['code' => 'NotSupportImageService', 'message' => null, 'http_code' => null, 'description' => 'This region does not currently support Image Processing. The release of Image Processing will be announced when available.'], ['code' => 'ObjectLinkTooLarge', 'message' => null, 'http_code' => null, 'description' => 'There are too many objects in the object link.'], ['code' => 'ObjectNameNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'ObjectName cannot be empty.'], ['code' => 'ObjectNotAppendable', 'message' => null, 'http_code' => null, 'description' => 'This object is not appendable.'], ['code' => 'OccurException', 'message' => null, 'http_code' => null, 'description' => 'An exception occurred.'], ['code' => 'OccurIOException', 'message' => null, 'http_code' => null, 'description' => 'An IO exception occurred.'], ['code' => 'OperateObjectsNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The object in operation cannot be empty. Please select the corresponding object.'], ['code' => 'OperationDenied', 'message' => null, 'http_code' => null, 'description' => 'This account is not running CDN service, or service is suspended.'], ['code' => 'OSSRegionParseFalse', 'message' => null, 'http_code' => null, 'description' => 'There is no valid region configuration.'], ['code' => 'OSSServiceDisabled', 'message' => null, 'http_code' => null, 'description' => 'This service has been disabled. Charges may be overdue or this bucket may contain prohibited content.'], ['code' => 'OSSServiceNoSuchUser', 'message' => null, 'http_code' => null, 'description' => 'The OSS service has not been activated. Activate the OSS service.'], ['code' => 'OSS_CONSOLE_BUCKET_NOT_EXIST', 'message' => null, 'http_code' => null, 'description' => 'This bucket does not exist.'], ['code' => 'OSS_CONSOLE_DOMAIN_BIND_BY_CURRENT', 'message' => null, 'http_code' => null, 'description' => 'The domain name has been bound to the current bucket.'], ['code' => 'OSS_CONSOLE_DOMAIN_BIND_BY_CURRENT_IMG', 'message' => null, 'http_code' => null, 'description' => 'The domain name has already been bound to the image processing of the current bucket.'], ['code' => 'OSS_CONSOLE_DOMAIN_BIND_BY_OTHER', 'message' => null, 'http_code' => null, 'description' => 'The specified domain name is already bound to another user\'s bucket.'], ['code' => 'OSS_CONSOLE_DOMAIN_BIND_BY_SELF', 'message' => null, 'http_code' => null, 'description' => 'This domain name is currently bound to another of your buckets. Each domain name can only be bound to a single bucket.'], ['code' => 'OSS_CONSOLE_FORBIDDEN_DOMAIN', 'message' => null, 'http_code' => null, 'description' => 'This domain name cannot be bound on OSS.'], ['code' => 'OSS_CONSOLE_ICP_NOT_EXIST', 'message' => null, 'http_code' => null, 'description' => 'This domain name is not on record.'], ['code' => 'OSS_CONSOLE_ICP_NOT_HICHINA', 'message' => null, 'http_code' => null, 'description' => 'This domain name is not on record with Alibaba Cloud.'], ['code' => 'OSS_STATUS_NULL', 'message' => null, 'http_code' => null, 'description' => 'Failed to acquire the status of the connection. Please try again.'], ['code' => 'OtherUserAlreadyBindDomain', 'message' => null, 'http_code' => null, 'description' => 'This domain name is currently bound by another user. Please use a different domain name.'], ['code' => 'OutOfDomainIdRange', 'message' => null, 'http_code' => null, 'description' => 'The domainId is out of range. The domainId range is [1,Long.MAX_VALUE].'], ['code' => 'OutOfMaxKeysRange', 'message' => null, 'http_code' => null, 'description' => 'Number of objects returned each time is out of range. The range is [1,1000].'], ['code' => 'OutOfMaxRetRange', 'message' => null, 'http_code' => null, 'description' => 'The maximum number of return results is out of range. The range is [1,500].'], ['code' => 'OutOfMaxUploadsRange', 'message' => null, 'http_code' => null, 'description' => 'The number of uploads returned each time is out of range. The range is [1,1000]'], ['code' => 'OVER_DOMAIN_MAX_NUM', 'message' => null, 'http_code' => null, 'description' => 'You cannot bind more domain names for this bucket.'], ['code' => 'ParameterParserIsNull', 'message' => null, 'http_code' => null, 'description' => 'The ParameterParser is null.'], ['code' => 'ParamsEndTimeNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The end time cannot be empty.'], ['code' => 'ParamsMaxRetNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The maximum return results cannot be empty.'], ['code' => 'ParamsSelectNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'Enter search keywords'], ['code' => 'ParamsStartTimeNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The start time cannot be empty.'], ['code' => 'ParseCacheDataError', 'message' => null, 'http_code' => null, 'description' => 'The conversion of cache data failed.'], ['code' => 'PermanentRedirect', 'message' => null, 'http_code' => null, 'description' => 'This endpoint information does not match. Please confirm the corresponding endpoint information for this bucket.'], ['code' => 'PositionNotEqualToLength', 'message' => null, 'http_code' => null, 'description' => 'The position is not equal to the length.'], ['code' => 'PostOnly', 'message' => null, 'http_code' => null, 'description' => 'Invalid request mode. This request only allows POST mode.'], ['code' => 'PreconditionFailed', 'message' => null, 'http_code' => null, 'description' => 'Precondition error'], ['code' => 'QueryBAIcpNoFail', 'message' => null, 'http_code' => null, 'description' => 'This query request for registration information from the domain name query registration system of the Alibaba Cloud Authority failed. Please try again.'], ['code' => 'QueryCNameDataFail', 'message' => null, 'http_code' => null, 'description' => 'This data query failed. Please try again.'], ['code' => 'QuotaExceeded.Refresh', 'message' => null, 'http_code' => null, 'description' => 'You cannot refresh more. Try again later.'], ['code' => 'RC_ErrorParameter', 'message' => null, 'http_code' => null, 'description' => 'This parameter value is incorrect.'], ['code' => 'RC_InvalidUser', 'message' => null, 'http_code' => null, 'description' => 'This user does not exist.'], ['code' => 'RC_MissingParameter', 'message' => null, 'http_code' => null, 'description' => 'This parameter request failed.'], ['code' => 'RC_SendMessageFail', 'message' => null, 'http_code' => null, 'description' => 'This text message failed to send.'], ['code' => 'RC_SendVerifyCodeExceedingMax', 'message' => null, 'http_code' => null, 'description' => 'You cannot send more verification codes.'], ['code' => 'RC_TimeIntervalError', 'message' => null, 'http_code' => null, 'description' => 'The interval between sending each verification code cannot be less than 60 seconds.'], ['code' => 'RC_ValidateVerifyCodeExceedingMax', 'message' => null, 'http_code' => null, 'description' => 'The limit for the use of a single verification code being used has been reached.'], ['code' => 'RC_VerifyCodeError', 'message' => null, 'http_code' => null, 'description' => 'Verification code error'], ['code' => 'ReBindBucketCNameFail', 'message' => null, 'http_code' => null, 'description' => 'Domain binding failed. Please try again.'], ['code' => 'RegionConfigIsNull', 'message' => null, 'http_code' => null, 'description' => 'The region configuration list is null.'], ['code' => 'RegionNotExistInConfig', 'message' => null, 'http_code' => null, 'description' => 'The specified region does not exist.'], ['code' => 'RegionNotMatched', 'message' => null, 'http_code' => null, 'description' => 'This region information does not match.'], ['code' => 'RequestIsNotMultiPartContent', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'RequestMehodNotAllowed', 'message' => null, 'http_code' => null, 'description' => 'The specified request method is invalid.'], ['code' => 'RequestNotOpenForFinanceUser', 'message' => null, 'http_code' => null, 'description' => 'This request is not available for financial customers.'], ['code' => 'RequestSuccess', 'message' => null, 'http_code' => null, 'description' => 'This request is successful.'], ['code' => 'RequestTimeout', 'message' => null, 'http_code' => null, 'description' => 'This request timed out. Please try again.'], ['code' => 'RequestTimeTooSkewed', 'message' => null, 'http_code' => null, 'description' => 'The initiation time of this request is 15 minutes later than the current time of the OSS server.'], ['code' => 'RiskControlMessageSendFailed', 'message' => null, 'http_code' => null, 'description' => 'The risk control verification message failed to send. The message sending interval cannot be less than 60 seconds. Please try again.'], ['code' => 'RiskControlMessageValidateFailed', 'message' => null, 'http_code' => null, 'description' => 'The validation of the risk control verification text message failed.'], ['code' => 'SecurityTokenNotSupported', 'message' => null, 'http_code' => null, 'description' => 'The specified security token is invalid.'], ['code' => 'ServiceBusy', 'message' => null, 'http_code' => null, 'description' => 'This domain name is configuring. Please try again later.'], ['code' => 'ServiceUnavailable', 'message' => null, 'http_code' => null, 'description' => 'The service is unavailable. Please try again later.'], ['code' => 'SignatureDoesNotMatch', 'message' => null, 'http_code' => null, 'description' => 'This signature does not match. Check the corresponding key and the signature algorithm.'], ['code' => 'SocketException', 'message' => null, 'http_code' => null, 'description' => 'Socket Exception'], ['code' => 'SocketTimeout', 'message' => null, 'http_code' => null, 'description' => 'Socket Timeout'], ['code' => 'SomeObjectsDeletedFail', 'message' => null, 'http_code' => null, 'description' => 'An error has occurred while deleting some Objects.'], ['code' => 'SomeObjectsSetHttpHeaderFail', 'message' => null, 'http_code' => null, 'description' => 'ObjectHttpHeader was partially configured.'], ['code' => 'StringToDateConvertError', 'message' => null, 'http_code' => null, 'description' => 'An error has occurred while converting the date. Check the date format and try again.'], ['code' => 'StyleContentError', 'message' => null, 'http_code' => null, 'description' => 'The image style content cannot be empty.'], ['code' => 'StyleListEmpty', 'message' => null, 'http_code' => null, 'description' => 'The image style quantity is 0. Export is not possible.'], ['code' => 'StyleListTooMany', 'message' => null, 'http_code' => null, 'description' => 'The quantity of imported styles exceeds the limit of 50 styles. The process failed.'], ['code' => 'SystemNotAllowBindTheDomain', 'message' => null, 'http_code' => null, 'description' => 'The system does not allow this domain name to be bound.'], ['code' => 'TextWatermarkNeedText', 'message' => null, 'http_code' => null, 'description' => 'The text watermark must contain text. It must be no more than 16 characters long.'], ['code' => 'Throttling', 'message' => null, 'http_code' => null, 'description' => 'This request was denied due to request throttling. Please try again later.'], ['code' => 'TokenError', 'message' => null, 'http_code' => null, 'description' => 'An error occurred. The page may fail after a specified period with not action. 'TooManyBuckets', 'message' => null, 'http_code' => null, 'description' => 'You cannot create more buckets. To increase your bucket limit, submit a ticket.'], ['code' => 'TooManyCname', 'message' => null, 'http_code' => null, 'description' => 'The maximum number of cnames has been reached.'], ['code' => 'TopDomainOnlyBindedByAliyunJoinedUpUser', 'message' => null, 'http_code' => null, 'description' => 'Only users registered with Alibaba Cloud may bind top-level domain names. Other users may bind second level domain names or lower, or join 'UmidTokenOrCollinaNotAllowEmpty', 'message' => null, 'http_code' => null, 'description' => 'The risk control data was not passed correctly. Please check the request parameter.'], ['code' => 'UnKnowAllowedMethod', 'message' => null, 'http_code' => null, 'description' => 'Select AllowedMethod from one or more of the options [GET,PUT,DELETE,POST,HEAD].'], ['code' => 'UNKnowCNameStatus', 'message' => null, 'http_code' => null, 'description' => 'Bound Domain Name status can only select one from [verifying|enable|disable].'], ['code' => 'Unknown', 'message' => null, 'http_code' => null, 'description' => 'An internal server error occurred. Please try again later.'], ['code' => 'UnknownAcl', 'message' => null, 'http_code' => null, 'description' => 'Acl can only select one from [private,public-read,public-read-write]'], ['code' => 'UnknownHost', 'message' => null, 'http_code' => null, 'description' => 'Unknown Host'], ['code' => 'UnknownLifeCycleStatus', 'message' => null, 'http_code' => null, 'description' => 'LifeCycle Status must be selected from [Enabled,Disabled].'], ['code' => 'UpdateCNameDataFail', 'message' => null, 'http_code' => null, 'description' => 'This data update failed. Please try again.'], ['code' => 'UploadFileNotExist', 'message' => null, 'http_code' => null, 'description' => 'The specified file for uploading does not exist.'], ['code' => 'UploadIdNotAllowedEmpty', 'message' => null, 'http_code' => null, 'description' => 'The UploadId cannot be empty.'], ['code' => 'UploadSizeLimitExceeded', 'message' => null, 'http_code' => null, 'description' => 'The file size must not exceed 8M.'], ['code' => 'UploadTrafficRateLimitExceeded', 'message' => null, 'http_code' => null, 'description' => ''], ['code' => 'UploadTrafficRateLimitExceeded', 'message' => 'Please reduce your upload request traffic.', 'http_code' => null, 'description' => 'The upload bandwith cannot be more than 5Gbps (internet/intranet included). To increase your limit, submit a ticket.'], ['code' => 'URLDecoderError', 'message' => null, 'http_code' => null, 'description' => 'URL decoder error'], ['code' => 'UserAlreadyExists', 'message' => null, 'http_code' => null, 'description' => 'This user already exists.'], ['code' => 'UserBucketNotEmpty', 'message' => null, 'http_code' => null, 'description' => 'This user bucket is not empty.'], ['code' => 'UserDisable', 'message' => null, 'http_code' => null, 'description' => 'An exception occurred on the OSS service status. Contact customer services.'], ['code' => 'VERIFY_TXT_NOT_EXIST', 'message' => null, 'http_code' => null, 'description' => 'These TXT records are not set or are not effective. Wait five minutes and try again.'], ['code' => 'WhiteListMustBeValidURIAddress', 'message' => null, 'http_code' => null, 'description' => 'All URL addresses on the white list must be valid.'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SealAppendObject'], ], 'createdAt' => '2025-11-28T06:11:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'PutBucketPolicy'], ], 'createdAt' => '2025-11-20T03:53:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'PutBucketReplication'], ], 'createdAt' => '2025-11-20T03:48:43.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'OpenMetaQuery'], ], 'createdAt' => '2025-11-11T05:51:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetBucketAccessMonitor'], ], 'createdAt' => '2025-10-21T08:47:16.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetBucketLogging'], ], 'createdAt' => '2025-10-21T02:39:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListDataLakeStorageTransferJob'], ], 'createdAt' => '2025-04-18T07:20:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'PutDataLakeCachePrefetchJob'], ['description' => 'OpenAPI offline', 'api' => 'StartDataLakeCachePrefetchJob'], ], 'createdAt' => '2025-04-08T11:00:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DoMetaQuery'], ['description' => 'Request parameters changed', 'api' => 'OpenMetaQuery'], ], 'createdAt' => '2025-03-31T01:56:18.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DeleteBucketCommonHeader'], ['description' => 'OpenAPI offline', 'api' => 'GetBucketEventNotification'], ['description' => 'OpenAPI offline', 'api' => 'PutBucketCommonHeader'], ['description' => 'OpenAPI offline', 'api' => 'PutBucketHash'], ['description' => 'OpenAPI offline', 'api' => 'PutChannel'], ['description' => 'OpenAPI offline', 'api' => 'PutProcessConfiguration'], ], 'createdAt' => '2025-03-07T07:21:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateSelectObjectMeta'], ['description' => 'Request parameters changed', 'api' => 'SelectObject'], ], 'createdAt' => '2025-03-04T06:20:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'PutBucket'], ], 'createdAt' => '2024-12-05T08:32:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListBuckets'], ['description' => 'Request parameters changed', 'api' => 'PutBucket'], ], 'createdAt' => '2024-12-04T06:52:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAccessPoints'], ], 'createdAt' => '2024-11-28T15:05:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListBuckets'], ['description' => 'Request parameters changed', 'api' => 'PutBucket'], ], 'createdAt' => '2024-11-28T14:35:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetBucketLifecycle'], ], 'createdAt' => '2024-11-28T09:36:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetObjectMeta'], ['description' => 'Response parameters changed', 'api' => 'HeadObject'], ], 'createdAt' => '2024-10-10T07:15:25.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'PutAccessPointPublicAccessBlock'], ], 'createdAt' => '2024-05-08T05:42:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListBucketDataRedundancyTransition'], ], 'createdAt' => '2024-04-29T06:26:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'PutBucketReplication'], ['description' => 'Request parameters changed', 'api' => 'PutBucketRtc'], ], 'createdAt' => '2024-04-24T08:04:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetStyle'], ['description' => 'Request parameters changed', 'api' => 'PutStyle'], ], 'createdAt' => '2024-04-23T06:43:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CopyObject'], ], 'createdAt' => '2024-03-07T07:14:18.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateCnameToken'], ], 'createdAt' => '2024-03-07T06:07:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetBucketWebsite'], ], 'createdAt' => '2024-03-06T01:48:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteCname'], ], 'createdAt' => '2024-03-05T12:07:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteBucketReplication'], ], 'createdAt' => '2024-03-05T07:48:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetBucketInventory'], ['description' => 'Response parameters changed', 'api' => 'GetBucketReplicationLocation'], ['description' => 'Response parameters changed', 'api' => 'GetBucketReplicationProgress'], ['description' => 'Response parameters changed', 'api' => 'GetBucketWorm'], ['description' => 'Request parameters changed', 'api' => 'PutBucketLifecycle'], ], 'createdAt' => '2024-03-05T07:08:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListBuckets'], ], 'createdAt' => '2024-02-22T06:46:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'PutBucketWebsite'], ], 'createdAt' => '2024-02-22T03:35:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateAccessPoint'], ], 'createdAt' => '2024-02-22T01:55:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetBucketHttpsConfig'], ['description' => 'Request parameters changed', 'api' => 'PutBucketHttpsConfig'], ], 'createdAt' => '2024-02-21T14:34:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CompleteMultipartUpload'], ['description' => 'Response parameters changed', 'api' => 'CopyObject'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateAccessPoint'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateCnameToken'], ['description' => 'Request parameters changed', 'api' => 'DeleteAccessPoint'], ['description' => 'Request parameters changed', 'api' => 'DeleteAccessPointPolicy'], ['description' => 'Request parameters changed', 'api' => 'DeleteBucketReplication'], ['description' => 'Request parameters changed', 'api' => 'DeleteCname'], ['description' => 'Response parameters changed', 'api' => 'DescribeRegions'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DoMetaQuery'], ], 'createdAt' => '2024-02-21T14:31:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteStyle'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetStyle'], ['description' => 'Response parameters changed', 'api' => 'ListStyle'], ['description' => 'Request parameters changed', 'api' => 'PutStyle'], ], 'createdAt' => '2024-02-21T07:26:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetBucketReferer'], ['description' => 'Request parameters changed', 'api' => 'PutBucketReferer'], ], 'createdAt' => '2024-02-20T08:54:03.000Z', 'description' => '', ], ], 'flowControl' => [ 'flowControlList' => [], ], 'ram' => [ 'productCode' => 'OSS', 'productName' => 'Object Storage Service', 'ramCodes' => ['oss'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [ [ 'name' => 'oss:AccessPointNetworkOrigin', 'schema' => [ 'type' => 'String', 'description' => 'Delegate permissions for the access point under the Internet or VPC. After delegation, only the access point of the specified network takes effect.', 'enums' => ['internet', 'vpc'], ], ], [ 'name' => 'oss:DataAccessPointAccount', 'schema' => ['type' => 'Boolean', 'description' => 'Delegate permissions for all access points under the current account. After delegation, all access points under the account take effect. Example: 12345678900000'], ], [ 'name' => 'oss:x-oss-server-side-encryption-key-id', 'schema' => ['type' => 'String', 'description' => 'The KMS managed user master key used for server-side encryption, which exists only when the x-oss-server-side-encryption is KMS. Example:914a3602-ebf2-4fae-9d8xxx'], ], [ 'name' => 'acs:AccessId', 'schema' => ['type' => 'String', 'description' => 'The ID of the AccessKey carried in the request. Example: akidvnUsCXNWxxxxx'], ], [ 'name' => 'oss:x-oss-object-acl', 'schema' => [ 'type' => 'String', 'description' => 'The ACL of the specified object supports the regions of Hangzhou, Beijing, Chengdu, Qingdao, Shanghai, Shenzhen, Zhangjiakou, Singapore, and Germany.', 'enums' => ['public-read-write', 'public-read', 'private', 'default'], ], ], [ 'name' => 'oss:BucketTag', 'schema' => ['type' => 'String', 'description' => 'Storage label (BucketTag). A single BucketTag can be used as a Condition. when you set multiple BucketTag, you need to add oss:BucketTag/before each BucketTag to form multiple Condition. Example: \\\\"oss:BucketTag/team\\\\": \\\\"dev\\\\"'], ], [ 'name' => 'acs:UserAgent', 'schema' => ['type' => 'String', 'description' => 'Specifies the HTTP User-Agent header. Example: java-sdk'], ], [ 'name' => 'oss:x-oss-acl', 'schema' => [ 'type' => 'String', 'description' => 'Support Hangzhou, Shanghai, Qingdao, Shenzhen, Zhangjiakou, Beijing, Chengdu, Singapore', 'enums' => ['public-read-write', 'public-read', 'private'], ], ], [ 'name' => 'oss:x-oss-server-side-data-encryption', 'schema' => [ 'type' => 'String', 'description' => 'The encryption algorithm of server-side encryption, which exists only when the x-oss-server-side-encryption is KMS, and supports Hangzhou, Beijing, Chengdu, Qingdao, Shanghai, Shenzhen, Zhangjiakou, Singapore, and Germany regions', 'enums' => ['SM4'], ], ], [ 'name' => 'oss:TLSVersion', 'schema' => [ 'type' => 'String', 'description' => 'Only the specified TLS version is allowed to access, and only the regions of Shanghai, Beijing, Shenzhen, Hong Kong, Singapore, and Australia are supported.', 'enums' => ['TLSv1', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'], ], ], [ 'name' => 'oss:RequestObjectTag', 'schema' => ['type' => 'String', 'description' => 'The object tag carried in the request. A single ObjectTag can be used as a Condition. when you set multiple ObjectTag, you need to add oss:RequestObjectTag/before each ObjectTag to form multiple Condition. Mainly for PutObject, PostObject and other write file interfaces and PutObjectTagging, GetObjectTagging and other ObjectTagging interfaces. Example: \\\\"oss:RequestObjectTag/team\\\\": \\\\"dev\\\\"'], ], [ 'name' => 'oss:DataAccessPointArn', 'schema' => ['type' => 'String', 'description' => 'Delegates permissions for the specified access point. After delegation, only the specified access point takes effect. Example: acs:oss:cn-hangzhou:123456789xxxxx:accesspoint/ap-name'], ], [ 'name' => 'oss:Delimiter', 'schema' => ['type' => 'String', 'description' => 'The character used to group the object name when ListObjects a request. Valid value:/'], ], [ 'name' => 'oss:x-oss-server-side-encryption', 'schema' => [ 'type' => 'String', 'description' => 'Server-side encryption, supporting Hangzhou, Beijing, Chengdu, Qingdao, Shanghai, Shenzhen, Zhangjiakou, Singapore, Germany', 'enums' => ['AES256', 'KMS', 'SM4'], ], ], [ 'name' => 'oss:Prefix', 'schema' => ['type' => 'String', 'description' => 'Used to list the objects with the specified prefix when ListObjects a request. Example: prefix01'], ], [ 'name' => 'oss:ExistingObjectTag', 'schema' => ['type' => 'String', 'description' => 'The requested object already has a tag. A single ObjectTag can be used as a Condition. when you set multiple ObjectTag, you need to add oss:ExistingObjectTag/before each ObjectTag to form multiple Condition. Mainly for GetObject, HeadObject and other read file interfaces and PutObjectTagging, GetObjectTagging and other ObjectTagging interfaces. Example: \\\\"oss:ExistingObjectTag/team\\\\": \\\\"dev\\\\"'], ], ], 'ramActions' => [ [ 'apiName' => 'GetBucketStat', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketStat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketCommonHeader', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketCommonHeader', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteAccessPointPublicAccessBlock', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPointPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketOverwriteConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketOverwriteConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutDataLakeCachePrefetchJob', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutDataLakeCachePrefetchJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListMultipartUploads', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListMultipartUploads', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetStyle', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteLiveChannel', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'DeleteAccessPointForObjectProcess', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPointForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutAccessPointConfigForObjectProcess', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointConfigForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketPublicAccessBlock', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketLogging', 'description' => '', 'operationType' => 'update', 'additionalActions' => [ ['action' => 'oss:PutObject'], ], 'ramAction' => [ 'action' => 'oss:PutBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketLifecycle', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketTransferAcceleration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutBucketTransferAcceleration', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PostVodPlaylist', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetObjectMeta', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ], 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketPolicyStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketPolicyStatus', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetObjectAcl', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectVersionAcl'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:GetObjectAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'DeleteCname', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetMetaQueryStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetMetaQueryStatus', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketReferer', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketReferer', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutCname', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketLifecycle', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListAccessPointsForObjectProcess', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListAccessPointsForObjectProcess', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetBucketDataRedundancyTransition', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketDataRedundancyTransition', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'AppendObject', 'description' => '', 'operationType' => 'update', 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetAccessPointForObjectProcess', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutSymlink', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'DeleteBucketEncryption', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CreateBucketDataRedundancyTransition', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateBucketDataRedundancyTransition', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CleanRestoredObject', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [ ['action' => 'oss:CleanRestoredObjectVersion'], ], 'ramAction' => [ 'action' => 'oss:CleanRestoredObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:Prefix'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutLiveChannelStatus', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutLiveChannelStatus', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketHttpsConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketHttpsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutAccessPointPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetPublicAccessBlock', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetPublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutBucketHttpsConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketHttpsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketWebsite', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketWebsite', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListBucketInventory', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:GetBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutAccessPointPolicyForObjectProcess', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointPolicyForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CopyObject', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:GetObject', 'validationType' => 'always'], ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObjectVersionTagging'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'ListLiveChannel', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:ListLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutBucketCommonHeader', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketCommonHeader', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListUserDataRedundancyTransition', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'oss:ListBucketDataRedundancyTransition', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CreateCnameToken', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateCnameToken', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetAccessPoint', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketRequestPayment', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketRequestPayment', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketReplication', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetCnameToken', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetCnameToken', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteObject', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [ ['action' => 'oss:DeleteObjectVersion'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:DeleteObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'DeleteBucketDataRedundancyTransition', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketDataRedundancyTransition', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetAccessPointPublicAccessBlock', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'RestoreObject', 'description' => '', 'operationType' => 'update', 'additionalActions' => [ ['action' => 'oss:RestoreObjectVersion'], ], 'ramAction' => [ 'action' => 'oss:RestoreObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutBucketPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketCors', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteObjectTagging', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [ ['action' => 'oss:DeleteObjectVersionTagging'], ], 'ramAction' => [ 'action' => 'oss:DeleteObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketReferer', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReferer', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketLifecycle', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketLifecycle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'InitiateMultipartUpload', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutBucketEncryption', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketReplicationProgress', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplicationProgress', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketAcl', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:x-oss-acl'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketWorm', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'SelectObject', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectTagging'], ], 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetLiveChannelInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'DeleteBucketLogging', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListObjectVersions', 'description' => '', 'operationType' => 'list', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:ListObjectVersions', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketReplicationLocation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplicationLocation', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'UploadPartCopy', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:GetObject', 'validationType' => 'always'], ['action' => 'oss:GetObjectVersion'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetSymlink', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectVersionTagging'], ], 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'ExtendBucketWorm', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:ExtendBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CreateAccessPointForObjectProcess', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateAccessPointForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CompleteBucketWorm', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:CompleteBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CreateAccessPoint', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:CreateAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListBucketAntiDDosInfo', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetVodPlaylist', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetVodPlaylist', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutBucketRtc', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'UploadPart', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'CompleteMultipartUpload', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketVersioning', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketVersioning', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListObjects', 'description' => '', 'operationType' => 'list', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:ListObjects', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketReplication', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketArchiveDirectRead', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketArchiveDirectRead', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketTransferAcceleration', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketTransferAcceleration', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucket', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:PutBucketAcl'], ], 'ramAction' => [ 'action' => 'oss:PutBucket', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:x-oss-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketReplication', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:PutObject', 'validationType' => 'conditional'], ['action' => 'oss:ReplicateGet', 'validationType' => 'conditional'], ], 'ramAction' => [ 'action' => 'oss:PutBucketReplication', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketInventory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketEventNotification', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketEventNotification', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketLocation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLocation', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketInventory', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketAcl', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketRequestPayment', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketRequestPayment', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DoMetaQuery', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:DoMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetUserAntiDDosInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAccessPointConfigForObjectProcess', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointConfigForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListCname', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListCname', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketPolicy', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetLiveChannelHistory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannelHistory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutBucketInventory', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketInventory', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'StartDataLakeCachePrefetchJob', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:StartDataLakeCachePrefetchJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'OpenMetaQuery', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:OpenMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutObject', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:DeleteObject'], ['action' => 'oss:PutObjectTagging'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutBucketWebsite', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketWebsite', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutProcessConfiguration', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketImage', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListAccessPoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListAccessPoints', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetObject', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:ProcessImm'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:RestoreObjectVersion'], ['action' => 'oss:GetObjectVersionTagging'], ], 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketResourceGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutStyle', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteAccessPoint', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketPublicAccessBlock', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteStyle', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListObjectsV2', 'description' => '', 'operationType' => 'list', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:ListObjects', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:Prefix', 'validationType' => 'always'], ['conditionKey' => 'oss:Delimiter', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteUserDefinedLogFieldsConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteUserDefinedLogFieldsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketArchiveDirectRead', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketArchiveDirectRead', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketTags', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutObjectTagging', 'description' => '', 'operationType' => 'update', 'additionalActions' => [ ['action' => 'oss:PutObjectVersionTagging'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketTags', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutUserDefinedLogFieldsConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutUserDefinedLogFieldsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'AbortBucketWorm', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:AbortBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CreateSelectObjectMeta', 'description' => '', 'operationType' => 'create', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'InitBucketAntiDDosInfo', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitUserAntiDDosInfo', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutLiveChannel', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutLiveChannel', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'PutBucketTags', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PostObject', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:x-oss-object-acl'], ['conditionKey' => 'oss:x-oss-server-side-data-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption'], ['conditionKey' => 'oss:x-oss-server-side-encryption-key-id'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetAccessPointPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketEncryption', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketEncryption', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteAccessPointPolicyForObjectProcess', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPointPolicyForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetLiveChannelStat', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetLiveChannelStat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'AbortMultipartUpload', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:AbortMultipartUpload', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'InitiateBucketWorm', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:InitiateBucketWorm', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetAccessPointPolicyForObjectProcess', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetAccessPointPolicyForObjectProcess', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketOverwriteConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'oss:PutBucketOverwriteConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DescribeRegions', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:DescribeRegions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDataLakeStorageTransferJob', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListDataLakeStorageTransferJob', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetObjectTagging', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectVersionTagging'], ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:GetObjectTagging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'oss:RequestObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutChannel', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketImage', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketVersioning', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketVersioning', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutAccessPointPublicAccessBlock', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutAccessPointPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListStyle', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListStyle', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeletePublicAccessBlock', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeletePublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutObjectAcl', 'description' => '', 'operationType' => 'update', 'additionalActions' => [ ['action' => 'oss:GetObject'], ['action' => 'oss:PutObjectVersionAcl'], ], 'ramAction' => [ 'action' => 'oss:PutObjectAcl', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:x-oss-object-acl'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'ListParts', 'description' => '', 'operationType' => 'list', 'additionalActions' => [ ['action' => 'oss:GetObject'], ], 'ramAction' => [ 'action' => 'oss:ListParts', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:DataAccessPointArn'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], [ 'apiName' => 'GetBucketCors', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:BucketTag'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketAccessMonitor', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketAccessMonitor', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketLogging', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutPublicAccessBlock', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutPublicAccessBlock', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteBucket', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucket', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'UpdateBucketAntiDDosInfo', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:UpdateBucketAntiDDosInfo', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetUserDefinedLogFieldsConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetUserDefinedLogFieldsConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteBucketCors', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketCors', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'DeleteAccessPointPolicy', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteAccessPointPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketHash', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketHash', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'GetBucketPublicAccessBlock', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'oss:GetBucketPublicAccessBlock', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'PutBucketAccessMonitor', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:PutBucketAccessMonitor', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'CloseMetaQuery', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:CloseMetaQuery', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'ListBuckets', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'oss:ListBuckets', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateUserAntiDDosInfo', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'oss:UpdateUserAntiDDosInfo', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteBucketOverwriteConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'oss:DeleteBucketOverwriteConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'acs:AccessId'], ['conditionKey' => 'acs:UserAgent'], ['conditionKey' => 'oss:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ], ], ], [ 'apiName' => 'HeadObject', 'description' => '', 'operationType' => 'get', 'additionalActions' => [ ['action' => 'oss:GetObjectVersion'], ['action' => 'oss:GetObjectTagging'], ['action' => 'oss:GetObject'], ['action' => 'oss:GetObjectVersionTagging'], ], 'ramAction' => [ 'action' => 'oss:GetObject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'oss:ExistingObjectTag', 'validationType' => 'always'], ['conditionKey' => 'acs:UserAgent', 'validationType' => 'always'], ['conditionKey' => 'acs:AccessId', 'validationType' => 'always'], ['conditionKey' => 'oss:BucketTag', 'validationType' => 'always'], ['conditionKey' => 'oss:TLSVersion'], ['conditionKey' => 'oss:DataAccessPointAccount'], ['conditionKey' => 'oss:AccessPointNetworkOrigin'], ['conditionKey' => 'oss:DataAccessPointArn'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'OSS', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}'], ['validationType' => 'always', 'resourceType' => 'Object', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ['validationType' => 'always', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}'], ['validationType' => 'always', 'resourceType' => 'Bucket', 'arn' => 'acs:oss:*:{#accountId}:{#BucketName}'], ['validationType' => 'always', 'resourceType' => 'Unrestricted', 'arn' => 'acs:oss:oss-{#regionId}:{#accountId}:*'], ], ], ];