'1.0', 'info' => [ 'style' => 'OSS', 'product' => 'Oss', 'version' => '2019-05-17', ], 'directories' => [ [ 'id' => 146111, 'title' => '服务', 'type' => 'directory', 'children' => [ 'ListBuckets', ], ], [ 'id' => 146109, 'title' => '地域', 'type' => 'directory', 'children' => [ 'DescribeRegions', ], ], [ 'id' => 146114, 'title' => '存储空间', 'type' => 'directory', 'children' => [ [ 'id' => 146115, 'title' => '基础操作', 'type' => 'directory', 'children' => [ 'GetBucketStat', 'PutBucket', 'DeleteBucket', 'ListObjects', 'ListObjectsV2', 'GetBucketInfo', 'GetBucketLocation', ], ], [ 'id' => 184274, 'title' => '接入点', 'type' => 'directory', 'children' => [ 'ListAccessPoints', 'GetAccessPoint', 'GetAccessPointPolicy', 'DeleteAccessPointPolicy', 'PutAccessPointPolicy', 'DeleteAccessPoint', 'CreateAccessPoint', ], ], [ 'id' => 146122, 'title' => '合规保留策略', 'type' => 'directory', 'children' => [ 'InitiateBucketWorm', 'AbortBucketWorm', 'CompleteBucketWorm', 'ExtendBucketWorm', 'GetBucketWorm', ], ], [ 'id' => 146128, 'title' => '权限控制', 'type' => 'directory', 'children' => [ 'PutBucketAcl', 'GetBucketAcl', ], ], [ 'id' => 146131, 'title' => '生命周期', 'type' => 'directory', 'children' => [ 'PutBucketLifecycle', 'GetBucketLifecycle', 'DeleteBucketLifecycle', ], ], [ 'id' => 146135, 'title' => '传输加速', 'type' => 'directory', 'children' => [ 'PutBucketTransferAcceleration', 'GetBucketTransferAcceleration', ], ], [ 'id' => 146138, 'title' => '版本控制', 'type' => 'directory', 'children' => [ 'PutBucketVersioning', 'GetBucketVersioning', 'ListObjectVersions', ], ], [ 'id' => 146148, 'title' => '授权策略', 'type' => 'directory', 'children' => [ 'PutBucketPolicy', 'GetBucketPolicy', 'DeleteBucketPolicy', 'GetBucketPolicyStatus', ], ], [ 'id' => 146142, 'title' => '数据复制', 'type' => 'directory', 'children' => [ 'PutBucketRtc', 'PutBucketReplication', 'GetBucketReplication', 'GetBucketReplicationLocation', 'GetBucketReplicationProgress', 'DeleteBucketReplication', ], ], [ 'id' => 146152, 'title' => '清单', 'type' => 'directory', 'children' => [ 'PutBucketInventory', 'GetBucketInventory', 'ListBucketInventory', 'DeleteBucketInventory', ], ], [ 'id' => 146157, 'title' => '日志管理', 'type' => 'directory', 'children' => [ 'PutBucketLogging', 'GetBucketLogging', 'DeleteBucketLogging', 'PutUserDefinedLogFieldsConfig', 'GetUserDefinedLogFieldsConfig', 'DeleteUserDefinedLogFieldsConfig', ], ], [ 'id' => 146161, 'title' => '静态网站', 'type' => 'directory', 'children' => [ 'GetBucketWebsite', 'PutBucketWebsite', 'DeleteBucketWebsite', ], ], [ 'id' => 146165, 'title' => '防盗链', 'type' => 'directory', 'children' => [ 'PutBucketReferer', 'GetBucketReferer', ], ], [ 'id' => 146168, 'title' => '标签', 'type' => 'directory', 'children' => [ 'PutBucketTags', 'GetBucketTags', 'DeleteBucketTags', ], ], [ 'id' => 191780, 'title' => '存储冗余转换', 'type' => 'directory', 'children' => [ 'ListUserDataRedundancyTransition', 'ListBucketDataRedundancyTransition', 'GetBucketDataRedundancyTransition', 'CreateBucketDataRedundancyTransition', 'DeleteBucketDataRedundancyTransition', ], ], [ 'id' => 146172, 'title' => '加密', 'type' => 'directory', 'children' => [ 'PutBucketEncryption', 'GetBucketEncryption', 'DeleteBucketEncryption', ], ], [ 'id' => 146176, 'title' => '请求者付费', 'type' => 'directory', 'children' => [ 'PutBucketRequestPayment', 'GetBucketRequestPayment', ], ], [ 'id' => 146179, 'title' => '跨资源共享', 'type' => 'directory', 'children' => [ 'PutBucketCors', 'GetBucketCors', 'DeleteBucketCors', 'OptionObject', ], ], [ 'id' => 184334, 'title' => '访问跟踪', 'type' => 'directory', 'children' => [ 'PutBucketAccessMonitor', 'GetBucketAccessMonitor', ], ], [ 'id' => 184337, 'title' => '数据索引', 'type' => 'directory', 'children' => [ 'GetMetaQueryStatus', 'CloseMetaQuery', 'DoMetaQuery', 'OpenMetaQuery', ], ], [ 'id' => 184342, 'title' => '高防', 'type' => 'directory', 'children' => [ 'UpdateUserAntiDDosInfo', 'UpdateBucketAntiDDosInfo', 'ListBucketAntiDDosInfo', 'InitUserAntiDDosInfo', 'InitBucketAntiDDosInfo', 'GetUserAntiDDosInfo', ], ], [ 'id' => 184349, 'title' => '资源组', 'type' => 'directory', 'children' => [ 'GetBucketResourceGroup', 'PutBucketResourceGroup', ], ], [ 'id' => 184352, 'title' => '自定义域名', 'type' => 'directory', 'children' => [ 'PutCname', 'ListCname', 'DeleteCname', 'GetCnameToken', 'CreateCnameToken', ], ], [ 'id' => 184358, 'title' => '图片样式', 'type' => 'directory', 'children' => [ 'PutStyle', 'ListStyle', 'GetStyle', 'DeleteStyle', ], ], [ 'id' => 186871, 'title' => '安全传输层协议（TLS）', 'type' => 'directory', 'children' => [ 'GetBucketHttpsConfig', 'PutBucketHttpsConfig', ], ], [ 'id' => 191785, 'title' => '对象FC接入点', 'type' => 'directory', 'children' => [ 'CreateAccessPointForObjectProcess', 'GetAccessPointForObjectProcess', 'ListAccessPointsForObjectProcess', 'DeleteAccessPointForObjectProcess', 'GetAccessPointConfigForObjectProcess', 'PutAccessPointConfigForObjectProcess', 'PutAccessPointPolicyForObjectProcess', 'GetAccessPointPolicyForObjectProcess', 'DeleteAccessPointPolicyForObjectProcess', ], ], [ 'id' => 191709, 'title' => '阻止公共访问', 'type' => 'directory', 'children' => [ [ 'id' => 191710, 'title' => 'OSS全局阻止公共访问', 'type' => 'directory', 'children' => [ 'GetPublicAccessBlock', 'PutPublicAccessBlock', 'DeletePublicAccessBlock', ], ], [ 'id' => 191714, 'title' => 'Bucket级别阻止公共访问', 'type' => 'directory', 'children' => [ 'GetBucketPublicAccessBlock', 'PutBucketPublicAccessBlock', 'DeleteBucketPublicAccessBlock', ], ], [ 'id' => 191718, 'title' => '接入点级别阻止公共访问', 'type' => 'directory', 'children' => [ 'GetAccessPointPublicAccessBlock', 'PutAccessPointPublicAccessBlock', 'DeleteAccessPointPublicAccessBlock', ], ], ], ], [ 'id' => 191795, 'title' => '归档直读', 'type' => 'directory', 'children' => [ 'GetBucketArchiveDirectRead', 'PutBucketArchiveDirectRead', ], ], [ 'id' => 348763, 'title' => '禁止覆盖写', 'type' => 'directory', 'children' => [ 'PutBucketOverwriteConfig', 'GetBucketOverwriteConfig', 'DeleteBucketOverwriteConfig', ], ], ], ], [ 'id' => 146184, 'title' => '文件', 'type' => 'directory', 'children' => [ [ 'id' => 146185, 'title' => '基础操作', 'type' => 'directory', 'children' => [ 'PutObject', 'CopyObject', 'GetObject', 'AppendObject', 'SealAppendObject', 'DeleteObject', 'HeadObject', 'GetObjectMeta', 'RestoreObject', 'CleanRestoredObject', 'SelectObject', 'CreateSelectObjectMeta', ], ], [ 'id' => 146198, 'title' => '分片上传', 'type' => 'directory', 'children' => [ 'InitiateMultipartUpload', 'UploadPart', 'CompleteMultipartUpload', 'UploadPartCopy', 'AbortMultipartUpload', 'ListMultipartUploads', 'ListParts', ], ], [ 'id' => 146206, 'title' => '权限控制', 'type' => 'directory', 'children' => [ 'PutObjectAcl', 'GetObjectAcl', ], ], [ 'id' => 146209, 'title' => '软链接', 'type' => 'directory', 'children' => [ 'PutSymlink', 'GetSymlink', ], ], [ 'id' => 146212, 'title' => '标签', 'type' => 'directory', 'children' => [ 'PutObjectTagging', 'GetObjectTagging', 'DeleteObjectTagging', ], ], ], ], [ 'id' => 146216, 'title' => '直播推流', 'type' => 'directory', 'children' => [ 'PutLiveChannel', 'ListLiveChannel', 'DeleteLiveChannel', 'PutLiveChannelStatus', 'GetLiveChannelInfo', 'GetLiveChannelHistory', 'GetLiveChannelStat', 'GetVodPlaylist', 'PostVodPlaylist', ], ], [ 'id' => 203693, 'title' => '其他', 'type' => 'directory', 'children' => [ 'PutChannel', 'PutBucketHash', 'PutBucketCommonHeader', 'DeleteBucketCommonHeader', 'PutProcessConfiguration', 'GetBucketEventNotification', 'PutDataLakeCachePrefetchJob', 'StartDataLakeCachePrefetchJob', 'ListDataLakeStorageTransferJob', ], ], ], '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' => 'A list of grants that control access to the staged results', 'description' => '存储ACL信息的容器。', 'type' => 'object', 'properties' => [ 'Grant' => [ 'description' => 'Bucket的读写权限ACL。', 'enumValueTitles' => [ 'private' => 'private', 'public-read' => 'public-read', 'public-read-write' => 'public-read-write', ], 'example' => 'public-read', '$ref' => '#/components/schemas/Grant', ], ], ], 'AccessControlPolicy' => [ 'title' => 'Contains the elements that set the ACL permissions for an object', 'description' => '保存Get Object ACL结果的容器。', 'type' => 'object', 'properties' => [ 'Owner' => [ 'description' => '保存Bucket拥有者信息的容器。'."\n" ."\n", '$ref' => '#/components/schemas/Owner', ], 'AccessControlList' => [ 'description' => '存储ACL信息的容器。', '$ref' => '#/components/schemas/AccessControlList', ], ], ], 'AccessMonitorConfiguration' => [ 'title' => '保存存储空间访问追踪配置的容器', 'description' => 'Bucket的访问跟踪状态配置信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '访问追踪功能状态', 'description' => 'Bucket的访问跟踪状态。', '$ref' => '#/components/schemas/AccessMonitorStatus', ], ], ], 'AccessMonitorStatus' => [ 'title' => 'A short description of struct', 'description' => 'Bucket的访问跟踪状态。取值范围如下：'."\n" ."\n" .'- Enabled：已开启'."\n" ."\n" .'- Disabled：未开启', 'type' => 'string', 'example' => 'Enabled', 'enum' => [ 'Enabled', 'Disabled', ], ], 'AccessPoint' => [ 'title' => '保存AccessPoint信息的容器', 'description' => '保存单个接入点信息的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => 'Bucket名称', 'description' => '配置接入点的Bucket名称。', 'type' => 'string', 'example' => 'oss-example', ], 'AccessPointName' => [ 'title' => '接入点名称', 'description' => '接入点名称。', '$ref' => '#/components/schemas/AccessPointName', ], 'Alias' => [ 'title' => '接入点别名', 'description' => '接入点别名。', '$ref' => '#/components/schemas/AccessPointAlias', ], 'NetworkOrigin' => [ 'description' => '接入点网络来源。', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', ], 'VpcConfiguration' => [ 'description' => '保存VPC网络来源信息的容器。', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', ], 'Status' => [ 'description' => '接入点所处状态。', '$ref' => '#/components/schemas/AccessPointStatus', ], ], ], 'AccessPointAlias' => [ 'title' => '接入点别名', 'description' => '接入点别名。', 'type' => 'string', 'example' => 'ap-01-45ee7945007a2f0bcb595f63e2215c****-ossalias', ], 'AccessPointArn' => [ 'title' => '接入点ARN。', 'description' => '接入点ARN。', 'type' => 'string', 'example' => 'arn:acs:oss:ap-southeast-2:111933544165****:accesspoint/ap-01', ], 'AccessPointName' => [ 'title' => '接入点名称', 'description' => '接入点名称', 'type' => 'string', 'example' => 'ap-01', ], 'AccessPointNetworkOrigin' => [ 'title' => '接入点网络来源。返回值如下： vpc：限制仅支持通过指定的VPC ID访问接入点。 internet：同时持通过外网和内网Endpoint互联网访问接入点。', 'description' => '接入点网络来源。返回值如下： vpc：限制仅支持通过指定的VPC ID访问接入点。 internet：同时持通过外网和内网Endpoint互联网访问接入点。', 'type' => 'string', 'example' => 'vpc', ], 'AccessPointStatus' => [ 'title' => '接入点所处状态', 'description' => '接入点所处状态。'."\n" ."\n" .'- enable：接入点已创建完成。'."\n" ."\n" .'- disable：接入点已禁用。'."\n" ."\n" .'- creating：接入点正在创建中。'."\n" ."\n" .'- deleting：接入点已删除。', 'type' => 'string', 'example' => 'enable', ], 'AccessPointVpcConfiguration' => [ 'title' => '保存VPC网络来源信息的容器。', 'description' => '保存VPC网络来源信息的容器。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'title' => '仅当NetworkOrigin取值为vpc时，需要指定VPC ID。', 'description' => '仅当NetworkOrigin取值为vpc时，需要指定VPC ID。', 'type' => 'string', 'example' => 'vpc-t4nlw426y44rd3iq4****', ], ], ], 'ApplyServerSideEncryptionByDefault' => [ 'title' => 'A short description of struct', 'description' => '服务器端默认加密方式的容器。'."\n", 'type' => 'object', 'properties' => [ 'SSEAlgorithm' => [ 'title' => 'description', 'description' => '设置服务器端默认加密方式。'."\n" .'取值：KMS、AES256、SM4'."\n" .'使用KMS密钥功能时会产生少量的KMS密钥API调用费用，费用详情请参见**[KMS计费标准](~~52608~~)**。'."\n" .'进行跨区域复制时，若目标Bucket启用了默认服务器端加密方式，且复制规则配置了ReplicaCMKID，有以下两种情况：'."\n" .' - 若源Bucket中的对象未加密，则使用目标Bucket的默认加密方式对跨区域复制过来的明文对象进行加密。'."\n" .' - 若源Bucket中的对象使用了SSE-KMS或SSE-OSS的加密方式，则目标Bucket针对这些对象仍然使用原加密方式进行加密。'."\n" ."\n" .'更多信息，请参见**[跨区域复制结合服务器端加密](~~177216~~)**。', 'type' => 'string', 'example' => 'AES256', ], 'KMSMasterKeyID' => [ 'title' => 'description', 'description' => '当SSEAlgorithm值为KMS，且使用指定的密钥加密时，需输入KMSMasterKeyID。其他情况下，必须为空。', 'type' => 'string', 'enumValueTitles' => [], 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], 'KMSDataEncryption' => [ 'title' => 'description', 'description' => '指定Object的加密算法。若未指定此选项，表明Object使用AES256加密算法。此选项仅当SSEAlgorithm取值为KMS有效。'."\n" .'取值：SM4', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'SM4', ], ], ], 'ArchiveDirectReadConfiguration' => [ 'title' => '保存归档直读状态的容器', 'description' => '保存归档直读状态的容器。', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'title' => '是否开启归档直读', 'description' => 'Bucket是否开启归档直读。取值如下：'."\n" .'- true：开启归档直读。'."\n" .'- false：关闭归档直读。', 'type' => 'boolean', 'example' => 'true', ], ], ], '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' => 'Bucket信息', 'description' => '保存Bucket信息的容器。', 'type' => 'object', 'properties' => [ 'CreationDate' => [ 'title' => 'Bucket的创建时间，格式为UTC时间', 'description' => 'Bucket创建时间。格式为`yyyy-mm-ddThh:mm:ss.timezone`。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2014-05-15T11:18:32.000Z', ], 'ExtranetEndpoint' => [ 'title' => 'Bucket的外网域名', 'description' => 'Bucket访问的外网域名。', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', ], 'IntranetEndpoint' => [ 'title' => 'Bucket的内网域名', 'description' => '同地域ECS访问Bucket的内网域名。', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', ], 'Location' => [ 'title' => 'Bucket所在的数据中心', 'description' => 'Bucket所在的数据中心。', 'type' => 'string', 'example' => 'oss-cn-hangzhou', ], 'Name' => [ 'title' => 'Bucket的名称', 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'mybucket01', ], 'StorageClass' => [ 'title' => 'Bucket的存储类型', 'description' => 'Bucket存储类型，支持Standard、IA、Archive和ColdArchive四种存储类型。', 'example' => 'Standard', '$ref' => '#/components/schemas/StorageClass', ], 'Region' => [ 'title' => 'Bucket所在地域', 'description' => 'Bucket所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], 'example' => 'examplebucket', ], 'BucketACL' => [ 'title' => 'The access control list (ACL) for a bucket.', 'description' => 'Bucket的访问权限ACL。取值范围如下：'."\n" .'- public-read-write：公共读写'."\n" .'- public-read：公共读'."\n" .'- private（默认）：私有'."\n" ."\n" .'关于Bucket访问权限ACL的更多信息，请参见[设置存储空间访问权限ACL](~~31843~~)。', 'type' => 'string', 'example' => 'private', 'default' => 'private', 'enum' => [ 'private', 'public-read', 'public-read-write', ], ], 'BucketAntiDDOSConfiguration' => [ 'title' => 'A short description of struct', 'description' => '保存高防实例配置信息的容器。', 'type' => 'object', 'properties' => [ 'Cnames' => [ 'title' => '域名信息列表的容器', 'description' => '保存域名信息列表的容器。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '待防护自定义域名', 'description' => '待防护自定义域名。', 'type' => 'array', 'items' => [ 'description' => '待防护自定义域名。每个Bucket最多支持5个待防护的自定义域名。', 'type' => 'string', 'example' => 'abc1.example.cn', ], ], ], ], ], ], 'BucketAntiDDOSInfo' => [ 'title' => 'A short description of struct', 'description' => '保存高防实例信息的容器。', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '拥有者的UID', 'description' => '高防实例ID。', 'type' => 'string', 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', ], 'Owner' => [ 'title' => '拥有者的UID', 'description' => 'Bucket拥有者的UID。', 'type' => 'string', 'example' => '114893010724****', ], 'Bucket' => [ 'title' => '高防实例ID', 'description' => '防护的Bucket名称。', 'type' => 'string', 'example' => 'examplebucket', ], 'Ctime' => [ 'title' => '高防实例创建时间', 'description' => '高防实例创建时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769503', ], 'Mtime' => [ 'title' => '高防实例更新时间', 'description' => '高防实例更新时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769840', ], 'ActiveTime' => [ 'title' => '高防实例激活时间', 'description' => '高防实例激活时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769845', ], 'Status' => [ 'title' => '高防实的状态', 'description' => '高防实例所处状态。'."\n" ."\n" .'- Init：初始化防护状态。'."\n" ."\n" .'- Defending：防护中状态。'."\n" ."\n" .'- HaltDefending：解除防护状态。', 'type' => 'string', 'example' => 'Defending', ], 'Type' => [ 'title' => '高防实的类型', 'description' => '高防实例类型。固定值为AntiDDosPremimum。', 'type' => 'string', 'example' => 'AntiDDosPremimum', ], 'Cnames' => [ 'title' => '自定义域名容器', 'description' => '保存自定义域名的容器。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '自定义域名', 'description' => '自定义域名。', 'type' => 'array', 'items' => [ 'description' => '自定义域名。', 'type' => 'string', 'example' => 'abc1.example.cn', ], ], ], ], ], ], 'BucketChannelConfig' => [ 'title' => '存储空间图片处理通道配置', 'description' => 'Bucket图片处理通道配置', 'type' => 'object', 'properties' => [ 'version' => [ 'title' => '版本', 'description' => '版本', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'DebugInfo' => [ 'title' => '调试信息', 'description' => '调试信息', 'type' => 'string', 'example' => 'testinfo', ], 'RuleList' => [ 'title' => '规则列表', 'description' => '规则列表', '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', ], ], ], ], ], ], ], ], 'BucketCnameConfiguration' => [ 'title' => 'Cname配置的容器', 'description' => 'Cname配置的容器。', 'type' => 'object', 'properties' => [ 'Cname' => [ 'title' => 'Cname信息的容器', 'description' => 'Cname信息的容器。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '自定义域名', 'description' => '自定义域名。', 'type' => 'string', 'example' => 'example.com', ], 'CertificateConfiguration' => [ 'title' => '保存证书配置信息的容器', 'description' => '保存证书配置信息的容器', '$ref' => '#/components/schemas/CertificateConfiguration', ], ], ], ], ], 'BucketDataRedundancyTransition' => [ 'title' => 'Bucket存储冗余转换任务详情', 'description' => 'Bucket存储冗余转换任务详情', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => 'Bucket名称', 'description' => 'Bucket名称', 'type' => 'string', 'example' => 'example-bucket', ], 'TaskId' => [ 'title' => '存储冗余转换任务的唯一标识', 'description' => '存储冗余转换任务的ID', 'type' => 'string', 'example' => '751f5243f8ac4ae89f34726534d1****', ], 'Status' => [ 'title' => '存储冗余转换任务的状态', 'description' => '存储冗余转换任务的状态，取值如下：'."\n" ."\n" .'- Queueing：队列中。'."\n" .'- Processing：进行中。'."\n" .'- Finished：完成。', 'type' => 'string', 'example' => 'Queueing', ], 'CreateTime' => [ 'title' => '存储冗余转换任务的创建时间', 'description' => '存储冗余转换任务的创建时间', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z', ], 'StartTime' => [ 'title' => '存储冗余转换任务的开始时间', 'description' => '存储冗余转换任务的开始时间', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z', ], 'EndTime' => [ 'title' => '存储冗余转换任务的完成时间', 'description' => '存储冗余转换任务的完成时间', 'type' => 'string', 'example' => '2023-11-17T09:14:39.000Z', ], 'ProcessPercentage' => [ 'title' => '存储冗余转换任务的进度百分比。取值范围：0-100', 'description' => '存储冗余转换任务的进度百分比。取值范围：0-100', 'type' => 'integer', 'format' => 'int32', 'example' => '88', ], 'EstimatedRemainingTime' => [ 'title' => '存储冗余转换任务的预计剩余耗时。单位为小时。', 'description' => '存储冗余转换任务的预计剩余耗时。单位为小时。', 'type' => 'string', 'example' => '10', ], ], ], 'BucketInfo' => [ 'title' => '保存Bucket信息的容器', 'description' => '保存Bucket信息的容器', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '保存Bucket信息的容器', 'description' => '保存Bucket信息的容器', 'type' => 'object', 'properties' => [ 'AccessMonitor' => [ 'title' => 'Bucket是否开启访问追踪', 'description' => 'Bucket是否开启访问追踪', 'type' => 'string', 'enumValueTitles' => [ 'Enabled' => 'Enabled', 'Disabled' => 'Disabled', ], 'example' => 'Disabled', ], 'CreationDate' => [ 'title' => 'Bucket的创建时间', 'description' => 'Bucket的创建时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2022-01-06T08:20:09.000Z', ], 'CrossRegionReplication' => [ 'title' => 'Bucket是否开启跨区域复制', 'description' => 'Bucket是否开启跨区域复制', 'type' => 'string', 'enumValueTitles' => [ 'Enabled' => 'Enabled', 'Disabled' => 'Disabled', ], 'example' => 'Disabled', ], 'DataRedundancyType' => [ 'description' => 'Bucket的数据容灾类型', '$ref' => '#/components/schemas/DataRedundancyType', ], 'ExtranetEndpoint' => [ 'title' => 'Bucket外网访问域名', 'description' => 'Bucket外网访问域名', '$ref' => '#/components/schemas/Endpoint', ], 'IntranetEndpoint' => [ 'title' => 'Bucket内网访问域名', 'description' => 'Bucket内网访问域名', '$ref' => '#/components/schemas/Endpoint', ], 'Location' => [ 'title' => 'Bucket所在地域', 'description' => 'Bucket所在地域', 'type' => 'string', 'example' => 'oss-cn-hangzhou', ], 'Name' => [ 'title' => 'Bucket名称', 'description' => 'Bucket名称', 'type' => 'string', 'example' => 'test-bucket', ], 'ResourceGroupId' => [ 'title' => 'Bucket所在的资源组ID', 'description' => 'Bucket所在的资源组ID', '$ref' => '#/components/schemas/ResourceGroupId', ], 'StorageClass' => [ 'title' => 'Bucket的存储类型', 'description' => 'Bucket的存储类型', '$ref' => '#/components/schemas/StorageClass', ], 'TransferAcceleration' => [ 'title' => 'Bucket传输', 'description' => 'Bucket传输', 'type' => 'string', 'enumValueTitles' => [ 'Enabled' => 'Enabled', 'Disabled' => 'Disabled', ], 'example' => 'Disabled', ], 'Versioning' => [ 'title' => 'Bucket多版本状态', 'description' => 'Bucket多版本状态', '$ref' => '#/components/schemas/BucketVersioningStatus', ], 'Owner' => [ 'title' => 'Bucket所有者', 'description' => 'Bucket所有者', '$ref' => '#/components/schemas/Owner', ], 'AccessControlList' => [ 'title' => 'Bucket权限', 'description' => 'Bucket权限', '$ref' => '#/components/schemas/AccessControlList', ], 'ServerSideEncryptionRule' => [ 'title' => 'Bucket服务端加密配置', 'description' => 'Bucket服务端加密配置', 'type' => 'object', 'properties' => [ 'SSEAlgorithm' => [ 'title' => '服务端加密类型', 'description' => '设置服务器端默认加密方式。'."\n" ."\n" .'取值：KMS、AES256、SM4。', 'type' => 'string', 'example' => 'KMS', ], 'KMSMasterKeyID' => [ 'title' => '服务端加密KMS密钥', 'description' => '服务端加密KMS密钥', 'type' => 'string', 'example' => ' '."\n" .'9468da86-3509-4f8d-a61e-6eab1eac****', ], 'KMSDataEncryption' => [ 'title' => '服务端加密KMS加密算法', 'description' => '指定Object的加密算法。如果未指定此选项，表明Object使用AES256加密算法。此选项仅当SSEAlgorithm取值为KMS有效。'."\n" ."\n" .'取值：SM4', 'type' => 'string', 'example' => 'SM4', ], ], ], 'BucketPolicy' => [ 'title' => 'Bucket日志配置', 'description' => 'Bucket日志配置', 'type' => 'object', 'properties' => [ 'LogBucket' => [ 'title' => '存储日志记录的Bucket名称。', 'description' => '存储日志记录的Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'LogPrefix' => [ 'title' => '存储日志文件的目录。', 'description' => '存储日志文件的目录。', 'type' => 'string', 'example' => 'log/', ], ], ], 'Comment' => [ 'title' => 'Bucket描述信息。', 'description' => 'Bucket描述信息。', 'type' => 'string', 'example' => 'An example bucket.', ], 'BlockPublicAccess' => [ 'title' => 'Bucket是否开启阻止公共访问', 'description' => 'Bucket是否开启阻止公共访问', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'BucketLoggingStatus' => [ 'title' => 'A short description of struct', 'description' => '存储访问日志状态信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'LoggingEnabled' => [ 'description' => '访问日志信息的容器。'."\n", 'required' => true, '$ref' => '#/components/schemas/LoggingEnabled', ], ], ], 'BucketProcessConfiguration' => [ 'title' => '存储空间图片处理配置', 'description' => 'Bucket图片处理配置', 'type' => 'object', 'properties' => [ 'CompliedHost' => [ 'title' => '域名', 'description' => '域名', 'type' => 'string', 'example' => 'Img', ], 'OssDomainSupportAtProcess' => [ 'title' => '是否支持OSS域名', 'description' => '是否支持OSS域名', 'type' => 'string', 'example' => 'disabled', ], 'SourceFileProtect' => [ 'title' => '原图保护', 'description' => '原图保护', 'type' => 'string', 'example' => 'disabled', ], 'SourceFileProtectSuffix' => [ 'title' => '原图保护后缀', 'description' => '原图保护后缀', 'type' => 'string', 'example' => 'gif', ], 'BucketChannelConfig' => [ 'title' => '图片处理频道配置', 'description' => '图片处理频道配置', '$ref' => '#/components/schemas/BucketChannelConfig', ], 'StyleDelimiters' => [ 'title' => '样式分隔符', 'description' => '样式分隔符', 'type' => 'string', 'example' => '-,|', ], ], ], 'BucketQoSConfiguration' => [ 'title' => '存储空间级别QoS配置信息', 'description' => '存储空间级别QoS配置信息', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => [ 'title' => '总上行带宽，单位Gbps', 'description' => '总上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'IntranetUploadBandwidth' => [ 'title' => '内网上行带宽，单位Gbps', 'description' => '内网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ExtranetUploadBandwidth' => [ 'title' => '公网上行带宽，单位Gbps', 'description' => '公网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalDownloadBandwidth' => [ 'title' => '总下行带宽，单位Gbps', 'description' => '总下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'IntranetDownloadBandwidth' => [ 'title' => '内网下行带宽，单位Gbps', 'description' => '内网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ExtranetDownloadBandwidth' => [ 'title' => '公网下行带宽，单位Gbps', 'description' => '公网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalQps' => [ 'title' => '总QPS', 'description' => '总QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'IntranetQps' => [ 'title' => '内网QPS', 'description' => '内网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'ExtranetQps' => [ 'title' => '公网QPS', 'description' => '公网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'Exclusive' => [ 'title' => '是否独立与用户级别QoS配置', 'description' => '是否独立与用户级别QoS配置', 'type' => 'boolean', 'example' => 'true', ], ], ], 'BucketResourceGroupConfiguration' => [ 'title' => 'Bucket资源组配置', 'description' => 'Bucket资源组配置', 'type' => 'object', 'properties' => [ 'ResourceGroupId' => [ 'title' => '所属资源组ID', 'description' => '所属资源组ID', '$ref' => '#/components/schemas/ResourceGroupId', ], ], ], 'BucketStat' => [ 'title' => 'BucketStat结构的容器。', 'description' => 'BucketStat结构的容器。', 'type' => 'object', 'properties' => [ 'Storage' => [ 'title' => 'Bucket的总存储量，单位字节。', 'description' => 'Bucket的总存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '39182324', ], 'ObjectCount' => [ 'title' => 'Bucket中总的Object数量。', 'description' => 'Bucket中总的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2034903', ], 'MultipartUploadCount' => [ 'title' => 'Bucket中已经初始化但还未完成（Complete）或者还未中止（Abort）的Multipart Upload数量。', 'description' => 'Bucket中已经初始化但还未完成（Complete）或者还未中止（Abort）的Multipart Upload数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '223', ], 'LiveChannelCount' => [ 'title' => 'Bucket中Live Channel的数量。', 'description' => 'Bucket中Live Channel的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'MultipartPartCount' => [ 'title' => 'Bucket中上传的Multipart分片的数量。', 'description' => 'Bucket中上传的Multipart分片的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '128', ], 'DeleteMarkerCount' => [ 'title' => 'Bucket中删除标记的数量。', 'description' => 'Bucket中删除标记的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'LastModifiedTime' => [ 'title' => '获取到的存储信息的时间点，格式为时间戳，单位为秒。', 'description' => '获取到的存储信息的时间点，格式为时间戳，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1643341269', ], 'StandardStorage' => [ 'title' => '标准存储类型的存储量，单位字节。', 'description' => '标准存储类型的存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '1600', ], 'StandardObjectCount' => [ 'title' => '标准存储类型的Object数量。', 'description' => '标准存储类型的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12323', ], 'InfrequentAccessStorage' => [ 'title' => '低频存储类型的计费存储量，单位字节。', 'description' => '低频存储类型的计费存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '1250', ], 'InfrequentAccessRealStorage' => [ 'title' => '低频存储类型的实际存储量，单位字节。', 'description' => '低频存储类型的实际存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '65754', ], 'InfrequentAccessObjectCount' => [ 'title' => '低频存储类型的Object数量。', 'description' => '低频存储类型的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '23', ], 'ArchiveStorage' => [ 'title' => '归档存储类型的计费存储量，单位字节。', 'description' => '归档存储类型的计费存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '30423', ], 'ArchiveRealStorage' => [ 'title' => '归档存储类型的实际存储量，单位字节。', 'description' => '归档存储类型的实际存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '5990', ], 'ArchiveObjectCount' => [ 'title' => '归档存储类型的Object数量。', 'description' => '归档存储类型的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40', ], 'ColdArchiveStorage' => [ 'title' => '冷归档存储类型的计费存储量，单位字节。', 'description' => '冷归档存储类型的计费存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '342', ], 'ColdArchiveRealStorage' => [ 'title' => '冷归档存储类型的实际存储量，单位字节。', 'description' => '冷归档存储类型的实际存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '2312', ], 'ColdArchiveObjectCount' => [ 'title' => '冷归档存储类型的Object数量。', 'description' => '冷归档存储类型的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '230', ], 'DeepColdArchiveStorage' => [ 'title' => '深度冷归档存储类型的计费存储量，单位字节。', 'description' => '深度冷归档存储类型的计费存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '120', ], 'DeepColdArchiveRealStorage' => [ 'title' => '深度冷归档存储类型的实际存储量，单位字节。', 'description' => '深度冷归档存储类型的实际存储量，单位字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '120', ], 'DeepColdArchiveObjectCount' => [ 'title' => '深度冷归档存储类型的Object数量。', 'description' => '深度冷归档存储类型的Object数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'MultipartPartStorage' => [ 'title' => 'Bucket中Multipart分片的存储量', 'description' => 'Bucket中Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], 'StandardMultipartPartCount' => [ 'title' => 'Bucket中标准类型的Multipart分片的数量', 'description' => 'Bucket中标准类型的Multipart分片的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '128', ], 'StandardMultipartPartStorage' => [ 'title' => 'Bucket中标准类型的Multipart分片的存储量', 'description' => 'Bucket中标准类型的Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], 'InfrequentMultipartPartCount' => [ 'title' => 'Bucket中低频类型的Multipart分片的数量', 'description' => 'Bucket中低频类型的Multipart分片的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '69', ], 'InfrequentMultipartPartStorage' => [ 'title' => 'Bucket中低频类型的Multipart分片的存储量', 'description' => 'Bucket中低频类型的Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], 'ArchiveMultipartPartCount' => [ 'title' => 'Bucket中归档类型的Multipart分片的数量', 'description' => 'Bucket中归档类型的Multipart分片的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '56', ], 'ArchiveMultipartPartStorage' => [ 'title' => 'Bucket中归档类型的Multipart分片的存储量', 'description' => 'Bucket中归档类型的Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], 'ColdArchiveMultipartPartCount' => [ 'title' => 'Bucket中冷归档类型的Multipart分片的数量', 'description' => 'Bucket中冷归档类型的Multipart分片的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '110', ], 'ColdArchiveMultipartPartStorage' => [ 'title' => 'Bucket中冷归档类型的Multipart分片的存储量', 'description' => 'Bucket中冷归档类型的Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], 'DeepColdArchiveMultipartPartCount' => [ 'title' => 'Bucket中深度冷归档类型的Multipart分片的数量', 'description' => 'Bucket中深度冷归档类型的Multipart分片的数量', 'type' => 'integer', 'format' => 'int64', 'example' => '110', ], 'DeepColdArchiveMultipartPartStorage' => [ 'title' => 'Bucket中深度冷归档类型的Multipart分片的存储量', 'description' => 'Bucket中深度冷归档类型的Multipart分片的存储量', 'type' => 'integer', 'format' => 'int64', 'example' => '481200', ], ], ], 'BucketVersioningStatus' => [ 'description' => '版本控制状态。取值如下：'."\n" .'- Enabled：开启版本控制状态。'."\n" .'- Suspended：暂停版本控制状态。', 'type' => 'string', 'example' => 'Enabled', 'enum' => [ 'Enabled', 'Suspended', ], ], 'BucketWormState' => [ 'title' => 'The status of the retention policy', 'description' => '合规保留策略所处的状态。'."\n" ."\n" .'可选值：'."\n" ."\n" .'- InProgress：合规保留策略创建后，该策略默认处于“InProgress”状态，且该状态的有效期为24小时。'."\n" .'- Locked：合规保留策略处于锁定状态。', 'type' => 'string', 'example' => 'Locked', 'enum' => [ 'InProgress', 'Locked', ], ], 'CORSConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'Bucket的CORS规则容器。', 'type' => 'object', 'properties' => [ 'CORSRule' => [ 'title' => 'description', 'description' => 'CORS规则的容器。'."\n" ."\n" .'每个Bucket最多允许10条CORS规则。上传的XML文档最大允许16 KB。', 'type' => 'array', 'items' => [ 'description' => 'CORS规则的信息。', '$ref' => '#/components/schemas/CORSRule', ], ], 'ResponseVary' => [ 'title' => 'description', 'description' => '是否返回Vary: Origin头。取值范围如下：'."\n" ."\n" .'- true：不管发送的是否是跨域请求或跨域请求是否成功，均会返回Vary: Origin头。'."\n" .'- false（默认值）：任何情况下均不返回Vary: Origin头。'."\n" ."\n" .'> 此字段不能单独配置，必须至少配置一项跨域规则才能生效。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], ], ], 'CORSRule' => [ 'title' => '保存单条跨域资源共享规则内容的容器。', 'description' => 'CORS规则的容器。'."\n" ."\n" .'每个Bucket最多允许10条CORS规则。上传的XML文档最大允许16 KB。', 'type' => 'object', 'properties' => [ 'AllowedOrigin' => [ 'title' => '指定允许的跨域请求来源。 OSS支持使用多个元素来指定多个允许的来源。', 'description' => '指定允许的跨域请求来源。', 'type' => 'array', 'items' => [ 'description' => '指定允许的跨域请求来源。'."\n" ."\n" .'OSS允许使用多个元素来指定多个允许的来源。多个元素之间用英文逗号(,)分隔。'."\n" ."\n" .'OSS仅允许使用一个星号（\\*）通配符。如果指定为星号（\\*），则表示允许所有来源的跨域请求。', 'type' => 'string', 'example' => '*', ], ], 'AllowedMethod' => [ 'title' => '指定允许的跨域请求方法。', 'description' => '指定允许的跨域请求方法。', 'type' => 'array', 'items' => [ 'description' => '指定允许的跨域请求方法。'."\n" ."\n" .'取值范围为GET、PUT、DELETE、POST、HEAD。', 'type' => 'string', 'example' => 'GET', ], ], 'AllowedHeader' => [ 'title' => '控制OPTIONS预取指令Access-Control-Request-Headers中指定的Header是否被允许。', 'description' => '控制OPTIONS预取指令Access-Control-Request-Headers中指定的Header是否被允许。在Access-Control-Request-Headers中指定的每个Header都必须在AllowedHeader中有对应的项。'."\n" ."\n" .'> 仅允许使用一个星号（*）通配符。', 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'x-oss-*', ], 'example' => 'Authorization', ], 'ExposeHeader' => [ 'title' => '指定允许用户从应用程序中访问的响应头。', 'description' => '指定允许用户从应用程序中访问的响应头。例如一个JavaScript的XMLHttpRequest对象。'."\n" ."\n" .'> 不允许使用星号（*）通配符。', 'type' => 'array', 'items' => [ 'description' => '指定允许用户从应用程序中访问的响应头。例如一个JavaScript的XMLHttpRequest对象。'."\n" ."\n" .'> 不允许使用星号（*）通配符。', 'type' => 'string', 'example' => 'x-oss-test', ], ], 'MaxAgeSeconds' => [ 'title' => '指定浏览器对特定资源的预取（OPTIONS）请求返回结果的缓存时间。单位为秒。', 'description' => '指定浏览器对特定资源的预取（OPTIONS）请求返回结果的缓存时间。单位为秒。'."\n" ."\n" .'单条CORS规则仅允许一个MaxAgeSeconds。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'CSVInput' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'FileHeaderInfo' => [ 'description' => '指定CSV文件头信息。'."\n" ."\n" .'- Use：该CSV文件有头信息，可以用CSV列名作为Select中的列名。'."\n" ."\n" .'- Ignore：该CSV文件有头信息，但不可用CSV列名作为Select中的列名。'."\n" ."\n" .'- None：该文件没有头信息，为默认值。', 'enumValueTitles' => [ 'Ignore' => 'Ignore', 'Use' => 'Use', 'None' => 'None', ], 'example' => 'Use', '$ref' => '#/components/schemas/FileHeaderInfo', ], 'RecordDelimiter' => [ 'title' => 'description', 'description' => '指定换行符，以Base64编码。默认值为\\n（可选）。未编码前的值最多为两个字符，以字符的ANSI值表示，例如在Java中使用\\n表示换行。', 'type' => 'string', 'example' => '\\n', ], 'FieldDelimiter' => [ 'title' => 'description', 'description' => '指定CSV列分隔符，以Base64编码。默认值为`,`（可选）。未编码前的值必须为一个字符，以字符的ANSI值表示，例如在Java中使用`,`表示逗号。', 'type' => 'string', 'example' => ',', ], 'QuoteCharacter' => [ 'title' => 'description', 'description' => '指定CSV的引号字符，以Base64编码。默认值为`\\”`（可选）。在CSV中引号内的换行符，列分隔符将被视作普通字符。未编码前的值必须为一个字符，以字符的ANSI值表示，例如在Java中使用`\\”`表示引号。', 'type' => 'string', 'example' => '\\”', ], 'CommentCharacter' => [ 'title' => 'description', 'description' => '指定CSV的注释符，以Base64编码。默认值为空（即没有注释符）。', 'type' => 'string', 'example' => '#', ], 'Range' => [ 'title' => 'description', 'description' => '指定查询文件的范围（可选）。支持两种格式：'."\n" ."\n" .'> 使用Range参数查询的文件需要有select meta。关于select meta的更多信息，请参见[CreateSelectObjectMeta](~~74054~~)。'."\n" ."\n" .'- 按行查询：line-range=start-end。例如line-range=10-20表示扫描第10行到第20行。'."\n" ."\n" .'- 按Split查询：split-range=start-end。例如split-range=10-20表示扫描第10到第20个split。'."\n" ."\n" .'
其中start和end均为inclusive。其格式和range get中的range参数一致。'."\n" .'
仅在文档是CSV或者JSON Type为LINES时使用。', 'type' => 'string', 'enumValueTitles' => [ 'line-range=start-end' => 'line-range=start-end', 'split-range=start-end' => 'split-range=start-end', ], 'example' => 'line-range=start-end', ], 'AllowQuotedRecordDelimiter' => [ 'title' => 'description', 'description' => '指定CSV内容是否含有在引号中的换行符。'."\n" .'
例如某一列值为`"abc\\ndef" `（此处`\\n`为换行）， 则该值需设置为true。当该值为false时，select支持header range的语义，可以更高效的进行分片查询。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'CSVOutput' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'RecordDelimiter' => [ 'title' => 'description', 'description' => '指定换行符，以Base64编码。未编码前的值最多为两个字符，以字符的ANSI值表示，例如在Java中使用`\\n`表示换行。'."\n" .'
默认值：`\\n`', 'type' => 'string', 'example' => '\\n', ], 'FieldDelimiter' => [ 'title' => 'description', 'description' => '指定CSV列分隔符，以Base64编码。未编码前的值必须为一个字符，以字符的ANSI值表示，例如在Java中使用`,`表示逗号。'."\n" .'
默认值：`,`', 'type' => 'string', 'example' => ',', ], ], ], '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' => '回调规则配置', 'type' => 'object', 'properties' => [ 'PolicyItem' => [ 'title' => '回调参数配置条目', 'description' => '回调参数配置条目', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PolicyName' => [ 'title' => '回调参数配置条目名称', 'description' => '回调参数配置条目名称', 'type' => 'string', 'example' => 'first', ], 'Callback' => [ 'title' => '回调地址', 'description' => '回调地址', 'type' => 'string', 'example' => 'e1wiY2Fsb...9keVwiOlwiYnVja2V0PSR7YnU=', ], 'CallbackVar' => [ 'title' => '回调参数', 'description' => '回调参数', 'type' => 'string', 'example' => 'Q2Fs...FcIiwgXCJ4OmJcIjpcImJcIn0=', ], ], ], ], ], ], 'CertificateConfiguration' => [ 'title' => '保存证书配置信息的容器。', 'description' => '保存Cname的证书配置信息的容器', 'type' => 'object', 'properties' => [ 'CertId' => [ 'title' => '证书ID。', 'description' => '证书ID。', 'type' => 'string', 'example' => '493****-cn-hangzhou', ], 'Certificate' => [ 'title' => '证书公钥。', 'description' => '证书公钥。', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----', ], 'PrivateKey' => [ 'title' => '证书私钥。', 'description' => '证书私钥。', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIDhDCCAmwCCQCFs8ixARsyrDANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMC **** -----END CERTIFICATE-----', ], 'PreviousCertId' => [ 'title' => '当前证书ID。如果Force值不为true，OSS Server会检查该值与当前证书ID是否匹配，不匹配则报错。', 'description' => '当前证书ID。如果Force值不为true，OSS Server会检查该值与当前证书ID是否匹配，不匹配则报错。', 'type' => 'string', 'example' => '493****-cn-hangzhou', ], 'Force' => [ 'title' => '是否强制覆盖证书。', 'description' => '是否强制覆盖证书。', 'type' => 'boolean', 'example' => 'true', ], 'DeleteCertificate' => [ 'title' => '是否删除证书。', 'description' => '是否删除证书。', 'type' => 'boolean', 'example' => 'false', ], ], ], 'Channel' => [ 'title' => '保存图片处理频道配置信息的容器', 'description' => 'xxx', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '图片处理频道的状态', 'description' => '图片处理频道的状态', 'type' => 'string', 'example' => 'enable', ], 'OrigPicForbidden' => [ 'title' => '是否禁止原图访问', 'description' => '是否禁止原图访问', 'type' => 'boolean', 'example' => 'true', ], 'UseStyleOnly' => [ 'title' => '是否仅允许使用样式进行图片处理', 'description' => '是否仅允许使用样式进行图片处理', 'type' => 'boolean', 'example' => 'false', ], 'AutoSetContentType' => [ 'title' => '是否自动设置Content-Type', 'description' => '是否自动设置Content-Type', 'type' => 'boolean', 'example' => 'true', ], 'UseSrcFormat' => [ 'title' => '是否使用源格式', 'description' => '是否使用源格式', 'type' => 'boolean', 'example' => 'true', ], 'SetAttachName' => [ 'title' => '是否设置Content-Disposition: attachment响应头', 'description' => '是否设置Content-Disposition: attachment响应头', 'type' => 'boolean', 'example' => 'false', ], 'Default404Pic' => [ 'title' => '默认404图片', 'description' => '默认404图片', 'type' => 'string', 'example' => '404.jpg', ], 'StyleDelimiters' => [ 'title' => '样式分隔符', 'description' => '样式分隔符', 'type' => 'string', 'example' => '-,|', ], ], ], 'ChannelInfo' => [ 'title' => '修改图片处理频道配置的请求结构', 'description' => '图片处理频道配置', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '频道名称', 'type' => 'string', 'example' => 'test-channel', ], 'Status' => [ 'title' => '是否生效', 'type' => 'string', 'example' => 'enable', ], 'OrigPicForbidden' => [ 'title' => '是否禁止原图访问', 'type' => 'boolean', 'example' => 'True', ], 'UseSrcFormat' => [ 'title' => '是否使用源格式', 'type' => 'boolean', 'example' => 'True', ], 'SetAttachName' => [ 'title' => '是否设置ContentDisposition响应头', 'type' => 'boolean', 'example' => 'True', ], 'UseStyleOnly' => [ 'title' => '是否只允许通过Style进行图片处理', 'type' => 'boolean', 'example' => 'False', ], 'AutoSetContentType' => [ 'title' => '是否自动设置ContentType', 'type' => 'boolean', 'example' => 'False', ], 'StyleDelimiters' => [ 'title' => '样式分隔符', 'type' => 'string', 'example' => '-', ], ], ], 'CnameCertificate' => [ 'title' => '证书信息的容器', 'description' => '证书信息', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '证书来源', 'description' => '证书来源', 'type' => 'string', 'enumValueTitles' => [ 'CAS' => '证书中心', 'Upload' => '旧版证书托管中用户自主上传的证书', ], 'example' => 'CAS', ], 'CertId' => [ 'title' => '证书ID', 'description' => '证书ID', 'type' => 'string', 'example' => '493****-cn-hangzhou', ], 'Status' => [ 'title' => '证书状态', 'description' => '证书状态', 'type' => 'string', 'enumValueTitles' => [ 'Enabled' => '使用证书', 'Disabled' => '未使用证书', ], 'example' => 'Enabled', ], 'CreationDate' => [ 'title' => '证书绑定时间', 'description' => '证书绑定时间', 'type' => 'string', 'example' => 'Wed, 15 Sep 2021 02:35:06 GMT', ], 'Fingerprint' => [ 'title' => '证书签名', 'description' => '证书签名', 'type' => 'string', 'example' => 'DE:01:CF:EC:7C:A7:98:CB:D8:6E:FB:1D:97:EB:A9:64:1D:4E:**:**', ], 'ValidStartDate' => [ 'title' => '证书有效期起始时间', 'description' => '证书有效期起始时间', 'type' => 'string', 'example' => 'Wed, 12 Apr 2023 10:14:51 GMT', ], 'ValidEndDate' => [ 'title' => '证书有效期终止时间', 'description' => '证书有效期终止时间', 'type' => 'string', 'example' => 'Mon, 4 May 2048 10:14:51 GMT', ], ], ], 'CnameInfo' => [ 'title' => 'A short description of struct', 'description' => 'Cname信息概况。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '自定义域名', 'description' => '自定义域名。', 'type' => 'string', 'example' => 'example.com', ], 'LastModified' => [ 'title' => '绑定自定义域名的时间', 'description' => '绑定自定义域名的时间。', 'type' => 'string', 'example' => '2021-09-15T02:35:07.000Z', ], 'Status' => [ 'title' => '域名所处的状态', 'description' => '域名所处状态。取值为：'."\n" ."\n" .'- Enabled：：启用该域名。'."\n" ."\n" .'- Disabled：禁用该域名。', 'type' => 'string', 'example' => 'Enabled', ], 'Certificate' => [ 'description' => '证书信息的容器。', '$ref' => '#/components/schemas/CnameCertificate', ], ], ], 'CnameSummary' => [ 'title' => 'A short description of struct', 'description' => 'Cname信息概况', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '自定义域名', 'description' => '自定义域名', 'type' => 'string', 'example' => 'example.com', ], 'LastModified' => [ 'title' => '绑定自定义域名的时间', 'description' => '绑定自定义域名的时间', 'type' => 'string', 'example' => '2021-09-15T02:35:07.000Z', ], 'Status' => [ 'title' => '域名所处的状态', 'description' => '域名所处的状态', 'type' => 'string', 'enumValueTitles' => [ 'Enabled' => '启用该域名', 'Disabled' => '禁用该域名', ], 'example' => 'Enabled', ], 'Certificate' => [ 'description' => '证书信息的容器', '$ref' => '#/components/schemas/CnameCertificate', ], ], ], 'CnameToken' => [ 'title' => 'A short description of struct', 'description' => 'CnameToken的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '绑定Cname的Bucket名称', 'description' => '绑定Cname的Bucket名称。', 'type' => 'string', 'example' => 'examplebucket', ], 'Cname' => [ 'title' => '绑定的Cname名称', 'description' => '绑定的Cname名称。', 'type' => 'string', 'example' => 'example.com', ], 'Token' => [ 'title' => 'Token 的内容', 'description' => 'OSS返回的CnameToken。', 'type' => 'string', 'example' => 'be1d49d863dea9ffeff3df7d6455****', ], 'ExpireTime' => [ 'title' => 'Token的有效期', 'description' => 'CnameToken的过期时间。', 'type' => 'string', 'example' => 'Wed, 23 Feb 2022 21:16:37 GMT', ], ], ], 'CommentConfiguration' => [ 'title' => 'bucket备注内容的容器', 'description' => '存放bucket备注内容的容器', 'type' => 'object', 'properties' => [ 'Comment' => [ 'title' => 'bucket的备注内容', 'type' => 'string', 'example' => 'comments', ], ], ], 'CommonHeaders' => [ 'title' => '存放用户自定义HTTP Header的容器', 'description' => '存放用户自定义HTTP Header配置的容器', 'type' => 'object', 'properties' => [ 'Header' => [ 'title' => '存放用户自定义HTTP Header的容器', 'description' => '存放用户自定义HTTP Header列表的容器', 'type' => 'array', 'items' => [ 'description' => '存放用户自定义HTTP Header的容器', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'HTTP Header的Key', 'description' => 'HTTP Header的Key', 'type' => 'string', 'example' => 'X-Content-Type-Options', ], 'Value' => [ 'title' => 'HTTP Header的Value', 'description' => 'HTTP Header的Value', 'type' => 'string', 'example' => 'nosniff', ], ], ], ], ], ], 'CommonPrefix' => [ 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result', 'description' => '如果请求中指定了delimiter参数，则OSS返回的响应中包含CommonPrefixes元素。该元素标明以delimiter结尾，并有共同前缀的Object名称的集合。'."\n", 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => 'The prefix that the names of returned objects contain', 'description' => '本次查询结果的前缀。', 'type' => 'string', 'example' => 'fun/', ], ], ], 'CompleteMultipartUpload' => [ 'title' => 'A short description of struct', 'description' => '保存CompleteMultipartUpload请求内容的容器。', 'type' => 'object', 'properties' => [ 'Part' => [ 'title' => 'The information of all parts', 'description' => '保存已上传Part信息的容器。'."\n", 'type' => 'array', 'items' => [ 'description' => '保存已上传Part信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'PartNumber' => [ 'title' => 'Part number of the part', 'description' => 'Part数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'ETag' => [ 'title' => 'The ETag of the part.', 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。'."\n" ."\n" .'通过CompleteMultipartUpload请求创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'> ETag值可以用于检查Object内容是否发生变化。不建议使用ETag作为Object内容的MD5来校验数据完整性。', 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****', ], ], ], ], ], ], 'CompressionType' => [ 'title' => 'A short description of struct', 'description' => '指定文件压缩类型（可选）。', 'type' => 'string', 'example' => 'None', 'enum' => [ 'None', 'GZIP', ], ], 'CopyObjectResult' => [ 'title' => 'A short description of struct', 'description' => 'CopyObject的结果。', 'type' => 'object', 'properties' => [ 'ETag' => [ 'title' => 'description', 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。'."\n" .' - 对于PutObject请求创建的Object，ETag值是其内容的MD5值。'."\n" .' - 对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'>ETag值可以用于检查Object内容是否发生变化。不建议使用ETag作为Object内容的MD5来校验数据完整性。'."\n" .'默认值：无', 'type' => 'string', 'example' => ' '."\n" .'5B3C1A2E053D763E1B002CC607C5****', ], 'LastModified' => [ 'title' => 'description', 'description' => '最近一次修改的时间。'."\n", 'type' => 'string', 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT', ], ], ], 'CopyPartResult' => [ 'title' => 'A short description of struct', 'description' => 'CopyObject的结果。', 'type' => 'object', 'properties' => [ 'ETag' => [ 'title' => 'A short description of ETag', 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。'."\n" .'通过CompleteMultipartUpload请求创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'> ETag值可以用于检查Object内容是否发生变化。不建议使用ETag作为Object内容的MD5来校验数据完整性。'."\n", 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****', ], 'LastModified' => [ 'title' => 'A short description of LastModified', 'description' => 'Part上传的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T07:01:34.000Z', ], ], ], 'CreateAccessPointConfiguration' => [ 'title' => '保存接入点信息的容器。', 'description' => '保存接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointName' => [ 'title' => '接入点名称', 'description' => '接入点名称。接入点命名规范如下：'."\n" ."\n" .'- 接入点名称在当前阿里云账号单个地域内唯一。'."\n" ."\n" .'- 不允许以-ossalias结尾。'."\n" ."\n" .'- 只能包括小写字母、数字和短划线（-），不能以短划线（-）开头或结尾。'."\n" ."\n" .'- 命名长度为3~19个字符。', 'type' => 'string', 'example' => 'ap-01', ], 'NetworkOrigin' => [ 'title' => '接入点网络来源。', 'description' => '接入点网络来源。', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', ], 'VpcConfiguration' => [ 'title' => '保存VPC网络来源信息的容器。', 'description' => '保存VPC网络来源信息的容器。', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', ], ], ], 'CreateAccessPointResult' => [ 'title' => '保存接入点信息的容器。', 'description' => '保存接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointArn' => [ 'title' => '接入点ARN。', 'description' => '接入点ARN。', '$ref' => '#/components/schemas/AccessPointArn', ], 'Alias' => [ 'title' => '接入点别名。', 'description' => '接入点别名。', '$ref' => '#/components/schemas/AccessPointAlias', ], ], ], 'CreateBucketConfiguration' => [ 'title' => 'The configuration of a bucket.', 'description' => 'Bucket存储类型和数据容灾类型的配置信息。', 'type' => 'object', 'properties' => [ 'StorageClass' => [ 'description' => 'Bucket的存储类型。 取值范围如下：'."\n" ."\n" .'- Standard（默认）：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'- ColdArchive：冷归档存储', 'enumValueTitles' => [], '$ref' => '#/components/schemas/StorageClass', ], 'DataRedundancyType' => [ 'description' => '指定Bucket的数据容灾类型。'."\n" ."\n" .'- LRS（默认值）'."\n" .'
本地冗余LRS，将您的数据冗余存储在同一个可用区的不同存储设备上，可支持两个存储设备并发损坏时，仍维持数据不丢失，可正常访问。'."\n" ."\n" .'- ZRS'."\n" .'
同城冗余ZRS采用多可用区（AZ）机制，将您的数据冗余存储在同一地域（Region）的3个可用区。可支持单个可用区（机房）整体故障时（例如断电、火灾等），仍然能够保障数据的正常访问。'."\n" .'> 归档类型的Bucket不支持设置同城冗余。', 'enumValueTitles' => [], '$ref' => '#/components/schemas/DataRedundancyType', ], ], ], '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', ], ], ], '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' => 'CreateSelectMeta可选的x-oss-process参数', 'type' => 'string', 'example' => 'csv/meta', ], 'DataAccelerator' => [ 'title' => '数据湖加速器配置信息', 'description' => '数据湖加速器信息', 'type' => 'object', 'properties' => [ 'BasicInfomation' => [ 'title' => '信息', 'type' => 'object', 'properties' => [ 'AcceleratePaths' => [ 'title' => '缓存路径集合', '$ref' => '#/components/schemas/AcceleratePaths', ], 'CreationDate' => [ 'title' => '创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1731394193189', ], 'Quota' => [ 'title' => '容量', 'type' => 'string', 'example' => '1024000', ], 'AvailableZone' => [ 'title' => '可用区', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'QuotaFrozenUtil' => [ 'title' => '加速器quota解冻时间戳，即该时间戳之前quota 不允许修改quota', 'type' => 'integer', 'format' => 'int64', 'example' => '1731394193189', ], ], ], 'BucketName' => [ 'title' => '桶名', 'type' => 'string', 'example' => 'test-acc-bucket', ], 'Name' => [ 'title' => '加速器名', 'type' => 'string', 'example' => 'test-acc-bucket_data-acc', ], ], ], 'DataAcceleratorConfiguration' => [ 'title' => '创建数据湖加速器的参数', 'type' => 'object', 'properties' => [ 'AvailableZone' => [ 'title' => '加速器所在可用区', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], 'Quota' => [ 'title' => '加速器容量', 'type' => 'string', 'example' => '102400', ], 'AcceleratePaths' => [ 'title' => '加速路径集合', '$ref' => '#/components/schemas/AcceleratePaths', ], ], ], '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', ], ], ], ], ], '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/', ], ], ], ], ], 'DataLakeStorageTransferJobHistoryId' => [ 'title' => '数据湖元数据转换历史任务ID', 'description' => '数据湖元数据转换历史任务ID', 'type' => 'object', 'properties' => [ 'HistoryId' => [ 'title' => '数据湖元数据转换历史任务ID', 'type' => 'string', 'example' => 'abcdef03370a4b32ac6bc69eb1123456', ], ], ], 'DataLakeStorageTransferJobId' => [ 'title' => '数据湖元数据转换任务ID', 'description' => '数据湖元数据转换任务ID', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '数据湖元数据转换任务ID', 'type' => 'string', 'example' => 'abcde787e3c04af2af290ec52d123456', ], ], ], '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', ], ], ], ], 'DataRedundancyType' => [ 'title' => 'The type of disaster recovery for a bucket.', 'description' => 'Bucket的数据容灾类型。取值范围如下：'."\n" ."\n" .'- LRS（默认） ：本地冗余LRS，将您的数据冗余存储在同一个可用区的不同存储设备上，可支持两个存储设备并发损坏时，仍维持数据不丢失，可正常访问。'."\n" .'- ZRS：同城冗余ZRS，采用多可用区（AZ）机制，将您的数据冗余存储在同一地域（Region）的3个可用区。可支持单个可用区（机房）整体故障时（例如断电、火灾等），仍然能够保障数据的正常访问。'."\n" .'>归档类型的Bucket不支持设置同城冗余。', 'type' => 'string', 'example' => 'LRS', 'default' => 'LRS', 'enum' => [ 'LRS', 'ZRS', ], ], 'Delete' => [ 'title' => 'A short description of struct', 'description' => '保存DeleteMultipleObjects请求的容器。', 'type' => 'object', 'properties' => [ 'Quiet' => [ 'title' => 'description', 'description' => '打开简单响应模式的开关。'."\n" .'DeleteMultipleObjects提供以下两种消息返回模式：'."\n" .' - 简单模式（quiet）：OSS不返回消息体。'."\n" .' - 详细模式（verbose）：OSS返回的消息体中会包含所有删除Object的结果。默认采用详细模式。'."\n" ."\n" .'有效值：**true**（开启简单模式）、**false**（开启详细模式）'."\n" .'默认值：**false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'Object' => [ 'title' => 'description', 'description' => '保存一个Object信息的容器。', 'type' => 'array', 'items' => [ 'description' => '对象标识符。', '$ref' => '#/components/schemas/ObjectIdentifier', ], ], ], ], 'DeleteMarkerEntry' => [ 'title' => 'Information about the delete marker', 'description' => '保存删除标记的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'The name of the object', 'description' => 'Object的名称。', 'type' => 'string', 'example' => 'example', ], 'VersionId' => [ 'title' => 'The version ID of the object', 'description' => 'Object的版本ID。'."\n", 'type' => 'string', 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****', ], 'IsLatest' => [ 'title' => 'Indicates whether the version is the current version', 'description' => 'Object是否为当前版本。'."\n" .'取值：'."\n" ."\n" .'- true：Object为当前版本。'."\n" ."\n" .'- false：Object为非当前版本。'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', 'default' => 'false', ], 'LastModified' => [ 'title' => 'The last modified time of the object', 'description' => 'Object最后被修改的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-04-09T07:27:28.000Z', ], 'Owner' => [ 'description' => '保存Bucket拥有者信息的容器。', '$ref' => '#/components/schemas/Owner', ], ], ], 'DeletedObject' => [ 'title' => 'A short description of struct', 'description' => '保存被成功删除的Object的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'description', 'description' => '被删除Object的名字。', 'type' => 'string', 'example' => 'multipart.data', ], 'DeleteMarker' => [ 'title' => 'description', 'description' => '表示该版本是否为删除标记。true为是，false为否。'."\n" .'> 只有当创建删除标记和永久删除删除标记时，才会返回该元素，且值为true。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'DeleteMarkerVersionId' => [ 'title' => 'description', 'description' => '表示删除标记对应的版本ID。', 'type' => 'string', 'example' => 'CAEQMhiBgIDB3aWB0BYiIGUzYTA3YzliMzVmNzRkZGM5NjllYTVlMjYyYWEy****', ], 'VersionId' => [ 'title' => 'description', 'description' => 'Object对应的版本ID。', 'type' => 'string', 'example' => 'CAEQNRiBgIDyz.6C0BYiIGQ2NWEwNmVhNTA3ZTQ3MzM5ODliYjM1ZTdjYjA4****', ], ], ], 'EncodeType' => [ 'title' => 'specifies the encoding method to use', 'description' => '指明返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，那返回的结果会对Key进行编码。'."\n", 'type' => 'string', 'example' => 'url', 'enum' => [ 'url', ], ], 'Endpoint' => [ 'title' => '访问域名', 'description' => '访问域名', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', ], 'Error' => [ 'title' => 'Error responses', 'description' => '错误响应。', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => 'The error code that OSS returns to the user', 'description' => '错误码。', 'type' => 'string', 'example' => 'AccessDenied', ], 'Message' => [ 'title' => 'The detailed error message provided by OSS', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Anonymous user has no right to access this bucket.', ], 'RequestId' => [ 'title' => 'The ID that uniquely identifies a request', 'description' => '请求ID。', 'type' => 'string', 'example' => '654D97A16F8C26383287EAAF', ], 'HostId' => [ 'title' => 'The ID of the host in the accessed OSS cluster', 'description' => '访问OSS所用的域名。', 'type' => 'string', 'example' => 'example-bucket.oss-cn-hangzhou.aliyuncs.com', ], ], ], 'ErrorDocument' => [ 'title' => '保存错误页面配置信息的容器。', 'description' => '404页面的容器。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '错误页面文件，如果访问的Object不存在，则返回此错误页面。', 'description' => '错误页面。'."\n", 'type' => 'string', 'example' => 'error.html', ], 'HttpStatus' => [ 'title' => '返回错误页面时的HTTP状态码。默认404。', 'description' => '返回错误页面时的HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '404', ], ], ], 'EventNotificationConfiguration' => [ 'title' => '存储空间事件通知配置信息', 'description' => '存储空间事件通知配置信息', 'type' => 'object', 'properties' => [ 'FunctionComputeConfiguration' => [ 'title' => '存储空间函数计算事件通知服务配置信息', 'description' => '存储空间函数计算事件通知服务配置信息', 'type' => 'array', 'items' => [ 'description' => '函数计算配置', '$ref' => '#/components/schemas/FunctionComputeConfiguration', ], ], ], ], 'ExtendWormConfiguration' => [ 'title' => 'The configuration of extending the retention period of objects in a bucket', 'description' => '根节点。', 'type' => 'object', 'properties' => [ 'RetentionPeriodInDays' => [ 'title' => 'The number of days for which objects can be retained', 'description' => '指定Object的保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '366', ], ], ], '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' => 'A short description of struct', 'description' => '指定CSV文件头信息（可选）。'."\n" .'取值：'."\n" .' - Use：该CSV文件有头信息，可以用CSV列名作为Select中的列名。'."\n" .' - Ignore：该CSV文件有头信息，但不可用CSV列名作为Select中的列名。'."\n" .' - None：该文件没有头信息，为默认值。'."\n" ."\n", 'type' => 'string', 'example' => 'Use', 'enum' => [ 'USE', 'IGNORE', 'NONE', ], ], 'FunctionComputeConfiguration' => [ 'title' => '函数计算服务配置项', 'description' => '函数计算服务配置项', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '配置项ID', 'description' => '配置项ID', 'type' => 'string', 'example' => '1', ], 'Event' => [ 'title' => '事件列表', 'description' => '事件列表', 'type' => 'array', 'items' => [ 'description' => '事件名称', 'type' => 'string', 'example' => 'ObjectCreated:PutObject', ], ], 'Filter' => [ 'title' => 'Object过滤配置', 'description' => 'Object过滤配置', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'Object过滤配置键', 'description' => 'Object过滤配置键', 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => 'Object前缀', 'description' => 'Object前缀', 'type' => 'string', 'example' => 'prod', ], 'Suffix' => [ 'title' => 'Object后缀', 'description' => 'Object后缀', 'type' => 'string', 'example' => '.jpb', ], ], ], ], ], 'Function' => [ 'title' => '函数计算配置', 'description' => '函数计算配置', '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', ], ], ], ], ], 'GetAccessPointResult' => [ 'title' => '保存接入点信息的容器。', 'description' => '保存接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointName' => [ 'description' => '接入点名称。', '$ref' => '#/components/schemas/AccessPointName', ], 'Bucket' => [ 'title' => '配置接入点的Bucket名称。', 'description' => '配置接入点的Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'AccountId' => [ 'title' => '配置接入点的阿里云账号UID。', 'description' => '配置接入点的阿里云账号UID。', 'type' => 'string', 'example' => '10378****8768', ], 'NetworkOrigin' => [ 'title' => '接入点网络来源。返回值如下： vpc：限制仅支持通过指定的VPC ID访问接入点。 internet：同时持通过外网和内网Endpoint互联网访问接入点。', 'description' => '接入点网络来源。返回值如下： vpc：限制仅支持通过指定的VPC ID访问接入点。 internet：同时持通过外网和内网Endpoint互联网访问接入点。', '$ref' => '#/components/schemas/AccessPointNetworkOrigin', ], 'VpcConfiguration' => [ 'title' => '保存VPC网络来源信息的容器。', 'description' => '保存VPC网络来源信息的容器。', '$ref' => '#/components/schemas/AccessPointVpcConfiguration', ], 'AccessPointArn' => [ 'description' => '接入点ARN。', '$ref' => '#/components/schemas/AccessPointArn', ], 'Alias' => [ 'description' => '接入点别名。', '$ref' => '#/components/schemas/AccessPointAlias', ], 'Status' => [ 'description' => '接入点所处状态。', '$ref' => '#/components/schemas/AccessPointStatus', ], 'Endpoints' => [ 'title' => '保存接入点网络来源信息的容器。', 'description' => '保存接入点网络来源信息的容器。', 'type' => 'object', 'properties' => [ 'PublicEndpoint' => [ 'title' => '接入点的外网Endpoint。', 'description' => '接入点的外网Endpoint。', '$ref' => '#/components/schemas/Endpoint', ], 'InternalEndpoint' => [ 'title' => '接入点的内网Endpoint。', 'description' => '接入点的内网Endpoint。', '$ref' => '#/components/schemas/Endpoint', ], ], ], 'PublicAccessBlockConfiguration' => [ 'title' => '保存接入点阻止公共访问的配置', 'description' => '保存接入点阻止公共访问的配置', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], 'CreationDate' => [ 'title' => '接入点创建时间。', 'description' => '接入点创建时间。', 'type' => 'string', 'example' => 'Sat, 27 Apr 2024 15:04:14 GMT', ], ], ], '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', ], ], ], 'Grant' => [ 'description' => 'Bucket的读写权限ACL。'."\n" ."\n", '$ref' => '#/components/schemas/ObjectACL', ], 'HttpsConfiguration' => [ 'title' => '存储空间安全传输层配置', 'description' => '存储空间TLS版本配置', 'type' => 'object', 'properties' => [ 'TLS' => [ 'title' => '存储空间TLS版本配置', 'description' => '存储空间TLS版本配置', 'type' => 'object', 'properties' => [ 'Enable' => [ 'title' => '是否启用TLS版本配置', 'description' => '是否启用TLS版本配置', 'type' => 'boolean', 'required' => true, 'enumValueTitles' => [ 'true' => '开启TLS版本设置', 'false' => '关闭TLS版本设置', ], 'example' => 'true', ], 'TLSVersion' => [ 'title' => 'TLS版本列表', 'description' => 'TLS版本列表', 'type' => 'array', 'items' => [ 'description' => 'TLS版本', 'type' => 'string', 'enumValueTitles' => [ 'TLSv1.3' => 'TLSv1.3', 'TLSv1.2' => 'TLSv1.2', 'TLSv1.1' => 'TLSv1.1', 'TLSv1.0' => 'TLSv1.0', ], 'example' => 'TLSv1.2', ], ], ], ], 'CipherSuite' => [ 'title' => '存储空间加密套件配置', 'description' => '存储空间加密套件配置', 'type' => 'object', 'properties' => [ 'Enable' => [ 'title' => '是否启用加密套件配置', 'description' => '是否启用加密套件配置', 'type' => 'boolean', 'example' => 'true', ], 'StrongCipherSuite' => [ 'title' => '是否使用强加密套件', 'description' => '是否使用强加密套件', 'type' => 'boolean', 'example' => 'false', ], 'CustomCipherSuite' => [ 'title' => '自定义加密套件', 'description' => '自定义加密套件', 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'ECDHE-ECDSA-AES128-SHA256', ], ], 'TLS13CustomCipherSuite' => [ 'title' => '用于TLS1.3版本的自定义加密套件', 'description' => '用于TLS1.3版本的自定义加密套件', 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'ECDHE-ECDSA-AES256-CCM8', ], ], ], ], ], ], 'IncrementInventorySchedule' => [ 'title' => '增量清单导出周期信息的容器', 'type' => 'object', 'properties' => [ 'Frequency' => [ 'title' => '描述增量清单文件导出的周期，单位为秒，目前固定为10分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '600', ], ], ], 'IncrementalInventory' => [ 'title' => '增量清单的配置容器', 'type' => 'object', 'properties' => [ 'IsEnabled' => [ 'title' => '增量清单是否启用', 'type' => 'boolean', 'example' => 'true', ], 'Schedule' => [ 'title' => '增量清单导出周期的容器', '$ref' => '#/components/schemas/IncrementInventorySchedule', ], 'OptionalFields' => [ 'title' => '增量清单文件属性的配置容器', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '增量清单导出字段列表', 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'Etag', ], ], ], ], ], ], 'IndexDocument' => [ 'title' => 'A short description of struct', 'description' => '默认主页的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Suffix' => [ 'title' => '默认主页。', 'description' => '默认主页。', 'type' => 'string', 'example' => 'index.html', ], 'SupportSubDir' => [ 'title' => '访问子目录时，是否支持跳转到子目录下的默认主页。', 'description' => '访问子目录时，是否支持转到子目录下的默认主页。取值范围如下：'."\n" .' - **true**：转到子目录下的默认主页。'."\n" .' - **false**（默认）：不转到子目录下的默认主页，而是转到根目录下的默认主页。'."\n" ."\n" .'假设默认主页为index.html，要访问`bucket.oss-cn-hangzhou.aliyuncs.com/subdir/`，如果设置**SupportSubDir**为false，则转到`bucket.oss-cn-hangzhou.aliyuncs.com/index.html`；如果设置**SupportSubDir**为true，则转到`bucket.oss-cn-hangzhou.aliyuncs.com/subdir/index.html`。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'Type' => [ 'title' => '设置默认主页后，访问以非正斜线（/）结尾的Object，且该Object不存在时的行为。', 'description' => '设置默认主页后，访问以非正斜线（/）结尾的Object，且该Object不存在时的行为。 只有设置**SupportSubDir**为true时才生效，且生效的顺序在RoutingRule之后、ErrorFile之前。'."\n" .'假设默认主页为index.html，要访问的文件路径为`bucket.oss-cn-hangzhou.aliyuncs.com/abc`，且abc这个Object不存在，此时**Type**的不同取值对应的行为如下：'."\n" .' - **0**（默认）：检查abc/index.html是否存在（即`Object + 正斜线（/）+ 主页`的形式），如果存在则返回302，Location头为`/abc/`的URL编码（即`正斜线（/） + Object + 正斜线（/）`的形式），如果不存在则返回404，继续检查ErrorFile。'."\n" .' - **1**：直接返回404，报错NoSuchKey，继续检查ErrorFile。'."\n" .' - **2**：检查abc/index.html是否存在，如果存在则返回该Object的内容；如果不存在则返回404，继续检查ErrorFile。'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'InitiateWormConfiguration' => [ 'title' => 'The confiiguration of a retention policy', 'description' => '根节点。', 'type' => 'object', 'properties' => [ 'RetentionPeriodInDays' => [ 'title' => 'The number of days for which objects can be retained', 'description' => '指定Object保留天数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '365', ], ], ], 'InputSerialization' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'CompressionType' => [ 'description' => '指定文件压缩类型（可选）。目前不支持任何压缩，即取值只能是None。', 'example' => 'None', '$ref' => '#/components/schemas/CompressionType', ], 'CSV' => [ 'description' => '指定CSV输入格式。', '$ref' => '#/components/schemas/CSVInput', ], 'JSON' => [ 'description' => '指定JSON输入格式。', '$ref' => '#/components/schemas/JSONInput', ], ], ], 'InventoryConfiguration' => [ 'title' => '保存单条存储空间清单规则的容器。', 'description' => '存储清单配置信息的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '自定义清单名称，要求如下： 清单名称在当前Bucket下必须全局唯一。 清单名称长度不能超过192个字符。', 'description' => '自定义清单名称，清单名称在当前Bucket下必须唯一。', 'type' => 'string', 'example' => 'report1', ], 'IsEnabled' => [ 'title' => '清单功能是否启用的标识。 有效值： true：启用清单功能。 false：不启用清单功能。', 'description' => '是否启用清单功能。取值范围如下：'."\n" ."\n" .'- true：启用清单功能。'."\n" .'- false：不启用清单功能。'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'Destination' => [ 'title' => '保存存放清单结果位置的容器。', 'description' => '存放清单结果。', '$ref' => '#/components/schemas/InventoryDestination', ], 'Schedule' => [ 'title' => '存放清单导出周期信息的容器。', 'description' => '存放清单导出周期信息的容器。', '$ref' => '#/components/schemas/InventorySchedule', ], 'Filter' => [ 'title' => '存放清单筛选规则的容器。', 'description' => '清单筛选的前缀。指定前缀后，清单将筛选出符合前缀设置的对象。', '$ref' => '#/components/schemas/InventoryFilter', ], 'IncludedObjectVersions' => [ 'title' => '是否在清单中包含Object版本信息。 有效值： All：导出Object的所有版本信息。 Current：导出Object的当前版本信息。', 'description' => '是否在清单中包含Object版本信息。'."\n" .'取值范围如下：'."\n" ."\n" .'- All：导出Object的所有版本信息。'."\n" ."\n" .'- Current：导出Object的当前版本信息。'."\n", 'type' => 'string', 'enumValueTitles' => [ 'All' => 'All', 'Current' => 'Current', ], 'example' => 'All', ], 'OptionalFields' => [ 'title' => '设置清单结果中包含的配置项。', 'description' => '清单结果中包含的配置项列表。', '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', ], ], ], ], 'IncrementalInventory' => [ '$ref' => '#/components/schemas/IncrementalInventory', ], ], ], 'InventoryDestination' => [ 'title' => '保存清单结果存放位置的容器。', 'description' => '存放清单结果的信息。', 'type' => 'object', 'properties' => [ 'OSSBucketDestination' => [ 'title' => '清单结果导出后存放的Bucket信息。', 'description' => '清单结果导出后存放的Bucket信息。', '$ref' => '#/components/schemas/InventoryOSSBucketDestination', ], ], ], 'InventoryEncryption' => [ 'title' => '存放清单文件的加密方式的容器。', 'description' => '清单文件的加密方式。', 'type' => 'object', 'properties' => [ 'SSE-OSS' => [ 'title' => '保存SSE-OSS加密方式的容器。', 'description' => '保存SSE-OSS加密方式的容器。', '$ref' => '#/components/schemas/SSEOSS', ], 'SSE-KMS' => [ 'title' => '保存SSE-KMS加密密钥的容器。', 'description' => '保存SSE-KMS加密密钥的容器。', '$ref' => '#/components/schemas/SSEKMS', ], ], ], 'InventoryFilter' => [ 'title' => '清单筛选规则。制定后，清单会按照规则筛选出符合条件的对象。', 'description' => '清单筛选的前缀。指定前缀后，清单将筛选出符合前缀设置的对象。', 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => '筛选规则的匹配前缀。', 'description' => '筛选规则的匹配前缀。', 'type' => 'string', 'example' => 'Pics/', ], 'LastModifyBeginTimeStamp' => [ 'title' => '筛选文件最后修改时间的起始时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', 'description' => '筛选文件最后修改时间的起始时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', 'type' => 'integer', 'format' => 'int64', 'example' => '1637883649', ], 'LastModifyEndTimeStamp' => [ 'title' => '筛选文件最后修改时间的终止时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', 'description' => '筛选文件最后修改时间的终止时间戳，单位为秒。 取值范围：[1262275200, 253402271999]', 'type' => 'integer', 'format' => 'int64', 'example' => '1638347592', ], 'LowerSizeBound' => [ 'title' => '筛选文件的最小大小，单位为B。 取值范围：大于等于0 B，小于等于48.8 TB。', 'description' => '筛选文件的最小大小，单位为B。 取值范围：大于等于0 B，小于等于48.8 TB。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'UpperSizeBound' => [ 'title' => '筛选文件的最大大小，单位为B。 取值范围：大于0 B，小于等于48.8 TB。', 'description' => '筛选文件的最大大小，单位为B。 取值范围：大于0 B，小于等于48.8 TB。', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', ], 'StorageClass' => [ 'title' => '筛选文件的存储类型，支持指定多种存储类型。 可选值： Standard：标准存储 IA：低频访问 Archive：归档存储 ColdArchive：冷归档存储 All（默认值）：所有存储类型', 'description' => '筛选文件的存储类型，支持指定多种存储类型。 可选值： Standard：标准存储 IA：低频访问 Archive：归档存储 ColdArchive：冷归档存储 All（默认值）：所有存储类型', 'type' => 'string', 'example' => 'All', ], ], ], 'InventoryFormat' => [ 'title' => '清单文件的文件格式。 清单文件导出后的格式为使用GZIP压缩的CSV文件。 有效值：CSV', 'description' => '取值范围为CSV。', 'type' => 'string', 'example' => 'CSV', 'enum' => [ 'CSV', ], ], 'InventoryFrequency' => [ 'title' => '清单文件导出的周期。 有效值： Daily：按天导出清单文件。 Weekly：按周导出清单文件。', 'description' => '清单文件导出的周期。'."\n" ."\n" .'有效值：'."\n" .'- Daily：按天导出清单文件。'."\n" .'- Weekly：按周导出清单文件。', 'type' => 'string', 'enumValueTitles' => [ 'Daily' => 'Daily', 'Weekly' => 'Weekly', ], 'example' => 'Daily', 'enum' => [ 'Daily', 'Weekly', ], ], 'InventoryIncludedObjectVersions' => [ 'title' => 'Specifies whether versioning information about the objects is included in the inventory list', 'description' => '是否在清单中包含Object版本信息。取值范围如下：'."\n" ."\n" .'- All：导出Object的所有版本信息。'."\n" .'- Current：导出Object的当前版本信息。', 'type' => 'string', 'enumValueTitles' => [ 'All' => 'All', 'Current' => 'Current', ], 'example' => 'All', 'enum' => [ 'All', 'Current', ], ], 'InventoryOSSBucketDestination' => [ 'title' => '清单结果导出后存放的Bucket信息。', 'description' => '清单结果导出后存放的Bucket信息。'."\n", 'type' => 'object', 'properties' => [ 'Format' => [ 'title' => '清单文件的文件格式。', 'description' => '清单文件的文件格式。 清单文件导出后的格式为使用GZIP压缩的CSV文件。', '$ref' => '#/components/schemas/InventoryFormat', ], 'AccountId' => [ 'title' => 'Bucket所有者授予的账户ID。', 'description' => 'Bucket所有者授予的账户ID。', 'type' => 'string', 'example' => '100000000000000', ], 'RoleArn' => [ 'title' => '具有读取源Bucket所有文件和向目标Bucket写入文件权限的角色名，格式为acs:ram::uid:role/rolename。', 'description' => '具有读取源Bucket所有文件和向目标Bucket写入文件权限的角色名，格式为`acs:ram::uid:role/rolename`。', 'type' => 'string', 'example' => 'acs:ram::100000000000000:role/AliyunOSSRole', ], 'Bucket' => [ 'title' => '存放导出的清单文件的Bucket。', 'description' => '存放导出的清单文件的Bucket。'."\n", 'type' => 'string', 'example' => 'acs:oss:::bucket_0001', ], 'Prefix' => [ 'title' => '清单文件的存储路径前缀。', 'description' => '清单文件的存储路径前缀。', 'type' => 'string', 'example' => 'prefix1/', ], 'Encryption' => [ 'title' => '清单文件的加密方式。有效值： SSE-OSS：使用OSS完全托管密钥进行加解密。 SSE-KMS：使用KMS托管的默认CMK（Customer Master Key）或指定CMK进行加解密。', 'description' => '清单文件的加密方式。', '$ref' => '#/components/schemas/InventoryEncryption', ], ], ], 'InventoryOptionalField' => [ 'title' => '清单结果中包含的配置项。 Size：Object的大小。 LastModifiedDate：Object的最后修改时间。 ETag：Object的ETag值，用于标识Object的内容。 StorageClass：Object的存储类型。 IsMultipartUploaded：是否为通过分片上传方式上传的Object。 EncryptionStatus：Object是否加密。 ObjectAcl：Object的读写权限。 TaggingCount：标签个数。 ObjectType：Object类型。 Crc64：Object的CRC64。', 'description' => '清单结果中包含的配置项。'."\n" ."\n" .'- Size：Object的大小。'."\n" .'- LastModifiedDate：Object的最后修改时间。'."\n" .'- ETag：Object的ETag值，用于标识Object的内容。'."\n" .'- StorageClass：Object的存储类型。'."\n" .'- IsMultipartUploaded：是否为通过分片上传方式上传的Object。'."\n" .'- EncryptionStatus：Object是否加密。', 'type' => 'string', 'example' => 'Size', 'enum' => [ 'Size', 'LastModifiedDate', 'ETag', 'StorageClass', 'IsMultipartUploaded', 'EncryptionStatus', ], ], 'InventorySchedule' => [ 'title' => '存放清单导出周期信息的容器。', 'description' => 'Contains the frequency that inventory lists are exported', 'type' => 'object', 'properties' => [ 'Frequency' => [ 'title' => '清单文件导出的周期。', 'description' => '清单文件导出的周期。'."\n" ."\n" .'有效值：'."\n" ."\n" .'Daily：按天导出清单文件。'."\n" ."\n" .'Weekly：按周导出清单文件。', '$ref' => '#/components/schemas/InventoryFrequency', ], ], ], 'JSONInput' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '指定输入JSON的类型。', 'enumValueTitles' => [ ' LINES' => ' LINES', 'DOCUMENT' => 'DOCUMENT', ], 'example' => 'DOCUMENT', '$ref' => '#/components/schemas/JSONType', ], 'Range' => [ 'title' => 'description', 'description' => '指定查询文件的范围（可选）。支持两种格式：'."\n" .'> 使用Range参数查询的文件需要有select meta。关于select meta的更多信息，请参见[CreateSelectObjectMeta](~~74054~~)。'."\n" ."\n" .'- 按行查询：line-range=start-end。例如line-range=10-20表示扫描第10行到第20行。'."\n" ."\n" .'- 按Split查询：split-range=start-end。例如split-range=10-20表示扫描第10到第20个split。'."\n" ."\n" .'
其中start和end均为inclusive。其格式和range get中的range参数一致。'."\n" .'
仅在文档是CSV或者JSON Type为LINES时使用。', 'type' => 'string', 'enumValueTitles' => [ 'line-range=start-end' => 'line-range=start-end', 'split-range=start-end' => 'split-range=start-end', ], 'example' => 'line-range=start-end', ], 'ParseJsonNumberAsString' => [ 'title' => 'description', 'description' => '将JSON中的数字（整数和浮点数）解析成字符串。目前JSON中的浮点数解析时会损失精度，如果要完整保留原始数据，则推荐用该选项。如果需要进行数值计算，则可以在SQL中cast成需要的格式，例如int、double、decimal。'."\n" .'
默认值： false', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], ], ], 'JSONOutput' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'RecordDelimiter' => [ 'title' => 'description', 'description' => '指定换行符，以Base64编码。未编码前的值最多为两个字符，以字符的ANSI值表示，例如在Java中使用`\\n`表示换行。'."\n" .'
默认值：`\\n`', 'type' => 'string', 'example' => '\\n', ], ], ], 'JSONType' => [ 'title' => 'A short description of struct', 'description' => '指定输入JSON的类型。'."\n" .'取值：'."\n" .'- DOCUMENT：输入数据中的单个JSON对象可以跨行。'."\n" .'- LINES：输入数据中的每一行都包含一个JSON对象。', 'type' => 'string', 'enumValueTitles' => [ 'DOCUMENT' => 'DOCUMENT', 'LINES' => 'LINES', ], 'example' => 'DOCUMENT', 'enum' => [ 'DOCUMENT', 'LINES', ], ], 'LifecycleConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'Lifecycle配置的容器，最多可容纳1000条规则。', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => 'description', 'description' => '生命周期规则的容器。Object设置过期时间必须大于转储为IA或者Archive存储类型的时间。'."\n", 'type' => 'array', 'items' => [ 'description' => '生命周期规则的容器。Object设置过期时间必须大于转储为IA或者Archive存储类型的时间。'."\n", '$ref' => '#/components/schemas/LifecycleRule', ], ], ], ], 'LifecycleRule' => [ 'title' => '保存存储空间生命周期规则的容器', 'description' => '生命周期规则的容器。'."\n" .' - 不支持Archive Bucket创建转储规则。'."\n" .' - Object设置过期时间必须大于转储为IA或者Archive存储类型的时间。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '标识规则的唯一ID，最多由255个字符组成。如果未指定或者指定该值为空时，OSS会自动生成一个唯一ID。', 'description' => '标识规则的唯一ID。最多由255个字节组成。如没有指定，或者该值为空时，OSS会自动生成一个唯一ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'rule1', ], 'Prefix' => [ 'title' => '指定规则所适用的前缀（Prefix）。不支持设置相同的Prefix。 如果指定了Prefix，则表示此规则仅适用于Bucket中与Prefix匹配的Object。 如果Prefix置空，则表示此规则适用于Bucket中的所有Object。', 'description' => '指定规则所适用的前缀（Prefix）。Prefix不可重复。'."\n" .' - 若指定了Prefix，则表示此规则仅适用于Bucket中与Prefix匹配的Object。'."\n" .' - 若Prefix置空，则表示此规则适用于Bucket中的所有Object。', 'type' => 'string', 'required' => false, 'example' => 'tmp/', ], 'Status' => [ 'title' => '是否启用规则。取值如下： Enabled：表示启用规则，OSS会定期执行该规则。 Disabled：表示不启用规则，OSS会忽略该规则。', 'description' => '是否启用规则。取值范围如下：'."\n" .'- Enabled：表示启用规则，OSS会定期执行该规则。'."\n" .'- Disabled：表示不启用规则，OSS会忽略该规则。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Enabled' => 'Enabled', 'Disabled' => 'Disabled', ], 'example' => 'Enabled', ], 'Expiration' => [ 'title' => '指定Object的过期属性。 对于已开启版本控制的Bucket，指定的过期时间只对Object当前版本生效。 Object的过期时间必须大于转储为IA或Archive类型的时间。', 'description' => '指定Object生命周期规则的过期属性。 对于受版本控制的Bucket，指定的过期属性只对Object的当前版本生效。'."\n" .'
Object的过期时间必须大于转储为IA或Archive类型的时间。', 'type' => 'object', 'properties' => [ 'CreatedBeforeDate' => [ 'title' => '指定一个日期，OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期格式为yyyy-MM-ddT00:00:00.000Z。 日期需要按照ISO8601标准表示并使用UTC时间，且必须为UTC的零点。', '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' => '指定生命周期规则在距离Object最后更新多少天后生效。 当请求中存在IsAccessTime参数且IsAccessTime取值为true时，此参数表示生命周期规则在距离Object最后访问多少天后生效。', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ExpiredObjectDeleteMarker' => [ 'title' => '指定是否自动移除过期删除标记。取值如下： true：表示自动移除过期删除标记。当取值为true时，不支持指定Days或CreatedBeforeDate。 false：表示不会自动移除过期删除标记。当取值为false时，必须指定Days或CreatedBeforeDate。', 'description' => '指定是否自动移除过期删除标记。'."\n" ."\n" .'- true：表示自动移除过期删除标记。取值为true时，不支持指定Days或CreatedBeforeDate。'."\n" ."\n" .'- false：表示不会自动移除过期删除标记。取值为false时，则必须指定Days或CreatedBeforeDate。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'Transition' => [ 'title' => '指定Object在有效生命周期中，OSS何时转换Object的存储类型。 Standard Bucket中Standard Object可以转储为IA、Archive或ColdArchive存储类型，但转储Archive存储类型的时间必须比转储IA存储类型的时间长。例如Transition IA设置Days为30，Transition Archive设置Days必须大于30。', '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' => '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' => '指定一个日期，OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期格式为yyyy-MM-ddT00:00:00.000Z。 日期需要按照ISO8601标准表示并使用UTC时间，且必须为UTC的零点。', 'description' => '指定一个日期，OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期必须服从ISO8601的格式，且要求是UTC的零点。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2002-10-11T00:00:00.000Z', ], 'Days' => [ 'title' => '指定生命周期规则在距离Object最后更新多少天后生效。 当请求中存在IsAccessTime参数且IsAccessTime取值为true时，此参数表示生命周期规则在距离Object最后访问多少天后生效。', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StorageClass' => [ 'title' => '指定Object转储的存储类型。取值如下： IA：低频访问 Archive：归档存储 ColdArchive：冷归档存储 DeepColdArchive：深度冷归档存储', 'description' => '指定Object转储的存储类型。'."\n" ."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'- ColdArchive：冷归档存储'."\n" ."\n" .'> IA Bucket中的Object可以转储为Archive或者ColdArchive存储类型，但不支持转储为Standard存储类型。'."\n", 'enumValueTitles' => [], '$ref' => '#/components/schemas/StorageClass', ], 'IsAccessTime' => [ 'title' => '指定是否基于last access time匹配规则。取值如下： true：采用Object的last access time（最后一次访问时间）匹配规则。 false（默认值）：采用Object的last modified time（最后一次修改时间）匹配规则。', 'description' => '指定是否基于last access time匹配规则。取值如下：'."\n" ."\n" .'- true：采用Object的last access time（最后一次访问时间）匹配规则。'."\n" ."\n" .'- false（默认值）：采用Object的last modify time（最后一次修改时间）匹配规则。', 'type' => 'boolean', 'example' => 'true', ], 'ReturnToStdWhenVisit' => [ 'title' => '指定Object转为非标准存储后，再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下： true：Object由非标准存储转为标准存储。 false（默认值）：Object仍为非标准存储。', 'description' => '指定Object转为非标准存储后，再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下：'."\n" ."\n" .'- true：Object由非标准存储转为标准存储。'."\n" ."\n" .'- false（默认值）：Object仍为非标准存储。', 'type' => 'boolean', 'example' => 'true', ], 'AllowSmallFile' => [ 'title' => '基于最后一次访问时间设置生命周期规则时，指定是否将小于64 KB的Object转储为低频、归档、冷归档文件类型。取值如下： true（默认值）：转储包含小于64 KB在内的所有Object。当Object小于64 KB时，按照64 KB计算。当Object大于或等于64 KB时，按照实际大小计算。设置为true时，可能会增加存储费用。 false：不转储小于64 KB的Object。', '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', ], ], ], ], 'AbortMultipartUpload' => [ 'title' => '指定未完成分片上传的过期属性。', 'description' => '指定未完成分片上传的过期属性。'."\n", 'type' => 'object', 'properties' => [ 'Days' => [ 'title' => '指定生命周期规则在距离Object最后更新多少天后生效。 当请求中存在IsAccessTime参数且IsAccessTime取值为true时，此参数表示生命周期规则在距离Object最后访问多少天后生效。', 'description' => '指定生命周期规则在距离Object最后更新多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CreatedBeforeDate' => [ 'title' => '指定一个日期，OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期格式为yyyy-MM-ddT00:00:00.000Z。 日期需要按照ISO8601标准表示并使用UTC时间，且必须为UTC的零点。', 'description' => '指定一个日期，OSS会对最后更新时间早于该日期的数据执行生命周期规则。日期必须服从ISO8601的格式，且要求是UTC的零点。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2002-10-11T00:00:00.000Z', ], ], ], 'Tag' => [ 'title' => '指定规则所适用的对象标签，可设置多个。', 'description' => '指定规则所适用的对象标签，可设置多个。'."\n", 'type' => 'array', 'items' => [ 'description' => '指定规则所适用的对象标签，可设置多个。'."\n", '$ref' => '#/components/schemas/Tag', ], ], 'NoncurrentVersionExpiration' => [ 'title' => '非当前版本生命周期规则的过期属性', 'description' => '指定Object非当前版本生命周期规则的过期属性。'."\n", 'type' => 'object', 'properties' => [ 'NoncurrentDays' => [ 'title' => '指定生命周期规则在Object成为非当前版本多少天后生效。 当请求中存在IsAccessTime参数且IsAccessTime取值为true时，此参数表示生命周期规则在Object最后访问多少天后生效。', 'description' => '指定生命周期规则在Object成为非当前版本多少天后生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], ], ], 'NoncurrentVersionTransition' => [ 'title' => '非当前版本生命周期规则的转储属性', 'description' => '在有效的生命周期规则中，OSS何时将指定Object的非当前版本转储为IA或者Archive存储类型 。'."\n" .'Standard类型的Object转储为Archive类型的时间必须大于转储为IA类型的时间。'."\n", 'type' => 'array', 'items' => [ 'description' => '在有效的生命周期规则中，OSS何时将指定Object的非当前版本转储为IA或者Archive存储类型 。'."\n" .'Standard类型的Object转储为Archive类型的时间必须大于转储为IA类型的时间。'."\n", 'type' => 'object', 'properties' => [ 'NoncurrentDays' => [ 'title' => '指定生命周期规则在Object成为非当前版本多少天后生效。 当请求中存在IsAccessTime参数且IsAccessTime取值为true时，此参数表示生命周期规则在Object最后访问多少天后生效。', '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', ], 'IsAccessTime' => [ 'title' => '指定是否基于last access time匹配规则。取值如下： true：采用Object的last access time（最后一次访问时间）匹配规则。 false（默认值）：采用Object的last modified time（最后一次修改时间）匹配规则。', 'description' => '指定是否基于last access time匹配规则。取值如下：'."\n" ."\n" .'- true：采用Object的last access time（最后一次访问时间）匹配规则。'."\n" ."\n" .'- false（默认值）：采用Object的last modify time（最后一次修改时间）匹配规则。', 'type' => 'boolean', 'example' => 'true', ], 'ReturnToStdWhenVisit' => [ 'title' => '指定Object转为非标准存储后，再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下： true：Object由非标准存储转为标准存储。 false（默认值）：Object仍为非标准存储。', 'description' => '指定Object转为非标准存储后，再次访问时是否将Object转为标准存储。只有当IsAccessTime设置为true时才有效。取值如下：'."\n" ."\n" .'- true：Object由非标准存储转为标准存储。'."\n" ."\n" .'- false（默认值）：Object仍为非标准存储。', 'type' => 'boolean', 'example' => 'true', ], 'AllowSmallFile' => [ 'title' => '基于最后一次访问时间设置生命周期规则时，指定是否将小于64 KB的Object转储为低频、归档、冷归档文件类型。取值如下： true（默认值）：转储包含小于64 KB在内的所有Object。当Object小于64 KB时，按照64 KB计算。当Object大于或等于64 KB时，按照实际大小计算。设置为true时，可能会增加存储费用。 false：不转储小于64 KB的Object。', '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', ], ], ], ], 'Filter' => [ 'title' => '本条排除规则的条件参数容器，至多一个，可置空。', 'description' => '本条规则的排除条件。', 'type' => 'object', 'properties' => [ 'Not' => [ 'title' => '如果Object满足该条件，则跳过本条规则的匹配。', 'description' => '满足何种规则跳过。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => '本条排除规则所适用的Object前缀。不可为空。 如果Rule节点下配置了Prefix，则Not节点下的Prefix必须以Rule节点下的Prefix为前缀。例如，Rule节点下配置的Prefix为dir，则Not节点下的Prefix必须以dir开头，例如dir1、dir2等。 如果Not节点下未配置Tag，则Not节点下配置的Prefix不能和Rule节点下的Prefix相同。', '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' => '本条排除规则所适用的Object标签，至多一个，可置空。', 'description' => '本条排除规则所适用的Object标签，至多一个，可置空。', '$ref' => '#/components/schemas/Tag', ], ], ], ], 'ObjectSizeGreaterThan' => [ 'title' => '本条生命周期规则只对文件大小大于该值的文件生效', 'description' => '本条生命周期规则只对文件大小大于该值的文件生效', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], 'ObjectSizeLessThan' => [ 'title' => '本条生命周期规则只对文件大小小于该值的文件生效', 'description' => '本条生命周期规则只对文件大小小于该值的文件生效', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', ], ], ], 'AtimeBase' => [ 'title' => '存储空间开启访问追踪的时间戳', 'description' => '存储空间开启访问追踪的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1626158525', ], ], ], 'ListAccessPointsResult' => [ 'title' => '保存本次列举接入点信息结果的容器。', 'description' => '保存本次列举接入点信息结果的容器。', 'type' => 'object', 'properties' => [ 'IsTruncated' => [ 'title' => '请求中返回的结果是否被截断。返回值如下： true：表示本次未返回全部结果。 false：表示本次已返回全部结果。', 'description' => '请求中返回的结果是否被截断。返回值如下： true：表示本次未返回全部结果。 false：表示本次已返回全部结果。', 'type' => 'string', 'example' => 'true', ], 'NextContinuationToken' => [ 'title' => '表明本次ListAccessPoints请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', 'description' => '表明本次ListAccessPoints请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', 'type' => 'string', 'example' => 'abc**', ], 'AccountId' => [ 'title' => '接入点所属的阿里云账号UID。', 'description' => '接入点所属的阿里云账号UID。', 'type' => 'string', 'example' => '10107***1448150', ], 'AccessPoints' => [ 'title' => '保存所有接入点信息的容器。', 'description' => '保存所有接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPoint' => [ 'title' => '保存接入点信息的列表。', 'description' => '保存接入点信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存接入点的详细信息。', '$ref' => '#/components/schemas/AccessPoint', ], ], ], ], 'MaxKeys' => [ 'title' => '本次列举操作所设置的结果最大数量。', 'description' => '本次列举操作所设置的结果最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], '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' => '列举存储空间级别请求者QoS配置信息的结果', 'description' => '列举Bucket级别请求者流控的结果', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '存储空间的名称', 'description' => '存储空间的名称', 'type' => 'string', 'example' => 'test-bucket', ], 'ContinuationToken' => [ 'title' => '标识本次列举的起点', 'description' => '标识本次列举的起点', 'type' => 'string', 'example' => '29387293298', ], 'NextContinuationToken' => [ 'title' => '标识下次列举的起点', 'description' => '标识下次列举的起点', 'type' => 'string', 'example' => '29387293298', ], 'IsTruncated' => [ 'title' => '列举结果是否截断', 'description' => '列举结果是否截断', 'type' => 'boolean', 'example' => 'true', ], 'RequesterQoSInfo' => [ 'title' => '请求者QoS配置信息列表', 'description' => '请求者QoS配置信息列表', 'type' => 'array', 'items' => [ 'description' => '保存存储空间请求者QoS配置信息的容器', '$ref' => '#/components/schemas/RequesterQoSInfo', ], ], ], ], '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', ], ], ], ], 'ListResourcePoolBucketsResult' => [ 'title' => '列举资源池中存储空间列表的结果', 'description' => '列举资源池中Bucket列表的结果', 'type' => 'object', 'properties' => [ 'ResourcePool' => [ 'title' => '目标资源池名称', 'description' => '目标资源池名称', 'type' => 'string', 'example' => 'rp-for-api', ], 'ContionuationToken' => [ 'title' => '本次列举起点', 'description' => '本次列举起点', 'type' => 'string', 'example' => 'abcd', ], 'NextContionuationToken' => [ 'title' => '下次列举起点', 'description' => '下次列举起点', 'type' => 'string', 'example' => 'defg', ], 'IsTruncated' => [ 'title' => '列举结果是否截断', 'description' => '列举结果是否截断', 'type' => 'boolean', 'example' => 'true', ], 'ResourcePoolBucket' => [ 'title' => '资源池中的存储空间列表', 'description' => '资源池中的存储空间列表', 'type' => 'array', 'items' => [ 'description' => '保存资源池中的Bucket信息的容器', '$ref' => '#/components/schemas/ResourcePoolBucket', ], ], ], ], 'ListResourcePoolRequesterQoSInfosResult' => [ 'title' => '列举资源池级别请求者QoS配置信息的结果', 'description' => '列举资源池级别请求者流控的结果', 'type' => 'object', 'properties' => [ 'ResourcePool' => [ 'title' => '资源池名称', 'description' => '资源池名称', 'type' => 'string', 'example' => 'rp-for-ai', ], 'ContinuationToken' => [ 'title' => '标识本次列举的起点', 'description' => '标识本次列举的起点', 'type' => 'string', 'example' => '29387293298', ], 'NextContinuationToken' => [ 'title' => '标识下次列举的起点', 'description' => '标识下次列举的起点', 'type' => 'string', 'example' => '29387293298', ], 'IsTruncated' => [ 'title' => '列举结果是否截断', 'description' => '列举结果是否截断', 'type' => 'boolean', 'example' => 'true', ], 'RequesterQoSInfo' => [ 'title' => '请求者QoS配置信息列表', 'description' => '请求者QoS配置信息列表', 'type' => 'array', 'items' => [ 'description' => '保存请求者QoS配置信息的容器', '$ref' => '#/components/schemas/RequesterQoSInfo', ], ], ], ], 'ListResourcePoolsResult' => [ 'title' => '列举当前用户在特定地域中资源池的结果', 'description' => '列举当前用户在特定地域资源池的结果', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => '目标地域', 'description' => '目标地域', 'type' => 'string', 'example' => 'oss-cn-shanghai', ], 'Owner' => [ 'title' => '列举的资源池的所有者', 'description' => '列举的资源池的所有者', 'type' => 'string', 'example' => '1032307xxxx72056', ], 'ContionuationToken' => [ 'title' => '本次列举的起点', 'description' => '本次列举的起点', 'type' => 'string', 'example' => 'abcd', ], 'NextContionuationToken' => [ 'title' => '下次列举的起点', 'description' => '下次列举的起点', 'type' => 'string', 'example' => 'xyz', ], 'IsTruncated' => [ 'title' => '本次列举结果是否截断', 'description' => '本次列举结果是否截断', 'type' => 'boolean', 'example' => 'true', ], 'ResourcePool' => [ 'title' => '资源池列表', 'description' => '资源池列表', 'type' => 'array', 'items' => [ 'description' => '资源池信息', '$ref' => '#/components/schemas/ResourcePoolSimpleInfo', ], ], ], ], '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' => 'A short description of struct', 'description' => '保存返回每个LiveChannel信息的容器。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'description', 'description' => 'LiveChannel的名称。'."\n", 'type' => 'string', 'example' => 'channel-0', ], 'Description' => [ 'title' => 'description', 'description' => 'LiveChannel的描述信息。'."\n", 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => 'description', 'description' => 'LiveChannel的状态。'."\n" .'有效值：'."\n" .'- disabled：表示禁用LiveChannel。'."\n" .'- enabled：表示启用LiveChannel。', 'type' => 'string', 'example' => 'enabled', ], 'LastModified' => [ 'title' => 'description', 'description' => 'LiveChannel配置的最后修改时间。'."\n" .'格式：ISO8601'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => 'ISO8601', ], 'PublishUrls' => [ 'description' => '保存LiveChannel对应的推流地址的容器。'."\n", '$ref' => '#/components/schemas/LiveChannelPublishUrls', ], 'PlayUrls' => [ 'description' => '保存LiveChannel对应的播放地址的容器。'."\n", '$ref' => '#/components/schemas/LiveChannelPlayUrls', ], ], ], 'LiveChannelAudio' => [ 'title' => 'A short description of struct', 'description' => '当Status为Live时，保存音频流信息的容器。'."\n" .'> Video、Audio容器只有在Status为Live时才会返回，但Status为Live时不一定返回这两个容器。例如，客户端已经连接到LiveChannel，但尚未发送音视频数据，这种情况不会返回这两个容器。'."\n", 'type' => 'object', 'properties' => [ 'Bandwidth' => [ 'title' => 'description', 'description' => '当前音频流的码率。'."\n" .'> Bandwidth为音频流/视频流最近一段时间内的平均码率。LiveChannel刚切换到Live状态时，返回的Bandwidth值可能为0。'."\n" .'单位：B/s'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'SampleRate' => [ 'title' => 'description', 'description' => '当前音频流的采样率。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '44100', ], 'Codec' => [ 'title' => 'description', 'description' => '当前音频流的编码格式。'."\n", 'type' => 'string', 'example' => 'ADPCM', ], ], ], 'LiveChannelConfiguration' => [ 'title' => 'A short description of struct', 'description' => '保存LiveChannel配置的容器。', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => 'description', 'description' => 'LiveChannel的描述信息，最长128字节。'."\n", 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'title' => 'description', 'description' => ' 指定LiveChannel的状态。'."\n" ."\n" .'有效值：**enabled**、**disabled**'."\n" .'默认值：**enabled**', 'type' => 'string', 'example' => 'enabled', ], 'Target' => [ 'description' => '保存转储配置的容器。'."\n", '$ref' => '#/components/schemas/LiveChannelTarget', ], 'Snapshot' => [ 'description' => '保存高频截图操作Snapshot选项的容器。'."\n", '$ref' => '#/components/schemas/LiveChannelSnapshot', ], ], ], 'LiveChannelPlayUrls' => [ 'title' => 'A short description of struct', 'description' => '保存播放地址的容器。'."\n", 'type' => 'object', 'properties' => [ 'Url' => [ 'title' => 'description', 'description' => '播放地址。'."\n", 'type' => 'string', 'example' => 'http://test-bucket.oss-cn-hangzhou.aliyuncs.com/test-channel/playlist.m3u8', ], ], ], 'LiveChannelPublishUrls' => [ 'title' => 'A short description of struct', 'description' => '保存推流地址的容器。', 'type' => 'object', 'properties' => [ 'Url' => [ 'title' => 'description', 'description' => '推流地址。'."\n" ."\n" .'> - 推流地址是未加签名的URL，如Bucket ACL非public-read-write，则需先进行签名才可访问。'."\n" .'> - 播放地址是未加签名的URL，如Bucket ACL为private，则需先进行签名才可访问。', 'type' => 'string', 'example' => 'rtmp://test-bucket.oss-cn-hangzhou.aliyuncs.com/live/test-channel', ], ], ], 'LiveChannelSnapshot' => [ 'title' => 'A short description of struct', 'description' => '保存高频截图操作Snapshot 选项的容器。', 'type' => 'object', 'properties' => [ 'RoleName' => [ 'title' => 'description', 'description' => '用于高频截图操作的角色名称，要求有DestBucket的写权限和向NotifyTopic发消息的权限。'."\n", 'type' => 'string', 'example' => 'role_for_snapshot', ], 'DestBucket' => [ 'title' => 'description', 'description' => '保存高频截图目标Bucket，要求与当前Bucket是同一个Owner。'."\n", 'type' => 'string', 'example' => 'snapshotdest', ], 'NotifyTopic' => [ 'title' => 'description', 'description' => '用于通知用户高频截图操作结果的MNS的Topic。'."\n", 'type' => 'string', 'example' => 'snapshotnotify', ], 'Interval' => [ 'title' => 'description', 'description' => '高频截图的间隔长度。如果该段间隔时间内没有关键帧（I 帧），那么该间隔时间不截图。'."\n" .'单位：秒'."\n" .'取值范围：[1, 100]', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], ], ], 'LiveChannelTarget' => [ 'title' => 'A short description of struct', 'description' => '保存转储配置的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => 'description', 'description' => '指定转储的类型。'."\n" ."\n" .'有效值：**HLS**'."\n" ."\n" .'> - 转储类型为HLS时，OSS会在生成每个ts文件后更新m3u8文件。m3u8文件中最多包含最近的FragCount个ts文件。'."\n" .'> - 转储类型为HLS时，写入当前ts文件的音视频数据时长达到FragDuration指定的时长后，OSS会在收到下一个关键帧的时切换到下一个ts文件；如果max(2*FragDuration,'."\n" .' 60s)后仍未收到下一个关键帧，OSS将强制切换文件，此时可能引起播放时卡顿。', 'type' => 'string', 'example' => 'HLS', ], 'FragDuration' => [ 'title' => 'description', 'description' => '当Type为HLS时，指定每个ts文件的时长。'."\n" .'单位：秒'."\n" ."\n" .'取值范围：[1, 100]'."\n" .'默认值：**5**'."\n" .'> FragDuration和FragCount的默认值只有在两者都未指定时才会生效；指定了其中一个，则另一个的值也必须指定。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'FragCount' => [ 'title' => 'description', 'description' => '当Type为HLS时，指定m3u8文件中包含ts文件的个数。'."\n" ."\n" .'取值范围：[1, 100]'."\n" .'默认值：**3**'."\n" .'> FragDuration和FragCount的默认值只有在两者都未指定时才会生效；指定了其中一个，则另一个的值也必须指定。', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'PlaylistName' => [ 'title' => 'description', 'description' => '当Type为HLS时，指定生成的m3u8文件的名称。必须以”.m3u8”结尾，长度范围为[6, 128]。'."\n" ."\n" .'默认值：**playlist.m3u8**'."\n" .'取值范围：[6, 128]', 'type' => 'string', 'example' => 'playlist.m3u8', ], ], ], 'LiveChannelVideo' => [ 'title' => 'A short description of struct', 'description' => '当Status为Live时，保存视频流信息的容器。'."\n" .'> **说明** Video、Audio容器只有在Status为Live时才会返回，但Status为Live时不一定返回这两个容器。例如，客户端已经连接到LiveChannel，但尚未发送音视频数据，这种情况不会返回这两个容器。'."\n", 'type' => 'object', 'properties' => [ 'Width' => [ 'title' => 'description', 'description' => '当前视频流的画面宽度。'."\n" .'单位：像素'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1280', ], 'Height' => [ 'title' => 'description', 'description' => '当前视频流的画面高度。'."\n" .'单位：像素'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '536', ], 'FrameRate' => [ 'title' => 'description', 'description' => '当前视频流的帧率。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24', ], 'Bandwidth' => [ 'title' => 'description', 'description' => '当前视频流的码率。'."\n" .'单位：B/s'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'Codec' => [ 'title' => 'description', 'description' => '当前视频流的编码格式。'."\n", 'type' => 'string', 'example' => 'ADPCM', ], ], ], 'LiveRecord' => [ 'title' => 'A short description of struct', 'description' => '保存一次推流记录信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'StartTime' => [ 'title' => 'description', 'description' => '推流开始时间，使用ISO8601格式表示。'."\n", 'type' => 'string', 'example' => '2016-07-30T01:53:21.000Z', ], 'EndTime' => [ 'title' => 'description', 'description' => '推流结束时间，使用ISO8601格式表示。'."\n", 'type' => 'string', 'example' => '2016-07-30T01:53:31.000Z', ], 'RemoteAddr' => [ 'title' => 'description', 'description' => '推流客户端的IP地址。'."\n", 'type' => 'string', 'example' => '10.101.194.148:57632', ], ], ], 'LocationTransferType' => [ 'title' => 'The container that stores regions in which the destination bucket can be located with the TransferType information', 'description' => '包含TransferType的Location信息容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'Location' => [ 'title' => 'The region in which the destination bucket can be located', 'description' => '可复制到的目标Bucket所在的地域。', 'type' => 'string', 'example' => 'oss-cn-beijing', ], 'TransferTypes' => [ 'title' => 'The container that stores the transmission type', 'description' => '传输类型容器。', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => 'The transfer type should be used to transfer data in Cross-region replication', 'description' => '数据复制时使用的数据传输类型。'."\n" .'取值：'."\n" .' - internal（默认值）：OSS默认传输链路。'."\n" .' - oss_acc：传输加速链路。只有创建跨区域复制规则时才能使用传输加速链路。', 'type' => 'array', 'items' => [ 'description' => '数据复制时使用的数据传输类型。', 'type' => 'string', 'example' => 'oss_acc', ], 'example' => 'oss_acc', ], ], ], ], ], 'LoggingEnabled' => [ 'title' => '存储访问日志状态信息的容器', 'description' => '访问日志信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'TargetBucket' => [ 'title' => '存储访问日志的存储空间', 'description' => '指定存储访问日志的Bucket。'."\n", 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], 'TargetPrefix' => [ 'title' => '保存的日志文件前缀', 'description' => '指定保存的日志文件前缀，可以为空。'."\n", 'type' => 'string', 'example' => 'MyLog-', ], 'LoggingRole' => [ 'title' => '日志转存授权角色', 'description' => '日志转存授权角色', 'type' => 'string', 'example' => 'AliyunOSSLoggingDefaultRole', ], ], ], 'MetaQuery' => [ 'title' => '数据索引查询请求', 'description' => '查询条件的容器。', 'type' => 'object', 'properties' => [ 'NextToken' => [ 'title' => '当Object总数大于设置的MaxResults时，用于翻页的token。 从NextToken开始按字典序返回Object信息列表。 第一次调用此接口时，设置此字段为空。', 'description' => '翻页的Token。从NextToken开始按字典序返回Object信息列表。', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', ], 'MaxResults' => [ 'title' => '返回Object的最大个数，取值范围为0~100。 不设置此参数或者设置为0时，则默认值为100。', 'description' => '返回对象的最大个数，取值范围为0~100。'."\n" .'不设置此参数或者设置为0时，则默认值为100。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Query' => [ 'title' => '查询条件。包括如下选项： Operation：操作符。取值范围为eq（等于）、gt（大于）、gte（大于等于）、lt（小于）、 lte（小于等于）、match（模糊查询）、prefix（前缀查询）、and（逻辑与）、or（逻辑或）和not（逻辑非）。Field：字段名称。Value：字段值。 SubQueries：子查询条件，包括的选项与简单查询条件相同。只有当Operations为逻辑运算符（and、or和not）时，才需要设置子查询条件。', 'description' => '查询条件。包括如下选项：'."\n" ."\n" .'- Operation：操作符。取值范围为eq（等于）、gt（大于）、gte（大于等于）、lt（小于）、 lte（小于等于）、match（模糊查询）、prefix（前缀查询）、and（逻辑与）、or（逻辑或）和not（逻辑非）。'."\n" ."\n" .'- Field：字段名称。'."\n" ."\n" .'- Value：字段值。'."\n" ."\n" .'- SubQueries：子查询条件，包括的选项与简单查询条件相同。只有当Operations为逻辑运算符（and、or和not）时，才需要设置子查询条件。', 'type' => 'string', 'required' => false, 'example' => '{"Field": "Size","Value": "1048576","Operation": "gt"}', ], 'Sort' => [ 'title' => '对指定字段排序', 'description' => '对指定字段排序。', 'type' => 'string', 'example' => 'Size', ], 'Order' => [ 'title' => '排序方式', 'description' => '排序方式。', '$ref' => '#/components/schemas/MetaQueryOrder', ], 'Aggregations' => [ 'title' => '聚合操作信息', 'description' => '聚合操作信息的容器。', 'type' => 'object', 'properties' => [ 'Aggregation' => [ 'title' => '聚合操作信息', 'description' => '单个聚合操作信息的容器。', 'type' => 'array', 'items' => [ 'description' => '句号操作信息的容器。', '$ref' => '#/components/schemas/MetaQueryAggregation', ], ], ], ], 'MediaTypes' => [ 'title' => '多媒体元数据检索条件。仅用于向量检索', 'description' => '多媒体元数据检索条件。仅用于向量检索', 'type' => 'object', 'properties' => [ 'MediaType' => [ 'title' => '选择检索的多媒体类型。取值如下： image：图片 video：视频 audio：音频 document：文档', 'description' => '选择检索的多媒体类型。', 'type' => 'array', 'items' => [ 'description' => '取值如下： image：图片 video：视频 audio：音频 document：文档', 'type' => 'string', 'example' => 'image', ], ], ], ], 'SimpleQuery' => [ 'title' => '查询条件，仅用于向量查询。', 'description' => '查询条件，仅用于向量查询。', 'type' => 'string', 'example' => '{"Operation":"gt", "Field": "Size", "Value": "30"}', ], ], ], 'MetaQueryAggregation' => [ 'title' => '聚合操作信息', 'description' => '聚合操作信息', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '字段名称', 'description' => '字段名称', 'type' => 'string', 'example' => 'Size', ], 'Operation' => [ 'title' => '聚合操作中的操作符', 'description' => '聚合操作中的操作符。'."\n" ."\n" .'- min：最小值'."\n" .'- max：最大值'."\n" .'- average：平均数'."\n" .'- sum：求和'."\n" .'- count：计数'."\n" .'- distinct：去重统计'."\n" .'- group：分组计数', 'type' => 'string', 'example' => 'sum', ], ], ], 'MetaQueryAggregationsResult' => [ 'title' => '保存数据索引聚合查询结果的容器', 'description' => '数据索引查询聚合结果', 'type' => 'object', 'properties' => [ 'Field' => [ 'title' => '字段名称', 'description' => '字段名称', 'type' => 'string', 'example' => 'Size', ], 'Operation' => [ 'title' => '聚合操作符', 'description' => '聚合操作符', 'type' => 'string', 'example' => 'sum', ], 'Value' => [ 'title' => '符合操作的结果值', 'description' => '符合操作的结果值', 'type' => 'number', 'format' => 'double', 'example' => '200', ], 'Groups' => [ 'title' => '分组聚合的结果列表的容器', 'description' => '分组聚合的结果列表的容器', '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', ], ], ], ], ], ], ], ], 'MetaQueryFile' => [ 'title' => '数据索引检索结果中单个Object信息', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'Filename' => [ 'title' => '对象的名称', 'description' => '对象的完整路径', 'type' => 'string', 'example' => 'exampleobject.txt', ], 'Size' => [ 'title' => '对象大小，单位为字节', 'description' => '对象大小', 'type' => 'integer', 'format' => 'int64', 'example' => '120', ], 'FileModifiedTime' => [ 'title' => '最近一次修改时间，遵循RFC 3339标准格式', 'description' => '最近一次修改时间', 'type' => 'string', 'example' => '2021-06-29T15:04:05.000000000Z07:00', ], 'OSSObjectType' => [ 'title' => 'Object的类型。取值范围如下： Normal：通过PutObject接口上传的Object类型。 Appendable：通过AppendObject接口上传的Object类型。 Multipart：通过MultipartUpload接口上传的Object类型。 Symlink：通过PutSymlink接口创建的软链接。', 'description' => '对象的类型', 'type' => 'string', 'enumValueTitles' => [ 'Multipart' => 'MultipartUpload上传的文件', 'Symlink' => 'PutSymlink创建的软链接', 'Appendable' => 'AppendObject上传的文件', 'Normal' => 'PutObject上传的文件', ], 'example' => 'Normal', ], 'OSSStorageClass' => [ 'title' => 'Object的存储类型。取值范围如下： Standard：标准存储类型提供高可靠、高可用、高性能的对象存储服务，能够支持频繁的数据访问。 IA：低频访问存储类型适合需要长期存储但不经常被访问的数据（平均每月访问频率1到2次）。 Archive：归档存储类型适合需要长期存储（建议半年以上）的归档数据，在存储周期内极少被访问，数据进入到可读取状态需要1分钟的解冻时间。 ColdArchive：冷归档存储类型适用于需要长期保存且几乎不访问的数据。', 'description' => '对象的存储类型', 'type' => 'string', 'enumValueTitles' => [ 'Archive' => '归档存储类型', 'ColdArchive' => '冷归档存储类型文件', 'IA' => '低频文件', 'Standard' => '标准文件', ], 'example' => 'Standard', ], 'ObjectACL' => [ 'title' => 'Object的访问权限。取值范围如下： default：Object遵循所在存储空间的访问权限。 private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。 public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。 public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。', 'description' => '对象的访问权限', 'type' => 'string', 'enumValueTitles' => [ 'default' => '遵循存储空间的访问权限', 'private' => '私有', 'public-read' => '公共读', 'public-read-write' => '公共读写', ], 'example' => 'default', ], 'ETag' => [ 'title' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。 对于PutObject请求创建的Object，ETag值是其内容的MD5值。 对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。', 'description' => '对象的ETAG', 'type' => 'string', 'example' => '"fba9dede5f27731c9771645a3986****"', ], 'OSSCRC64' => [ 'title' => 'Object的64位CRC值。该64位CRC根据ECMA-182标准计算得出。', 'description' => '对象的CRC64校验值', 'type' => 'string', 'example' => '4858A48BD1466884', ], 'ServerSideEncryption' => [ 'title' => '创建对象时的服务端加密密钥', 'description' => '创建对象时的服务端加密密钥', 'type' => 'string', 'example' => 'AES256', ], 'ServerSideEncryptionCustomerAlgorithm' => [ 'title' => '创建对象时的服务端加密算法', 'description' => '创建对象时的服务端加密算法', 'type' => 'string', 'example' => 'SM4', ], 'OSSTaggingCount' => [ 'title' => '对象的标签个数', 'description' => '对象的标签个数', 'type' => 'integer', 'format' => 'int64', 'example' => '16', ], 'OSSTagging' => [ 'title' => '对象的标签列表', 'description' => '对象的标签列表', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'title' => '对象的标签', 'description' => '对象的标签', 'type' => 'array', 'items' => [ 'description' => '对象的标签', '$ref' => '#/components/schemas/MetaQueryTagging', ], ], ], ], 'OSSUserMeta' => [ 'title' => '对象的自定义元数据列表', 'description' => '对象的自定义元数据列表', 'type' => 'object', 'properties' => [ 'UserMeta' => [ 'title' => '对象的自定义元数据', 'description' => '对象的自定义元数据', 'type' => 'array', 'items' => [ 'description' => '用户自定义元数据', '$ref' => '#/components/schemas/MetaQueryUserMeta', ], ], ], ], 'URI' => [ 'title' => 'Object完整路径', 'description' => 'Object完整路径', 'type' => 'string', 'example' => 'oss://examplebucket/test-object.jpg', ], 'ProduceTime' => [ 'title' => '设备记录的照片或视频的拍摄时间', 'description' => '设备记录的照片或视频的拍摄时间', 'type' => 'string', 'example' => '2021-06-29T14:50:13.011643661+08:00', ], 'ContentType' => [ 'title' => 'MIME类型', 'description' => 'MIME类型', 'type' => 'string', 'example' => 'image/jpeg', ], 'MediaType' => [ 'title' => '多媒体类型', 'description' => '多媒体类型', 'type' => 'string', 'example' => 'image', ], 'LatLong' => [ 'title' => '经纬度信息', 'description' => '经纬度信息', 'type' => 'string', 'example' => '30.134390,120.074997', ], 'Title' => [ 'title' => '文件标题', 'description' => '文件标题', 'type' => 'string', 'example' => 'test', ], 'OSSExpiration' => [ 'title' => '文件过期时间', 'description' => '文件过期时间', 'type' => 'string', 'example' => '2124-12-01T12:00:00.000Z', ], 'AccessControlAllowOrigin' => [ 'title' => '允许的跨域请求的来源', 'description' => '允许的跨域请求的来源', 'type' => 'string', 'example' => 'https://aliyundoc.com', ], 'AccessControlRequestMethod' => [ 'title' => '跨域请求中用到的方法', 'description' => '跨域请求中用到的方法', 'type' => 'string', 'example' => 'PUT', ], 'ServerSideDataEncryption' => [ 'title' => 'Object的加密算法', 'description' => 'Object的加密算法', 'type' => 'string', 'example' => 'SM4', ], 'ServerSideEncryptionKeyId' => [ 'title' => 'KMS托管的用户主密钥', 'description' => 'KMS托管的用户主密钥', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], 'CacheControl' => [ 'title' => 'Object被下载时网页的缓存行为', 'description' => 'Object被下载时网页的缓存行为', 'type' => 'string', 'example' => 'no-cache', ], 'ContentDisposition' => [ 'title' => 'Object被下载时的名称', 'description' => 'Object被下载时的名称', 'type' => 'string', 'example' => 'attachment; filename =test.jpg', ], 'ContentEncoding' => [ 'title' => 'Object被下载时的内容编码格式', 'description' => 'Object被下载时的内容编码格式', 'type' => 'string', 'example' => 'UTF-8', ], 'ContentLanguage' => [ 'title' => 'Object内容使用的语言', 'description' => 'Object内容使用的语言', 'type' => 'string', 'example' => 'zh-CN', ], 'ImageHeight' => [ 'title' => '图片高度，单位为像素（px）', 'description' => '图片高度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], 'ImageWidth' => [ 'title' => '图片宽度，单位为像素（px）', 'description' => '图片宽度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '270', ], 'VideoWidth' => [ 'title' => '视频画面宽度，单位为像素（px）', 'description' => '视频画面宽度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', ], 'VideoHeight' => [ 'title' => '视频画面高度，单位为像素（px）', 'description' => '视频画面高度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', ], 'Bitrate' => [ 'title' => '码率，单位为比特每秒（bit/s）', 'description' => '码率，单位为比特每秒（bit/s）', 'type' => 'integer', 'format' => 'int64', 'example' => '13091201', ], 'Artist' => [ 'title' => '艺术家', 'description' => '艺术家', 'type' => 'string', 'example' => 'Jane', ], 'AlbumArtist' => [ 'title' => '演唱者', 'description' => '演唱者', 'type' => 'string', 'example' => 'Jenny', ], 'Composer' => [ 'title' => '作曲家', 'description' => '作曲家', 'type' => 'string', 'example' => 'Jane', ], 'Performer' => [ 'title' => '演奏者', 'description' => '演奏者', 'type' => 'string', 'example' => 'Jane', ], 'Album' => [ 'title' => '专辑', 'description' => '专辑', 'type' => 'string', 'example' => 'FirstAlbum', ], 'Duration' => [ 'title' => '视频的总时长。单位秒', 'description' => '视频的总时长。单位秒', 'type' => 'number', 'format' => 'double', 'example' => '15.263000', ], 'VideoStreams' => [ 'title' => '视频流列表', 'description' => '视频流列表', 'type' => 'object', 'properties' => [ 'VideoStream' => [ 'title' => '视频流', 'description' => '视频流', '$ref' => '#/components/schemas/MetaQueryRespVideoStream', ], ], ], 'AudioStreams' => [ 'title' => '音频流列表', 'description' => '音频流列表', 'type' => 'object', 'properties' => [ 'AudioStream' => [ 'title' => '音频流', 'description' => '音频流', '$ref' => '#/components/schemas/MetaQueryRespAudioStream', ], ], ], 'Subtitles' => [ 'title' => '字幕流列表', 'description' => '字幕流列表', 'type' => 'object', 'properties' => [ 'Subtitle' => [ 'title' => '字幕流', 'description' => '字幕流', '$ref' => '#/components/schemas/MetaQueryRespSubtitle', ], ], ], 'Addresses' => [ 'title' => '地址信息列表', 'description' => '地址信息列表', 'type' => 'object', 'properties' => [ 'Address' => [ 'title' => '地址信息', 'description' => '地址信息', '$ref' => '#/components/schemas/MetaQueryRespAddress', ], ], ], 'Insights' => [ 'title' => '保存文件的描述信息', 'description' => '保存文件的描述信息', '$ref' => '#/components/schemas/MetaQueryRespFileInsights', ], ], ], 'MetaQueryOpenRequest' => [ 'title' => '为Bucket开启元数据管理功能的请求体', 'description' => '为开启元数据管理功能的请求体', 'type' => 'object', 'properties' => [ 'Filters' => [ 'title' => '过滤条件的容器，支持逻辑运算 AND 和 OR 以及比较运算符。 每个Filter表达式之间为 OR 关系。 单个Filter表达式中多个条件之间使用英文逗号（,）分隔，表示 AND 关系。', 'type' => 'object', 'properties' => [ 'Filter' => [ 'title' => '过滤条件表达式，示例值表示：筛选出文件大小大于 1024 字节且修改时间晚于2025-06-03T09:20:47.999Z的文件。', 'type' => 'array', 'items' => [ 'type' => 'string', 'example' => 'Size > 1024,FileModifiedTime > 2025-06-03T09:20:47.999Z', ], ], ], ], ], ], 'MetaQueryOrder' => [ 'title' => 'A short description of struct', 'description' => '排序方式。取值范围如下：'."\n" ."\n" .'- asc：升序。'."\n" ."\n" .'- desc（默认值）：降序。', 'type' => 'string', 'example' => 'asc', 'enum' => [ 'asc', 'desc', ], ], 'MetaQueryResp' => [ 'title' => '保存数据索引查询结果的容器。', 'description' => '数据索引查询响应体', 'type' => 'object', 'properties' => [ 'NextToken' => [ 'title' => '当Object总数大于设置的MaxResults时，用于翻页的token。 下一次列出Object信息时以此值为NextToken，将未返回的结果返回。 当Object未全部返回时，此参数才有值。', 'description' => '当Object总数大于设置的MaxResults时，用于翻页的token。 下一次列出Object信息时以此值为NextToken，将未返回的结果返回。 当Object未全部返回时，此参数才有值。', 'type' => 'string', 'example' => 'MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****', ], 'Files' => [ 'title' => 'Object信息的容器。', 'description' => 'Object信息的容器。', 'type' => 'object', 'properties' => [ 'File' => [ 'title' => '保存单个Object信息的容器。', 'description' => '保存单个Object信息的容器。', 'type' => 'array', 'items' => [ 'description' => '满足查询条件的文件列表', '$ref' => '#/components/schemas/MetaQueryFile', ], ], ], ], 'Aggregations' => [ 'title' => '聚合操作结果信息的容器', 'description' => '聚合操作结果信息的容器', 'type' => 'object', 'properties' => [ 'Aggregation' => [ 'title' => '聚合操作结果列表', 'description' => '聚合操作结果列表', 'type' => 'array', 'items' => [ 'description' => '聚合操作结果', '$ref' => '#/components/schemas/MetaQueryAggregationsResult', ], ], ], ], ], ], 'MetaQueryRespAddress' => [ 'title' => '数据索引向量检索结果中的地址信息', 'description' => '数据索引向量检索结果中的地址信息', 'type' => 'object', 'properties' => [ 'AddressLine' => [ 'title' => '完整地址', 'description' => '完整地址', 'type' => 'string', 'example' => '中国浙江省杭州市余杭区文一西路969号', ], 'City' => [ 'title' => '城市', 'description' => '城市', 'type' => 'string', 'example' => '杭州市', ], 'District' => [ 'title' => '区', 'description' => '区', 'type' => 'string', 'example' => '余杭区', ], 'Language' => [ 'title' => '语言，格式为BCP 47', 'description' => '语言，格式为BCP 47', 'type' => 'string', 'example' => 'zh-Hans', ], 'Province' => [ 'title' => '省份', 'description' => '省份', 'type' => 'string', 'example' => '浙江省', ], 'Township' => [ 'title' => '街道', 'description' => '街道', 'type' => 'string', 'example' => '文一西路', ], ], ], 'MetaQueryRespAudioStream' => [ 'title' => '数据索引向量检索结果中的音频流信息', 'description' => '数据索引向量检索结果中的音频流信息', 'type' => 'object', 'properties' => [ 'CodecName' => [ 'title' => '编码器名称', 'description' => '编码器名称', 'type' => 'string', 'example' => 'aac', ], 'Bitrate' => [ 'title' => '码率，单位为比特每秒（bit/s）', 'description' => '码率，单位为比特每秒（bit/s）', 'type' => 'integer', 'format' => 'int64', 'example' => '320087', ], 'SampleRate' => [ 'title' => '采样率，单位为赫兹（Hz）', 'description' => '采样率，单位为赫兹（Hz）', 'type' => 'integer', 'format' => 'int64', 'example' => '48000', ], 'StartTime' => [ 'title' => '音频流起始时间，单位为秒（s）', 'description' => '音频流起始时间，单位为秒（s）', 'type' => 'number', 'format' => 'double', 'example' => '0.0235', ], 'Duration' => [ 'title' => '音频流持续时长，单位为秒（s）', 'description' => '音频流持续时长，单位为秒（s）', 'type' => 'number', 'format' => 'double', 'example' => '3.690667', ], 'Channels' => [ 'title' => '声道数量', 'description' => '声道数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Language' => [ 'title' => '音频流中使用的语言，格式为BCP 47', 'description' => '音频流中使用的语言，格式为BCP 47', 'type' => 'string', 'example' => 'en', ], ], ], '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' => '数据索引向量检索结果中的字幕流信息', 'type' => 'object', 'properties' => [ 'CodecName' => [ 'title' => '编码器名称', 'description' => '编码器名称', 'type' => 'string', 'example' => 'mov_text', ], 'Language' => [ 'title' => '字幕语言，格式为BCP 47', 'description' => '字幕语言，格式为BCP 47', 'type' => 'string', 'example' => 'en', ], 'StartTime' => [ 'title' => '字幕流起始时间，单位为秒（s）', 'description' => '字幕流起始时间，单位为秒（s）', 'type' => 'number', 'format' => 'double', 'example' => '0.000000', ], 'Duration' => [ 'title' => '字幕流持续时长，单位为秒（s）。', 'description' => '字幕流持续时长，单位为秒（s）。', 'type' => 'number', 'format' => 'double', 'example' => '71.378', ], ], ], 'MetaQueryRespVideoStream' => [ 'title' => '数据索引向量检索结果中的视频流信息', 'description' => '数据索引向量检索结果中的视频流信息', 'type' => 'object', 'properties' => [ 'CodecName' => [ 'title' => '编码器名称', 'description' => '编码器名称', 'type' => 'string', 'example' => 'h264', ], 'Language' => [ 'title' => '视频流中使用的语言，格式为BCP 47', 'description' => '视频流中使用的语言，格式为BCP 47', 'type' => 'string', 'example' => 'en', ], 'Bitrate' => [ 'title' => '码率，单位为比特每秒（bit/s）', 'description' => '码率，单位为比特每秒（bit/s）', 'type' => 'integer', 'format' => 'int64', 'example' => '5407765', ], 'FrameRate' => [ 'title' => '视频流帧率', 'description' => '视频流帧率', 'type' => 'string', 'example' => '25/1', ], 'StartTime' => [ 'title' => '视频流起始时间，单位为秒（s）', 'description' => '视频流起始时间，单位为秒（s）', 'type' => 'number', 'format' => 'double', 'example' => '0.000000', ], 'Duration' => [ 'title' => '视频流持续时长，单位为秒（s）', 'description' => '视频流持续时长，单位为秒（s）', 'type' => 'number', 'format' => 'double', 'example' => '22.88', ], 'FrameCount' => [ 'title' => '视频帧数', 'description' => '视频帧数', 'type' => 'integer', 'format' => 'int64', 'example' => '572', ], 'BitDepth' => [ 'title' => '像素位宽', 'description' => '像素位宽', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'PixelFormat' => [ 'title' => '视频流像素格式', 'description' => '视频流像素格式', 'type' => 'string', 'example' => 'yuv420p', ], 'ColorSpace' => [ 'title' => '色彩空间', 'description' => '色彩空间', 'type' => 'string', 'example' => 'bt709', ], 'Height' => [ 'title' => '视频流画面高度，单位为像素（px）', 'description' => '视频流画面高度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '720', ], 'Width' => [ 'title' => '视频流画面宽度，单位为像素（px）', 'description' => '视频流画面宽度，单位为像素（px）', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', ], ], ], 'MetaQueryTagging' => [ 'title' => 'A short description of struct', 'description' => '对象所附标签', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'key', 'description' => '对象标签键', 'type' => 'string', 'example' => 'abc', ], 'Value' => [ 'title' => 'value', 'description' => '对象标签值', 'type' => 'string', 'example' => 'test', ], ], ], 'MetaQueryUserMeta' => [ 'title' => 'A short description of struct', 'description' => '用户自定义元数据', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'key', 'description' => '用户自定义元数据键', 'type' => 'string', 'example' => 'abc', ], 'Value' => [ 'title' => 'value', 'description' => '用户自定义元数据值', 'type' => 'string', 'example' => 'test', ], ], ], 'NotificationConfiguration' => [ 'title' => 'BucketNotifaction 配置信息', 'description' => 'BucketNotification 配置信息', 'type' => 'object', 'properties' => [ 'TopicConfiguration' => [ 'title' => 'Topic 配置信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => 'Topic 名称', 'type' => 'string', 'example' => 'test-topic-1', ], ], ], ], ], 'required' => false, ], 'ObjectACL' => [ 'description' => '指定OSS创建Object时的访问权限。'."\n" .'取值：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见**[读写权限ACL](~~100676~~)**。', 'type' => 'string', 'example' => 'public-read', 'default' => 'default', 'enum' => [ 'private', 'public-read', 'public-read-write', 'default', ], ], 'ObjectHashConfiguration' => [ 'title' => '对象哈希计算配置', 'description' => 'Object哈希算法配置', 'type' => 'object', 'properties' => [ 'ObjectHashFunction' => [ 'title' => '对象哈希算法', 'description' => '对象哈希算法', 'type' => 'string', 'example' => 'SHA-256', ], 'DisplayObjectHash' => [ 'title' => '访问对象时或是否在响应头显示对象哈希值', 'description' => '访问对象时或是否在响应头显示对象哈希值', 'type' => 'boolean', 'example' => 'true', ], ], ], 'ObjectIdentifier' => [ 'title' => 'A short description of struct', 'description' => '对象标识符。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'key', 'description' => '对象 Key。', 'type' => 'string', 'required' => true, 'example' => 'object_key', ], 'VersionId' => [ 'title' => 'version id', 'description' => '版本ID。', 'type' => 'string', 'example' => 'version_20211101141621_d137', ], ], ], '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' => 'A list of the objects.', 'description' => '文件信息的容器', 'type' => 'array', 'items' => [ 'description' => '返回的文件元信息。', '$ref' => '#/components/schemas/ObjectSummary', ], 'enumValueTitles' => [], ], 'ObjectProcessConfiguration' => [ 'title' => '保存对象FC接入点的配置', 'description' => '对象FC接入点的配置', 'type' => 'object', 'properties' => [ 'AllowedFeatures' => [ 'title' => '保存通过对象FC接入点发起请求信息的容器。', 'description' => '保存通过对象FC接入点发起请求信息的容器。', 'type' => 'object', 'properties' => [ 'AllowedFeature' => [ 'title' => '函数计算支持的功能特性', 'description' => '函数计算支持的功能特性列表', 'type' => 'array', 'items' => [ 'description' => '函数计算支持的功能特性', 'type' => 'string', 'example' => 'GetObject-Range', ], ], ], ], 'TransformationConfigurations' => [ 'title' => '保存转换配置信息的容器', 'description' => '保存转换配置信息的容器', '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', ], ], ], ], 'ContentTransformation' => [ 'title' => '保存转换信息的容器', 'description' => '保存转换信息的容器', 'type' => 'object', 'properties' => [ 'FunctionCompute' => [ 'title' => '保存函数计算信息的容器', 'description' => '保存函数计算信息的容器', 'type' => 'object', 'properties' => [ 'FunctionAssumeRoleArn' => [ 'title' => '函数计算用于访问您在其他云产品中的资源的角色ARN', 'description' => '函数计算用于访问您在其他云产品中的资源的角色ARN', 'type' => 'string', 'example' => 'acs:ram::111933544165****:role/aliyunfcdefaultrole', ], 'FunctionArn' => [ 'title' => '函数ARN', 'description' => '函数ARN', 'type' => 'string', 'example' => 'acs:fc:cn-qingdao:111933544165****:services/test-oss-fc.LATEST/functions/fc-01', ], ], ], 'AdditionalFeatures' => [ 'title' => '保存额外特性配置', 'description' => '保存额外特性配置', 'type' => 'object', 'properties' => [ 'CustomForwardHeaders' => [ 'title' => '保存自定义转发请求头列表', 'description' => '保存自定义转发请求头列表', 'type' => 'object', 'properties' => [ 'CustomForwardHeader' => [ 'title' => '自定义转发请求头', 'description' => '自定义转发请求头', 'type' => 'array', 'items' => [ 'description' => '自定义转发请求头', 'type' => 'string', 'example' => 'test-header', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'ObjectSummary' => [ 'title' => 'Object元信息', 'description' => '返回的文件元信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'Object名称', 'description' => 'Object的Key。', 'type' => 'string', 'example' => 'fun/test.jpg', ], 'LastModified' => [ 'title' => 'Object最后被修改的时间', 'description' => 'Object最后被修改的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-24T08:42:32.000Z', ], 'ETag' => [ 'title' => '在每个Object生成时创建，用于标识一个Object的内容', 'description' => 'ETag (Entity Tag) 在每个Object生成时创建，用于标识一个Object的内容。'."\n" ."\n" .'- 对于PutObject请求创建的Object，ETag值是其内容的MD5值。'."\n" ."\n" .'- 对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'- ETag值可以用于检查Object内容是否发生变化。不建议使用ETag值作为Object内容的MD5校验数据完整性的依据。', 'type' => 'string', 'example' => '5B3C1A2E053D763E1B002CC607C5A0FE1****', ], 'Type' => [ 'title' => 'Object类型', 'description' => 'Object的类型，包含以下三种：'."\n" ."\n" .'- 通过简单上传生成的Object类型为Normal。'."\n" ."\n" .'- 通过分片上传生成的Object类型为Multipart。'."\n" ."\n" .'- 通过追加上传生成的Object类型为Appendable，且仅支持在Appendable类型的Object后直接追加内容。', 'type' => 'string', 'example' => 'Normal', ], 'Size' => [ 'title' => 'Object的大小，单位为字节', 'description' => '返回Object大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '344606', ], 'StorageClass' => [ 'title' => 'Object的存储类型', 'description' => 'Object的存储类型。', '$ref' => '#/components/schemas/StorageClass', ], 'Owner' => [ 'title' => 'Bucket拥有者信息', 'description' => '保存Bucket拥有者信息的容器。', '$ref' => '#/components/schemas/Owner', ], 'RestoreInfo' => [ 'title' => 'Object的解冻状态', 'description' => 'Object的解冻状态', 'type' => 'string', 'example' => 'ongoing-request="true”', ], 'TransitionTime' => [ 'title' => 'Object被生命周期转为冷归档或者深度冷归档的时间', 'description' => 'Object被生命周期转为冷归档或者深度冷归档的时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-24T08:42:32.000Z', ], ], ], 'ObjectVersion' => [ 'title' => 'Object特定版本的元信息', 'description' => '保存除删除标记以外的Object版本的容器。'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'Object名称', 'description' => 'Object的名称。'."\n", 'type' => 'string', 'example' => 'example', ], 'VersionId' => [ 'title' => 'Object的版本ID', 'description' => 'Object的版本ID。', 'type' => 'string', 'example' => 'CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****', ], 'IsLatest' => [ 'title' => '该版本是否是当前最新版本', 'description' => 'Object是否为当前版本。'."\n" .'取值：'."\n" ."\n" .'- true：Object为当前版本。'."\n" ."\n" .'- false：Object为非当前版本。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', 'default' => 'false', ], 'LastModified' => [ 'title' => 'Object版本最后被修改的时间', 'description' => 'Object最后被修改的时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2019-04-09T07:27:28.000Z', ], 'ETag' => [ 'title' => '每个Object版本生成时创建的用于标识Object的内容', 'description' => '每个Object生成时创建的ETag ，用于标识Object的内容。'."\n" .' - 对于PutObject请求创建的Object，ETag值是其内容的MD5值。'."\n" .' - 对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'> ETag值仅用于检查Object内容是否发生变化。不建议使用ETag值作为Object内容的MD5数据完整性校验的依据。'."\n", 'type' => 'string', 'example' => '250F8A0AE989679A22926A875F0A2****', ], 'Size' => [ 'title' => 'Object的大小，单位为字节', 'description' => 'Object的字节数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '93731', ], 'StorageClass' => [ 'title' => 'Object的存储类型', 'description' => 'Object的存储类型。'."\n", 'example' => 'Standard', '$ref' => '#/components/schemas/StorageClass', ], 'Owner' => [ 'title' => 'Bucket拥有者的信息', 'description' => '保存Bucket拥有者信息的容器。'."\n", '$ref' => '#/components/schemas/Owner', ], 'RestoreInfo' => [ 'title' => 'Object版本的解冻状态', 'description' => 'Object版本的解冻状态', 'type' => 'string', 'example' => 'ongoing-request="true"', ], 'TransitionTime' => [ 'title' => 'Object版本被生命周期转为冷归档或者深度冷归档的时间', 'description' => 'Object版本被生命周期转为冷归档或者深度冷归档的时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2023-04-09T07:27:28.000Z', ], ], ], 'OutputSerialization' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'CSV' => [ 'description' => '输出CSV的格式参数。', '$ref' => '#/components/schemas/CSVOutput', ], 'JSON' => [ 'description' => '输出JSON的格式参数。', '$ref' => '#/components/schemas/JSONOutput', ], 'KeepAllColumns' => [ 'title' => 'description', 'description' => '指定返回结果中包含CSV所有列的位置（可选）。
默认值：false'."\n" .'
仅在select语句里出现的列会有值，不出现的列则为空，返回结果中每一行的数据按照CSV列的顺序从低到高排列。'."\n" .'例如以下语句：
'."\n" .'`select _5, _1 from ossobject.`'."\n" .'
如果KeepAllColumns = true，假设一共有6列数据，则返回以下数据：'."\n" .'
`Value of 1st column,,,,Value of 5th column,\\n`', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'OutputHeader' => [ 'title' => 'description', 'description' => '在返回结果开头输出CSV头信息。'."\n" .'
默认值：false', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'OutputRawData' => [ 'title' => 'description', 'description' => '指定输出数据为纯数据。'."\n" ."\n" .'- 您在请求中指定OutputRawData值时，OSS服务端会按照请求中的要求返回数据。'."\n" ."\n" .'- 您在请求中不指定OutputRawData值时，OSS服务端会自动选择一种格式返回。'."\n" ."\n" .'- 当您显式地指定OutputRawData为True时，如果该SQL长时间内没有返回数据，则HTTP请求可能因没有数据返回而超时。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'EnablePayloadCrc' => [ 'title' => 'description', 'description' => '在每个Frame中会有一个32位的CRC32校验值。客户端可以计算相应payload的CRC32值进行数据完整性校验。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'OverwriteConfiguration' => [ 'title' => '保存禁止覆盖写配置列表的容器', 'description' => '禁止覆盖写的配置', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '保存单条禁止覆盖写规则的容器', 'description' => '保存单条禁止覆盖写规则的容器', 'type' => 'array', 'items' => [ 'description' => '单个Bucket最多支持配置100条规则。', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '覆盖写规则ID', 'description' => '规则的唯一标识符。如果不填写，则会随机生成一个UUID来填充；如果填写，则必须为唯一值，即不同的Rule中不能设置相同的ID。', 'type' => 'string', 'example' => 'forbid-write-rule1', ], 'Action' => [ 'title' => '覆盖写动作，当前只支持设置forbid', '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', ], ], ], ], ], ], ], ], ], 'Owner' => [ 'title' => 'Container for the owner\'s display name and ID', 'description' => '保存Bucket拥有者信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => 'The ID of the owner', 'description' => 'Bucket拥有者的用户ID。', 'type' => 'string', 'example' => 'ut_test_bucket', ], 'DisplayName' => [ 'title' => 'The display name of the owner', 'description' => 'Bucket拥有者的名称 （目前和ID一致）。', 'type' => 'string', 'example' => 'ut_test_bucket', ], ], ], 'Part' => [ 'title' => 'A short description of struct', 'description' => '保存已上传Part信息的容器。'."\n", 'type' => 'object', 'properties' => [ 'ETag' => [ 'title' => 'description', 'description' => 'Part成功上传后，OSS返回的ETag值。', 'type' => 'string', 'example' => '3349DC700140D7F86A0784842780****', ], 'PartNumber' => [ 'title' => 'description', 'description' => 'Part数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Size' => [ 'title' => 'description', 'description' => '已上传Part大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '6291456', ], 'LastModified' => [ 'title' => 'description', 'description' => 'Part上传的时间。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T07:01:34.000Z', ], ], ], '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', ], ], ], ], ], 'PublicAccessBlockConfiguration' => [ 'title' => '阻止公共访问的配置', 'description' => '阻止公共访问的配置。', 'type' => 'object', 'properties' => [ 'BlockPublicAccess' => [ 'title' => '是否阻止公共访问', 'description' => '是否阻止公共访问。取值：'."\n" .'- true：开启阻止公共访问。'."\n" .'- false：关闭阻止公共访问。', 'type' => 'boolean', 'example' => 'true', ], ], ], 'PutChannelConfiguration' => [ 'title' => '修改图片处理频道配置的请求结构', 'description' => '图片处理频道配置', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '是否生效', 'type' => 'string', 'example' => 'enable', ], 'OrigPicForbidden' => [ 'title' => '是否禁止原图访问', 'type' => 'boolean', 'example' => 'True', ], 'UseSrcFormat' => [ 'title' => '是否使用源格式', 'type' => 'boolean', 'example' => 'True', ], 'SetAttachName' => [ 'title' => '是否设置ContentDisposition响应头', 'type' => 'boolean', 'example' => 'True', ], 'UseStyleOnly' => [ 'title' => '是否只允许通过Style进行图片处理', 'type' => 'boolean', 'example' => 'False', ], 'AutoSetContentType' => [ 'title' => '是否自动设置ContentType', 'type' => 'boolean', 'example' => 'False', ], 'Default404Pic' => [ 'title' => '默认的404图片文件', 'type' => 'string', 'example' => '404.jpg', ], 'StyleDelimiters' => [ 'title' => '样式分隔符', 'type' => 'string', 'example' => '-', ], ], ], 'PutReplicationRule' => [ 'title' => '保存数据复制规则的容器', 'description' => '数据复制规则', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '数据复制规则的唯一标识', 'description' => '数据复制规则的唯一标识', 'type' => 'string', 'example' => 'first-repl-rule', ], 'PrefixSet' => [ 'title' => '要复制的目标Object名称前缀配置容器', 'description' => '要复制的目标Object名称前缀配置容器', '$ref' => '#/components/schemas/ReplicationPrefixSet', ], 'Action' => [ 'title' => '指定可以被复制到目标Bucket的操作。如果配置了Action，则新写入的数据和历史数据的同步都会遵循Action指定的复制操作。 Action允许以下操作类型，您可以指定一项或多项。 取值： ALL（默认值）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。 PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload、UploadPart、UploadPartCopy、CompleteMultipartUpload。', 'description' => '指定可以被复制到目标Bucket的操作。如果配置了Action，则新写入的数据和历史数据的同步都会遵循Action指定的复制操作。 Action允许以下操作类型，您可以指定一项或多项。 取值： ALL（默认值）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。 PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload、UploadPart、UploadPartCopy、CompleteMultipartUpload。', 'type' => 'string', 'example' => 'ALL', ], 'Destination' => [ 'title' => '保存目的Bucket信息的容器', 'description' => '保存目的Bucket信息的容器', '$ref' => '#/components/schemas/ReplicationDestination', ], 'HistoricalObjectReplication' => [ 'title' => '是否复制历史数据', 'description' => '是否复制历史数据', 'type' => 'string', 'example' => 'disabled', 'enum' => [ 'enabled', 'disabled', ], ], 'SyncRole' => [ 'title' => '授权OSS使用哪个角色来进行数据复制。', 'description' => '授权OSS使用哪个角色来进行数据复制。', 'type' => 'string', 'example' => 'aliyunramrole', ], 'SourceSelectionCriteria' => [ 'title' => '用于标识要复制的源对象的其他筛选条件的容器。', 'description' => '用于标识要复制的源对象的其他筛选条件的容器。', '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', ], 'EncryptionConfiguration' => [ 'title' => '目标对象加密配置。', 'description' => '目标对象加密配置。', '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', ], 'RTC' => [ 'description' => '保存RTC配置规则的容器。', '$ref' => '#/components/schemas/RTC', ], ], ], 'QoSConfiguration' => [ 'title' => 'QoS配置信息', 'description' => '流控配额信息', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => [ 'title' => '总上行带宽，单位Gbps', 'description' => '总上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'IntranetUploadBandwidth' => [ 'title' => '内网上行带宽，单位Gbps', 'description' => '内网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ExtranetUploadBandwidth' => [ 'title' => '公网上行带宽，单位Gbps', 'description' => '公网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalDownloadBandwidth' => [ 'title' => '总下行带宽，单位Gbps', 'description' => '总下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'IntranetDownloadBandwidth' => [ 'title' => '内网下行带宽，单位Gbps', 'description' => '内网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ExtranetDownloadBandwidth' => [ 'title' => '公网下行带宽，单位Gbps', 'description' => '公网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalQps' => [ 'title' => '总QPS', 'description' => '总QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'IntranetQps' => [ 'title' => '内网QPS', 'description' => '内网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'ExtranetQps' => [ 'title' => '公网QPS', 'description' => '公网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], ], ], 'QoSConfigurationWithRemark' => [ 'title' => '带有备注信息的QoS配置信息', 'description' => '带有备注信息的QoS配置', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => [ 'title' => '总上行带宽，单位Gbps', 'description' => '总上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'IntranetUploadBandwidth' => [ 'title' => '内网上行带宽，单位Gbps', 'description' => '内网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ExtranetUploadBandwidth' => [ 'title' => '公网上行带宽，单位Gbps', 'description' => '公网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalDownloadBandwidth' => [ 'title' => '总下行带宽，单位Gbps', 'description' => '总下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'IntranetDownloadBandwidth' => [ 'title' => '内网下行带宽，单位Gbps', 'description' => '内网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ExtranetDownloadBandwidth' => [ 'title' => '公网下行带宽，单位Gbps', 'description' => '公网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalQps' => [ 'title' => '总QPS', 'description' => '总QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'IntranetQps' => [ 'title' => '内网QPS', 'description' => '内网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'ExtranetQps' => [ 'title' => '公网QPS', 'description' => '公网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'Remark' => [ 'title' => '备注', 'description' => '备注', 'type' => 'integer', 'format' => 'int64', 'example' => '备注', ], ], ], 'RTC' => [ 'title' => '数据复制时间控制功能的状态', 'description' => '数据复制时间控制功能的状态', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '是否开启复制时间控制（RTC）功能', 'description' => '是否开启复制时间控制（RTC）功能', 'type' => 'string', 'enumValueTitles' => [ 'disabled' => '关闭RTC功能', 'enabled' => '开启RTC功能', ], 'example' => 'Enabled', ], ], ], 'RefererConfiguration' => [ 'title' => '保存防盗链配置的容器', 'description' => '保存Referer配置内容的容器。', 'type' => 'object', 'properties' => [ 'AllowEmptyReferer' => [ 'title' => '是否允许Referer字段为空的请求访问', 'description' => '指定是否允许Referer字段为空的请求访问OSS。取值如下：'."\n" ."\n" .'- true（默认值）：允许Referer字段为空的请求访问OSS。'."\n" .'- false：不允许Referer字段为空的请求访问OSS。', 'type' => 'boolean', 'required' => true, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', 'default' => 'true', ], 'AllowTruncateQueryString' => [ 'title' => '匹配时是否截断请求参数', 'description' => '是否截断QueryString。'."\n" ."\n" .'- true（默认值）：截断QueryString。'."\n" ."\n" .'- false：不截断QueryString。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'TruncatePath' => [ 'title' => '匹配时是否截断路径部分（即只匹配protocol://host/部分）', 'description' => '匹配时是否截断路径部分（即只匹配protocol://host/部分）。取值：'."\n" ."\n" .'- true：截断URL中包括Path在内的后续所有部分。'."\n" ."\n" .'- false：不截断URL中包括Path在内的后续所有部分。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'RefererList' => [ 'title' => '保存Referer访问白名单', 'description' => '保存Referer访问白名单的容器。'."\n" .'> **说明**PutBucketReferer为覆盖语义，即RefererList中的新指定的白名单列表将覆盖已配置的白名单列表。当您上传的RefererList为空时（即不包含Referer请求元素），此操作将清空RefererList中已配置的白名单列表。'."\n", 'type' => 'object', 'properties' => [ 'Referer' => [ 'title' => '指定一条Referer访问白名单', 'description' => '指定一条Referer访问白名单。'."\n", 'type' => 'array', 'items' => [ 'description' => '指定一条Referer访问白名单。', 'type' => 'string', 'example' => 'http://www.aliyun.com', ], ], ], 'required' => true, ], 'RefererBlacklist' => [ 'title' => '保存Referer访问黑名单', 'description' => '保存Referer访问黑名单', 'type' => 'object', 'properties' => [ 'Referer' => [ 'title' => '指定一条Referer访问黑名单', 'description' => '指定一条Referer访问黑名单', 'type' => 'array', 'items' => [ 'description' => '指定一条Referer访问黑名单', 'type' => 'string', 'example' => 'https://www.abc.com', ], ], ], ], ], ], 'RegionInfo' => [ 'title' => 'A short description of struct', 'description' => '地域信息。', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => 'region', 'description' => '地域ID。', 'type' => 'string', 'example' => 'oss-cn-hangzhou', ], 'InternetEndpoint' => [ 'title' => 'internet endpoint', 'description' => '地域对应的外网Endpoint。', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', ], 'InternalEndpoint' => [ 'title' => 'internal endpoint', 'description' => '地域对应的内网Endpoint。', 'type' => 'string', 'example' => 'oss-cn-hangzhou-internal.aliyuncs.com', ], 'AccelerateEndpoint' => [ 'title' => 'accelerate endpoint', 'description' => '地域对应的传输加速Endpoint。取值固定为oss-accelerate.aliyuncs.com。', 'type' => 'string', 'example' => 'oss-accelerate.aliyuncs.com', ], ], ], 'ReplicationAction' => [ 'title' => '指定可以被复制到目标Bucket的操作。如果配置了Action，则新写入的数据和历史数据的同步都会遵循Action指定的复制操作。 Action允许以下操作类型，您可以指定一项或多项。 取值： ALL（默认值）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。 PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload、UploadPart、UploadPartCopy、CompleteMultipartUpload。', 'type' => 'string', 'example' => 'ALL', ], 'ReplicationConfiguration' => [ 'title' => '配置Bucket数据复制规则的容器。', 'description' => '数据复制配置信息。', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '保存数据复制规则的容器。', 'description' => '保存数据复制规则的容器。', '$ref' => '#/components/schemas/PutReplicationRule', ], ], ], 'ReplicationDestination' => [ 'title' => '保存目标Bucket信息的容器。', 'description' => '保存目标Bucket信息的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '指定数据要复制到的目标Bucket。', 'description' => '指定数据要复制到的目标Bucket。'."\n", 'type' => 'string', 'example' => 'target-bucket', ], 'Location' => [ 'title' => '目标Bucket所处的地域。', 'description' => '目标Bucket所处的地域。'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'oss-cn-beijing', ], 'TransferType' => [ 'title' => '指定数据复制时使用的数据传输链路。 取值： internal（默认值）：OSS默认传输链路。 oss_acc：传输加速链路。只有创建跨区域复制规则时才能使用传输加速链路。', 'description' => '指定数据复制时使用的数据传输链路。'."\n" .'取值：'."\n" .' - internal（默认值）：OSS默认传输链路。'."\n" .' - oss_acc：传输加速链路。只有创建跨区域复制规则时才能使用传输加速链路。'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'oss_acc', 'enum' => [ 'internal', 'oss_acc', ], ], ], ], 'ReplicationEncryptionConfiguration' => [ 'title' => '目标对象加密配置。', 'description' => '目标对象加密配置。', 'type' => 'object', 'properties' => [ 'ReplicaKmsKeyID' => [ 'title' => '指定SSE-KMS密钥ID。如果指定复制通过SSE-KMS加密创建的对象，则必须指定该元素。', 'description' => '指定SSE-KMS密钥ID。如果指定复制通过SSE-KMS加密创建的对象，则必须指定该元素。', 'type' => 'string', 'example' => 'c4d49f85-ee30-426b-a5ed-95e9139dxxxxx', ], ], ], 'ReplicationPrefixSet' => [ 'title' => '保存前缀（Prefix）的容器。每条数据复制规则中，最多可指定10条Prefix。', 'description' => '保存Prefix的容器，每个复制规则中，最多能指定10个Prefix。', 'type' => 'object', 'properties' => [ 'Prefix' => [ 'title' => '设置待复制Object的Prefix。只有匹配该Prefix的Object才被复制到目标Bucket。 Prefix最大长度为1023个字符。 如果配置了Prefix，则新写入的数据和历史数据的同步都会遵循Prefix指定的规则。', 'description' => '设置待复制Object的Prefix。只有匹配该Prefix的Object才被复制到目标Bucket。'."\n" .' - Prefix最大长度为1023个字符。'."\n" .' - 如果配置了Prefix，则新写入的数据和历史数据的同步都会遵循Prefix指定的规则。'."\n" ."\n", 'type' => 'array', 'items' => [ 'description' => '设置待复制Object的Prefix。只有匹配该Prefix的Object才被复制到目标Bucket。'."\n" .' - Prefix最大长度为1023个字符。'."\n" .' - 如果配置了Prefix，则新写入的数据和历史数据的同步都会遵循Prefix指定的规则。'."\n" ."\n", 'type' => 'string', 'example' => 'video', ], ], ], ], 'ReplicationProgressRule' => [ 'title' => '保存每个复制规则进度条目的容器。', 'description' => '数据复制进度信息', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '复制规则对应的ID。', 'description' => 'rule id', 'type' => 'string', 'example' => 'rep01', ], 'PrefixSet' => [ 'title' => '保存Prefix 的容器，只有匹配该Prefix的Object才会被复制到目标Bucket。', 'description' => '保存Prefix 的容器，每个复制规则中，最多能指定10个Prefix。', '$ref' => '#/components/schemas/ReplicationPrefixSet', ], 'Action' => [ 'title' => '表示被同步到目标Bucket的操作。 Action允许以下操作类型，您可以指定一项或者多项。 ALL（默认操作）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。 PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、 InitiateMultipartUpload 、 UploadPart、UploadPartCopy和CompleteMultipartUpload。', 'description' => '表示被同步到目标Bucket的操作。'."\n" ."\n" .'Action允许以下操作类型，您可以指定一项或者多项。'."\n" ."\n" .'ALL（默认操作）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。'."\n" ."\n" .'PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、 InitiateMultipartUpload 、 UploadPart、UploadPartCopy和CompleteMultipartUpload。', 'type' => 'string', 'enumValueTitles' => [ 'ALL' => 'PUT/DELETE/ABORT操作都会同步', 'PUT' => '仅同步写入类操作', ], 'example' => 'PUT', ], 'Destination' => [ 'title' => '保存目标Bucket信息的容器。', 'description' => '保存目标Bucket信息的容器。', '$ref' => '#/components/schemas/ReplicationDestination', ], 'Status' => [ 'title' => '表示复制状态。 取值： starting：设置数据复制规则后，OSS会为Bucket准备复制任务，此时的复制状态为starting。 doing：当数据复制规则生效后，即数据处于同步状态时，此时的复制状态为doing。 closing：删除数据复制规则后，OSS会自动完成清理工作，此时的复制状态为closing。', 'description' => '复制状态。', 'type' => 'string', 'example' => 'doing', ], 'HistoricalObjectReplication' => [ 'title' => '是否复制历史数据。即开启数据复制前，是否将源Bucket中的数据复制到目标Bucket。 取值： enabled（默认值）：表示复制历史数据。 disabled：表示不复制历史数据，仅复制跨区域复制规则生效后新写入的数据。', 'description' => '是否复制历史数据。即开启数据复制前，是否将源Bucket中的数据复制到目标Bucket。'."\n" ."\n" .'取值：'."\n" ."\n" .'enabled（默认值）：表示复制历史数据。'."\n" ."\n" .'disabled：表示不复制历史数据，仅复制跨区域复制规则生效后新写入的数据。', 'type' => 'string', 'enumValueTitles' => [ 'disabled' => '不复制历史数据', 'enabled' => '复制历史数据', ], 'example' => 'enabled', ], 'Progress' => [ 'title' => '保存复制进度的容器，仅当数据处于同步状态（doing）时才返回此元素。', 'description' => '保存复制进度的容器，仅当数据处于同步状态（doing）时才返回此元素。', 'type' => 'object', 'properties' => [ 'HistoricalObject' => [ 'title' => '显示已复制历史数据的百分比。仅对开启了历史数据复制的Bucket有效。', 'description' => '显示已复制历史数据的百分比。仅对开启了历史数据复制的Bucket有效。', 'type' => 'string', 'example' => '0.86', ], 'NewObject' => [ 'title' => '显示数据复制到目标Bucket的时间点（GMT格式）。 例如Thu, 24 Sep 2015 15:39:18 GMT，表示早于该时间点写入的数据都已复制到目标Bucket。', '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', ], ], ], ], ], 'ReplicationRule' => [ 'title' => '保存数据复制规则的容器', 'description' => '数据复制规则。', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '数据复制规则的唯一标识', 'description' => '请求规则对应的ID。', 'type' => 'string', 'example' => 'test_replication_1', ], 'PrefixSet' => [ 'title' => '要复制的目标Object名称前缀配置容器', 'description' => '保存前缀（Prefix）的容器。每条数据复制规则中，最多可指定10条Prefix。'."\n", '$ref' => '#/components/schemas/ReplicationPrefixSet', ], 'Action' => [ 'title' => '指定可以被复制到目标Bucket的操作。如果配置了Action，则新写入的数据和历史数据的同步都会遵循Action指定的复制操作。 Action允许以下操作类型，您可以指定一项或多项。 取值： ALL（默认值）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。 PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload、UploadPart、UploadPartCopy、CompleteMultipartUpload。', 'description' => '指定可以被复制到目标Bucket的操作。如果配置了Action，则新写入的数据和历史数据的同步都会遵循Action指定的复制操作。'."\n" .'Action允许以下操作类型，您可以指定一项或多项。'."\n" .'取值：'."\n" .' - ALL（默认值）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。'."\n" .' - PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload、UploadPart、UploadPartCopy、CompleteMultipartUpload。'."\n" ."\n", 'type' => 'string', 'example' => 'PUT', ], 'Destination' => [ 'title' => '保存目的Bucket信息的容器', 'description' => '保存目标Bucket信息的容器。', '$ref' => '#/components/schemas/ReplicationDestination', ], 'Status' => [ 'title' => '表示复制状态。 取值： starting：设置数据复制规则后，OSS会为Bucket准备复制任务，此时的复制状态为starting。 doing：当数据复制规则生效后，即数据处于同步状态时，此时的复制状态为doing。 closing：删除数据复制规则后，OSS会自动完成清理工作，此时的复制状态为closing。', 'description' => '表示复制状态。'."\n" .'取值：'."\n" .' - starting：设置数据复制规则后，OSS会为Bucket准备复制任务，此时的复制状态为starting。'."\n" .' - doing：当数据复制规则生效后，即数据处于同步状态时，此时的复制状态为doing。'."\n" .' - closing：删除数据复制规则后，OSS会自动完成清理工作，此时的复制状态为closing。'."\n", 'type' => 'string', 'example' => 'starting', ], 'HistoricalObjectReplication' => [ 'title' => '是否复制历史数据', 'description' => '指定是否复制历史数据。即开启数据复制前，是否将源Bucket中的数据复制到目标Bucket。'."\n" .'取值：'."\n" .' - enabled（默认值）：表示复制历史数据。'."\n" .' - disabled：表示不复制历史数据。即仅复制创建数据复制规则后新写入的数据。'."\n" ."\n", 'type' => 'string', 'example' => 'enabled', 'enum' => [ 'enabled', 'disabled', ], ], 'SyncRole' => [ 'title' => '授权OSS使用哪个角色来进行数据复制。', 'description' => '授权OSS使用哪个角色来进行数据复制。如果指定使用SSE-KMS加密目标对象，则必须指定该元素。', 'type' => 'string', 'example' => 'aliyunramrole', ], 'SourceSelectionCriteria' => [ 'title' => '用于标识要复制的源对象的其他筛选条件的容器。', 'description' => '用于标识要复制的源对象的其他筛选条件的容器。当前OSS仅支持针对SSE-KMS加密的源对象指定筛选条件。', '$ref' => '#/components/schemas/ReplicationSourceSelectionCriteria', ], 'EncryptionConfiguration' => [ 'title' => '目标对象加密配置。', 'description' => '目标对象加密配置。如果指定Status为Enabled，则必须指定该元素。', '$ref' => '#/components/schemas/ReplicationEncryptionConfiguration', ], 'RTC' => [ 'description' => '保存RTC配置规则的容器。', '$ref' => '#/components/schemas/RTC', ], ], ], 'ReplicationRuleProgress' => [ 'title' => 'A short description of struct', 'description' => '数据复制规则进度信息。', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => 'id', 'description' => '复制规则对应的ID。', 'type' => 'string', 'example' => 'test_replication_rule_1', ], 'PrefixSet' => [ 'description' => '保存Prefix 的容器，每个复制规则中，最多能指定10个Prefix。', '$ref' => '#/components/schemas/ReplicationPrefixSet', ], 'Action' => [ 'title' => 'action', 'description' => '表示被同步到目标Bucket的操作。'."\n" .'Action允许以下操作类型，您可以指定一项或者多项。'."\n" ."\n" .'- ALL（默认操作）：表示PUT、DELETE、ABORT操作均会被同步到目标Bucket。'."\n" ."\n" .'- PUT：表示被同步到目标Bucket的写入操作，包括PutObject、PostObject、AppendObject、CopyObject、PutObjectACL、InitiateMultipartUpload 、 UploadPart、UploadPartCopy和CompleteMultipartUpload。', 'type' => 'string', 'example' => 'ALL', ], ], ], 'ReplicationRules' => [ 'title' => 'A short description of struct', 'description' => '保存需要删除的数据复制规则的容器。', 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => 'the container of id', 'description' => '需要删除的复制规则对应的ID。规则ID可从GetBucketReplication中获取。', 'type' => 'array', 'items' => [ 'description' => '需要删除的复制规则对应的ID。规则ID可从GetBucketReplication中获取。', 'type' => 'string', 'example' => 'test_replication_1', ], ], ], ], 'ReplicationSourceSelectionCriteria' => [ 'title' => '用于标识要复制的源对象的其他筛选条件的容器。当前OSS仅支持针对SSE-KMS加密的源对象指定筛选条件。', 'description' => '用于标识要复制的源对象的其他筛选条件的容器。当前OSS仅支持针对SSE-KMS加密的源对象指定筛选条件。', 'type' => 'object', 'properties' => [ 'SseKmsEncryptedObjects' => [ 'title' => '用于筛选使用SSE-KMS加密对象的容器。如果在数据复制规则中指定了SourceSelectionCriteria，则必须指定该元素。', 'description' => '用于筛选使用SSE-KMS加密对象的容器。如果在数据复制规则中指定了SourceSelectionCriteria，则必须指定该元素。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '指定OSS是否复制通过SSE-KMS加密创建的对象。取值范围如下： Enabled：表示复制通过SSE-KMS加密创建的对象。 Disabled（默认值）：表示不复制通过SSE-KMS加密创建的对象。', 'description' => '指定OSS是否复制通过SSE-KMS加密创建的对象。取值范围如下：'."\n" .' - Enabled：表示复制通过SSE-KMS加密创建的对象。'."\n" .' - Disabled：表示不复制通过SSE-KMS加密创建的对象。', 'type' => 'string', 'example' => 'Enabled', 'enum' => [ 'Enabled', 'Disabled', ], ], ], ], ], ], 'ReplicationStatus' => [ 'title' => '表示复制状态。 取值： starting：设置数据复制规则后，OSS会为Bucket准备复制任务，此时的复制状态为starting。 doing：当数据复制规则生效后，即数据处于同步状态时，此时的复制状态为doing。 closing：删除数据复制规则后，OSS会自动完成清理工作，此时的复制状态为closing。', 'type' => 'string', 'example' => 'doing', ], 'RequestPaymentConfiguration' => [ 'title' => 'A short description of struct', 'description' => '请求付费配置的容器。'."\n", 'type' => 'object', 'properties' => [ 'Payer' => [ 'title' => 'description', 'description' => '指定Bucket付费类型。'."\n" .'取值：'."\n" ."\n" .'- BucketOwner：由Bucket拥有者付费。'."\n" ."\n" .'- Requester：由请求者付费。', 'type' => 'string', 'example' => 'Requester', ], ], ], 'RequesterQoSInfo' => [ 'title' => '请求者QoS配置信息', 'description' => '保存请求者QoS配置信息的容器', 'type' => 'object', 'properties' => [ 'Requester' => [ 'title' => '请求者ID', 'description' => '请求者ID', 'type' => 'string', 'example' => '21234567890090', ], 'QoSConfiguration' => [ 'title' => '请求者QoS配置', 'description' => '请求者QoS配置', '$ref' => '#/components/schemas/QoSConfiguration', ], ], ], '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' => 'Bucket所属的资源组ID', 'description' => '指定资源组ID。'."\n" ."\n" .'- 如果在请求中携带该请求头并指定资源组ID，则OSS会返回属于该资源组的所有Bucket。当指定的资源组ID为rg-default-id时，OSS会返回属于默认资源组的所有Bucket。'."\n" .'- 如果在请求中携带了该请求头但未指定资源组ID，则OSS会返回属于默认资源组的所有Bucket。'."\n" .'- 如果在请求中未携带该请求头，则OSS会返回请求者拥有的所有Bucket。您可以通过资源管理的控制台或ListResourceGroups接口获取资源组ID。'."\n" ."\n" .'您可以通过资源管理的控制台或ListResourceGroups接口获取资源组ID。具体操作，请分别参见[查看资源组基本信息](~~151181~~)和[ListResourceGroups](~~158855~~)。', 'type' => 'string', 'example' => 'rg-aekz****', ], 'ResourcePoolBucket' => [ 'title' => '资源池中存储空间的信息', 'description' => '资源池中Bucket的信息', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '存储空间的名称', 'description' => '存储空间的名称', 'type' => 'string', 'example' => 'test-bucket', ], 'JoinTime' => [ 'title' => '存储空间加入到资源池的时间', 'description' => '存储空间加入到资源池的时间', 'type' => 'string', 'format' => 'iso8601', 'example' => '2024-07-24T08:42:32.000Z', ], ], ], 'ResourcePoolSimpleInfo' => [ 'title' => '用户资源池简略信息', 'description' => '用户资源池简略信息', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '资源池名称', 'description' => '资源池名称', 'type' => 'string', 'example' => 'rp-for-api', ], 'CreateTime' => [ 'title' => '资源池创建时间', 'description' => '资源池创建时间', 'type' => 'string', 'example' => '2024-07-24T08:42:32.000Z', ], ], ], 'ResponseHeaderConfiguration' => [ 'title' => '保存响应头规则的容器', 'description' => '保存响应头规则的容器', 'type' => 'object', 'properties' => [ 'Rule' => [ 'title' => '响应头规则', 'description' => '响应头规则列表', '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', ], ], ], ], 'HideHeaders' => [ 'title' => '指定隐藏哪些响应头的容器', 'description' => '指定隐藏哪些响应头的容器', 'type' => 'object', 'properties' => [ 'Header' => [ 'title' => '隐藏的响应头', 'description' => '隐藏的响应头列表', 'type' => 'array', 'items' => [ 'description' => '隐藏的响应头名称', 'type' => 'string', 'example' => 'LastModifiedTime', ], ], ], ], ], ], ], ], ], 'RestoreRequest' => [ 'title' => 'A short description of struct', 'description' => '解冻请求信息。', 'type' => 'object', 'properties' => [ 'Days' => [ 'title' => 'description', 'description' => '解冻的天数。取值范围为1~7天。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'JobParameters' => [ 'title' => 'description', 'description' => '解冻优先级的容器。只有解冻冷归档类型的Object时才生效。'."\n" .'如果不传入JobParameters节点，则解冻优先级默认为Standard。'."\n", 'type' => 'object', 'properties' => [ 'Tier' => [ 'title' => 'description', 'description' => '解冻优先级。取值范围如下：'."\n" .' - 高优先级（Expedited）：表示1小时内完成解冻。'."\n" .' - 标准（Standard）：表示2~5小时内完成解冻。'."\n" .' - 批量（Bulk）：表示5~12小时内完成解冻。'."\n", 'type' => 'string', 'example' => 'Standard', ], ], ], ], ], 'RoutingRule' => [ 'title' => '存储空间静态页面托管和跳转规则配置。', 'description' => '指定跳转规则或者镜像回源规则，最多指定20个RoutingRule。'."\n", 'type' => 'object', 'properties' => [ 'RuleNumber' => [ 'title' => '匹配和执行跳转规则的序号，OSS将按照此序号依次匹配规则。如果匹配成功，则执行此规则，后续的规则不再执行。', 'description' => '匹配和执行RoutingRule的序号，OSS将按照此序号依次匹配规则。如果匹配成功，则执行此规则，后续的规则不再执行。'."\n" ."\n" .'>如果指定了父节点RoutingRule，则必须指定此项。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Condition' => [ 'title' => '匹配的条件。 如果指定的项都满足，则执行此规则。只有满足此容器下的各个节点的所有条件才算匹配。', 'description' => '匹配的条件。'."\n" .'如果指定的项都满足，则执行此规则。只有满足此容器下的各个节点的所有条件才算匹配。'."\n" .'>如果指定了父节点RoutingRule，则必须指定此项。', '$ref' => '#/components/schemas/RoutingRuleCondition', ], 'Redirect' => [ 'title' => '指定匹配此规则后执行的动作。', 'description' => '指定匹配此规则后执行的动作。'."\n" .'>如果指定了父节点RoutingRule，则必须指定此项。', '$ref' => '#/components/schemas/RoutingRuleRedirect', ], 'LuaConfig' => [ 'title' => '该规则需要执行的Lua脚本配置。', 'description' => '该规则需要执行的Lua脚本配置。', '$ref' => '#/components/schemas/RoutingRuleLuaConfig', ], ], ], 'RoutingRuleCondition' => [ 'title' => '保存该规则需要匹配的条件。', 'description' => '匹配的条件。'."\n" .'如果指定的项都满足，则执行此规则。只有满足此容器下的各个节点的所有条件才算匹配。'."\n" .'>如果指定了父节点RoutingRule，则必须指定此项。', 'type' => 'object', 'properties' => [ 'KeyPrefixEquals' => [ 'title' => '只有匹配此前缀的Object才能匹配此规则。', 'description' => '只有匹配此前缀的Object才能匹配此规则。'."\n", 'type' => 'string', 'example' => 'abc', ], 'KeySuffixEquals' => [ 'title' => '只有匹配此后缀的Object才能匹配此规则。', 'description' => '只有匹配此后缀的Object才能匹配此规则。', 'type' => 'string', 'example' => '.txt', ], 'HttpErrorCodeReturnedEquals' => [ 'title' => '访问指定Object时，返回此status才能匹配此规则。当跳转规则是镜像回源类型时，此字段必须为404。', 'description' => '访问指定Object时，返回此status才能匹配此规则。当跳转规则是镜像回源类型时，此字段必须为404。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '404', ], 'IncludeHeader' => [ 'title' => '只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。', 'description' => '只有请求中包含了指定Header且值为指定值时，才能匹配此规则。该容器最多可指定10个。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '只有请求中包含了此Header且值满足条件，才能匹配此规则。', 'description' => '只有请求中包含了此Header且值满足条件，才能匹配此规则。', 'type' => 'string', 'example' => 'test-header', ], 'Equals' => [ 'title' => '只有请求中包含了Key指定的Header且值为指定值时，才能匹配此规则。', 'description' => '只有请求中包含了Key指定的Header且值为指定值时，才能匹配此规则。', 'type' => 'string', 'example' => 'test-value', ], 'StartsWith' => [ 'title' => '只有请求中包含了Key指定的Header且值以该值为开头时，才能匹配此规则。', 'description' => '只有请求中包含了Key指定的Header且值以该值为开头时，才能匹配此规则。', 'type' => 'string', 'example' => 'test-prefix-', ], 'EndsWith' => [ 'title' => '只有请求中包含了Key指定的Header且值以该值为结尾时，才能匹配此规则。', 'description' => '只有请求中包含了Key指定的Header且值以该值为结尾时，才能匹配此规则。', 'type' => 'string', 'example' => '-test-suffix', ], ], ], ], ], ], 'RoutingRuleLuaConfig' => [ 'title' => '需要执行的Lua脚本配置。', 'description' => '需要执行的Lua脚本配置。', 'type' => 'object', 'properties' => [ 'Script' => [ 'title' => 'Lua脚本名称。', 'description' => 'Lua脚本名称。', 'type' => 'string', 'example' => 'test.lua', ], ], ], 'RoutingRuleRedirect' => [ 'title' => '指定匹配此规则后执行的动作。', 'description' => '指定匹配此规则后执行的动作。'."\n" .'>如果指定了父节点RoutingRule，则必须指定此项。', 'type' => 'object', 'properties' => [ 'RedirectType' => [ 'title' => '指定跳转的类型。取值范围如下： Mirror：镜像回源。 External：外部跳转，即OSS会返回一个3xx请求，指定跳转到另外一个地址。 AliCDN：阿里云CDN跳转，主要用于阿里云的CDN。与External不同的是，OSS会额外添加一个Header。阿里云CDN识别到此Header后会主动跳转到指定的地址，返回给用户获取到的数据，而不是将3xx跳转请求返回给用户。', 'description' => '指定跳转的类型。取值范围如下：'."\n" .' - **Mirror**：镜像回源。'."\n" .' - **External**：外部跳转，即OSS会返回一个3xx请求，指定跳转到另外一个地址。'."\n" .' - **AliCDN**：阿里云CDN跳转，主要用于阿里云的CDN。与External不同的是，OSS会额外添加一个Header。阿里云CDN识别到此Header后会主动跳转到指定的地址，返回给用户获取到的数据，而不是将3xx跳转请求返回给用户。'."\n" ."\n" .'>如果指定了父节点Redirect，则必须指定此项。', 'type' => 'string', 'example' => 'Mirror', ], 'PassQueryString' => [ 'title' => '执行跳转或者镜像回源规则时，是否携带请求参数。 用户请求OSS时携带了请求参数?a=b&c=d，并且设置PassQueryString为true，如果规则为302跳转，则跳转的Location头中会添加此请求参数。例如Location:example.com?a=b&c=d，跳转类型为镜像回源，则在发起的回源请求中也会携带此请求参数。 取值：true、false（默认）', 'description' => '执行跳转或者镜像回源规则时，是否携带请求参数。'."\n" .'用户请求OSS时携带了请求参数`?a=b&c=d`，并且设置**PassQueryString**为true，如果规则为302跳转，则跳转的Location头中会添加此请求参数。例如`Location:example.com?a=b&c=d`，跳转类型为镜像回源，则在发起的回源请求中也会携带此请求参数。'."\n" .'取值：true、false（默认）'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'MirrorURL' => [ 'title' => '镜像回源的源站地址。只有设置RedirectType为Mirror时才生效。 源站地址必须以http://或者https://开头，并且以正斜线（/）结尾，OSS会在此地址后带上Object名称组成回源URL。', 'description' => '镜像回源的源站地址。只有设置RedirectType为Mirror时才生效。'."\n" .'源站地址必须以**http://**或者**https://**开头，并且以正斜线（/）结尾，OSS会在此地址后带上Object名称组成回源URL。'."\n" .'例如要访问的Object名称为myobject，如果指定此项为`http://example.com/`，则回源URL为`http://example.com/myobject`，如果指定此项为`http://example.com/dir1/`，则回源URL为`http://example.com/dir1/myobject`。'."\n" .'>如果RedirectType指定为Mirror，则必须指定此项。', 'type' => 'string', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'http://example.com', ], 'MirrorSNI' => [ 'title' => '是否透传SNI', 'description' => '是否透传SNI', 'type' => 'boolean', 'example' => 'true', ], 'MirrorPassQueryString' => [ 'title' => '与PassQueryString作用相同，优先级高于PassQueryString。只有设置RedirectType为Mirror时才生效。', 'description' => '与PassQueryString作用相同，优先级高于PassQueryString。只有设置RedirectType为Mirror时才生效。'."\n" .'默认值：false'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'MirrorFollowRedirect' => [ 'title' => '如果镜像回源获取的结果为3xx，是否继续跳转到指定的Location获取数据。 只有设置RedirectType为Mirror时才生效。', 'description' => '如果镜像回源获取的结果为3xx，是否继续跳转到指定的Location获取数据。 只有设置RedirectType为Mirror时才生效。'."\n" .'例如发起镜像回源请求时，源站返回了302，并且指定了Location。'."\n" .' - 如果设置此项为true，则OSS会继续请求Location对应的地址。'."\n" .'最多能跳转10次，如果跳转超过10次，则返回镜像回源失败。'."\n" .' - 如果设置此项为false，则OSS会返回302，并透传Location。'."\n" ."\n" .'默认值：true'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'MirrorCheckMd5' => [ 'title' => '是否检查回源body的MD5。 只有设置RedirectType为Mirror时才生效。', 'description' => '是否检查回源body的MD5。 只有设置RedirectType为Mirror时才生效。'."\n" .'当设置**MirrorCheckMd5**为true，并且源站返回的response中含有Content-Md5头时，OSS检查拉取的数据MD5是否与此Header匹配，如果不匹配，则不保存在OSS上。'."\n" .'默认值：false', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'MirrorHeaders' => [ 'title' => '指定镜像回源时携带的Header。只有设置RedirectType为Mirror时才生效。', 'description' => '指定镜像回源时携带的Header。只有设置RedirectType为Mirror时才生效。'."\n", 'type' => 'object', 'properties' => [ 'PassAll' => [ 'title' => '是否透传除以下Header之外的其他Header到源站。只有设置RedirectType为Mirror时才生效。 content-length、authorization2、authorization、range、date等Header 以oss-/x-oss-/x-drs-开头的Header', 'description' => ' 是否透传除以下Header之外的其他Header到源站。只有设置RedirectType为Mirror时才生效。'."\n" .' - content-length、authorization2、authorization、range、date等Header'."\n" .' - 以oss-/x-oss-/x-drs-开头的Header'."\n" ."\n" .'默认值：false'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'Pass' => [ 'title' => '透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。每个Header长度最多为1024个字节，字符集为0~9、A~Z、a~z以及短划线（-）。', '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', ], ], 'Remove' => [ 'title' => '禁止透传指定的Header到源站。只有设置RedirectType为Mirror时才生效。每个Header长度最多为1024个字节，字符集为0~9、A~Z、a~z以及短划线（-）。', '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', ], ], 'Set' => [ 'title' => '设置一个Header传到源站，不管请求中是否携带这些指定的Header，回源时都会设置这些Header。只有设置RedirectType为Mirror时才生效。', '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' => '设置Header的key，最多1024个字节，字符集与Pass相同。只有设置RedirectType为Mirror时才生效。', 'description' => '设置Header的key，最多1024个字节，字符集与Pass相同。只有设置RedirectType为Mirror时才生效。'."\n" .'>若指定了父节点Set，则必须指定此项。', 'type' => 'string', 'example' => 'myheader-key5', ], 'Value' => [ 'title' => '设置Header的value，最多1024个字节，不能出现\\r\\n。只有设置RedirectType为Mirror时才生效。', 'description' => '设置Header的value，最多1024个字节，不能出现`\\r\\n`。只有设置RedirectType为Mirror时才生效。'."\n" .'>若指定了父节点Set，则必须指定此项。', 'type' => 'string', 'example' => 'myheader-value5', ], ], ], ], ], ], 'Protocol' => [ 'title' => '跳转时的协议。只有设置RedirectType为External或者AliCDN时才生效。', 'description' => '跳转时的协议。只有设置RedirectType为External或者AliCDN时才生效。'."\n" .'如果要访问的文件为test，设置跳转到`example.com`，并且设置Protocol为https，则Location头为`https://example.com/test`。'."\n" .'取值：**http**、**https**。'."\n", 'type' => 'string', 'example' => 'http', ], 'HostName' => [ 'title' => '跳转时的域名，域名需符合域名规范。', 'description' => '跳转时的域名，域名需符合域名规范。'."\n" .'如果要访问的文件为test，设置Protocol为https，并且设置Hostname为`example.com`，则Location头为`https://example.com/test`。'."\n", 'type' => 'string', 'example' => 'example.com', ], 'ReplaceKeyPrefixWith' => [ 'title' => 'Redirect时Object名称的前缀将替换成该值。如果前缀为空，则将这个字符串插入Object名称的前面。', 'description' => 'Redirect时Object名称的前缀将替换成该值。如果前缀为空，则将这个字符串插入Object名称的前面。'."\n" .'> 仅允许存在ReplaceKeyWith或ReplaceKeyPrefixWith节点。'."\n" .'假设要访问的Object为abc/test.txt，如果设置KeyPrefixEquals为abc/，ReplaceKeyPrefixWith为def/，则Location头为`http://example.com/def/test.txt`。'."\n", 'type' => 'string', 'example' => 'def/', ], 'EnableReplacePrefix' => [ 'title' => '如果设置此字段为true，则Object的前缀将被替换为ReplaceKeyPrefixWith指定的值。如果未指定此字段或为空，则表示截断Object前缀。', 'description' => '如果设置此字段为true，则Object的前缀将被替换为ReplaceKeyPrefixWith指定的值。如果未指定此字段或为空，则表示截断Object前缀。'."\n" .'> 当ReplaceKeyWith字段不为空时，不能设置此字段为true。'."\n" ."\n" .'默认值：false'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'ReplaceKeyWith' => [ 'title' => 'Redirect时Object名称将替换成ReplaceKeyWith指定的值，ReplaceKeyWith支持设置变量。目前支持的变量为${key}，表示该请求中的Object名称。', 'description' => 'Redirect时Object名称将替换成ReplaceKeyWith指定的值，ReplaceKeyWith支持设置变量。目前支持的变量为${key}，表示该请求中的Object名称。'."\n" .'假设要访问的Object为test，如果设置ReplaceKeyWith为`prefix/${key}.suffix`，则Location头为`http://example.com/prefix/test.suffix`。'."\n", 'type' => 'string', 'example' => 'prefix/${key}.suffix', ], 'HttpRedirectCode' => [ 'title' => '跳转时返回的状态码。只有设置RedirectType为External或者AliCDN时才生效。', 'description' => '跳转时返回的状态码。只有设置RedirectType为External或者AliCDN时才生效。'."\n" .'取值：301（默认）、302、307。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '301', ], 'MirrorPassOriginalSlashes' => [ 'title' => '是否透传/到源站', 'description' => '是否透传/到源站', 'type' => 'boolean', 'example' => 'false', ], 'MirrorURLSlave' => [ 'title' => '镜像回源主备回源备站URL', 'description' => '镜像回源主备回源备站URL', 'type' => 'string', 'example' => 'https://example.com', ], 'MirrorURLProbe' => [ 'title' => '镜像回源主备回源切换判定URL', 'description' => '镜像回源主备回源切换判定URL', 'type' => 'string', 'example' => 'https://example.com/hartbeat', ], 'MirrorSaveOssMeta' => [ 'title' => '镜像回源回源OSS是否自动保存用户元数据', 'description' => '镜像回源回源OSS是否自动保存用户元数据', 'type' => 'boolean', 'example' => 'true', ], 'MirrorProxyPass' => [ 'title' => '镜像回源是否不保存数据', 'description' => '镜像回源是否不保存数据', 'type' => 'boolean', 'example' => 'false', ], 'MirrorAllowGetImageInfo' => [ 'title' => '镜像回源允许获取Image信息', 'description' => '镜像回源允许获取Image信息', 'type' => 'boolean', 'example' => 'true', ], 'MirrorAllowVideoSnapshot' => [ 'title' => '镜像回源允许支持视频截帧', 'description' => '镜像回源允许支持视频截帧', 'type' => 'boolean', 'example' => 'false', ], 'MirrorIsExpressTunnel' => [ 'title' => '是否是镜像回源高速通道', 'description' => '是否是镜像回源高速通道', 'type' => 'boolean', 'example' => 'true', ], 'MirrorDstRegion' => [ 'title' => '镜像回源高速通道VpcRegion', 'description' => '镜像回源高速通道VpcRegion', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'MirrorDstVpcId' => [ 'title' => '镜像回源高速通道VpcId', 'description' => '镜像回源高速通道VpcId', 'type' => 'string', 'example' => 'vpc-test-id', ], 'MirrorDstSlaveVpcId' => [ 'title' => '镜像回源高速通道备站VpcId', 'description' => '镜像回源高速通道备站VpcId', 'type' => 'string', 'example' => 'vpc-test-id', ], 'MirrorUserLastModified' => [ 'title' => '镜像回源保存文件是否使用源站LastModifiedTime', 'description' => '镜像回源保存文件是否使用源站LastModifiedTime', 'type' => 'boolean', 'example' => 'false', ], 'MirrorSwitchAllErrors' => [ 'title' => '用于主备切换的状态判断，主备切换的判断逻辑是源站返回错误，如果MirrorSwitchAllErrors为true，则除了以下状态码外都认为是失败：200,206,301,302,303,307,404；而如果为false，则只有源站返回5xx或者超时才认为是失败。', 'description' => '用于主备切换的状态判断，主备切换的判断逻辑是源站返回错误，如果MirrorSwitchAllErrors为true，则除了以下状态码外都认为是失败：200,206,301,302,303,307,404；而如果为false，则只有源站返回5xx或者超时才认为是失败。', 'type' => 'boolean', 'example' => 'false', ], 'MirrorTunnelId' => [ 'title' => '镜像回源专线回源TunnelId', 'description' => '镜像回源专线回源TunnelId', 'type' => 'string', 'example' => 'test-tunnel-id', ], 'MirrorUsingRole' => [ 'title' => '镜像回源是否使用角色', 'description' => '镜像回源是否使用角色', 'type' => 'boolean', 'example' => 'false', ], 'MirrorRole' => [ 'title' => '镜像回源回源时使用的角色', 'description' => '镜像回源回源时使用的角色', 'type' => 'string', 'example' => 'aliyun-test-role', ], 'MirrorAllowHeadObject' => [ 'title' => '镜像回源是否允许HeadObject', 'description' => '镜像回源是否允许HeadObject', 'type' => 'boolean', 'example' => 'true', ], 'TransparentMirrorResponseCodes' => [ 'title' => '镜像回源透传源站响应码列表', 'description' => '指定当源站返回哪些状态码时需要透传该状态码以及body到客户端，取值为4xx、5xx等HTTP状态码，多个HTTP状态码之间用英文逗号（,）分隔，例如`400,404`。只有设置RedirectType为Mirror时才生效。'."\n" .'当OSS向源站请求内容时，如果源站返回了此参数中的某个状态码，则OSS将透传源站返回的该状态码以及body到客户端。'."\n" .'> 如果在此参数中设置了404状态码，则设置的ErrorDocument会失效。'."\n", 'type' => 'string', 'example' => '400,404', ], 'MirrorAsyncStatus' => [ 'title' => '镜像回源触发异步拉取模式的状态码', 'description' => '镜像回源触发异步拉取模式的状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '303', ], 'MirrorTaggings' => [ 'title' => '镜像回源保存文件时根据参数保存标签', 'description' => '镜像回源保存文件时根据参数保存标签', 'type' => 'object', 'properties' => [ 'Taggings' => [ 'title' => '镜像回源保存标签规则列表', 'description' => '镜像回源保存标签规则列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '当前规则对应标签键', 'description' => '当前规则对应标签键', 'type' => 'string', 'example' => 'test-tagging', ], 'Value' => [ 'title' => '保存标签值的规则', 'description' => '保存标签值的规则', 'type' => 'string', 'example' => 'test-value', ], ], ], ], ], ], 'MirrorReturnHeaders' => [ 'title' => '保存镜像回源返回响应头规则的容器', 'description' => '保存镜像回源返回响应头规则的容器', 'type' => 'object', 'properties' => [ 'ReturnHeader' => [ 'title' => '镜像回源返回响应头规则列表', 'description' => '镜像回源返回响应头规则列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '当前规则对应响应头', 'description' => '当前规则对应响应头', 'type' => 'string', 'example' => 'test-header', ], 'Value' => [ 'title' => '返回响应头值的规则', 'description' => '返回响应头值的规则', 'type' => 'string', 'example' => 'test-value', ], ], ], ], ], ], 'MirrorAuth' => [ 'title' => '镜像回源源站认证信息', 'description' => '镜像回源源站认证信息', 'type' => 'object', 'properties' => [ 'AuthType' => [ 'title' => '镜像回源源站认证类型', 'description' => '镜像回源源站认证类型', 'type' => 'string', 'example' => 'S3V4', ], 'Region' => [ 'title' => '镜像回源源站签名Region', 'description' => '镜像回源源站签名Region', 'type' => 'string', 'example' => 'ap-southeast-1', ], 'AccessKeyId' => [ 'title' => '镜像回源源站回源AK', 'description' => '镜像回源源站回源AK', 'type' => 'string', 'example' => 'TESTAK', ], 'AccessKeySecret' => [ 'title' => '镜像回源源站回源SK，获取配置时会自动脱敏。', 'description' => '镜像回源源站回源SK，获取配置时会自动脱敏。', 'type' => 'string', 'example' => 'TESTSK', ], ], ], 'MirrorMultiAlternates' => [ 'title' => '镜像回源多源站配置列表', 'description' => '镜像回源多源站配置列表', 'type' => 'object', 'properties' => [ 'MirrorMultiAlternate' => [ 'title' => '镜像回源多源站配置', 'description' => '镜像回源多源站配置', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MirrorMultiAlternateNumber' => [ 'title' => '镜像回源多源站序号', 'description' => '镜像回源多源站序号', 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], 'MirrorMultiAlternateURL' => [ 'title' => '镜像回源多源站URL', 'description' => '镜像回源多源站URL', 'type' => 'string', 'example' => 'https://test-multi-alter.example.com', ], 'MirrorMultiAlternateVpcId' => [ 'title' => '镜像回源多源站VpcId', 'description' => '镜像回源多源站VpcId', 'type' => 'string', 'example' => 'vpc-test-id', ], 'MirrorMultiAlternateDstRegion' => [ 'title' => '镜像回源多源站Region', 'description' => '镜像回源多源站Region', 'type' => 'string', 'example' => 'ap-southeast-1', ], ], ], ], ], ], ], ], 'RtcConfiguration' => [ 'title' => '数据复制时间控制配置容器。', 'description' => '数据复制时间控制配置容器。', 'type' => 'object', 'properties' => [ 'RTC' => [ 'description' => '保存RTC状态规则的容器。', '$ref' => '#/components/schemas/RTC', ], 'ID' => [ 'title' => '需要设置RTC状态的复制规则ID。', 'description' => '需要设置RTC状态的复制规则ID。', 'type' => 'string', 'example' => 'test_replication_rule_1', ], ], ], 'SSEKMS' => [ 'title' => '保存SSE-KMS加密密钥的容器。', 'description' => '保存SSE-KMS加密密钥的容器。'."\n" ."\n", 'type' => 'object', 'properties' => [ 'KeyId' => [ 'title' => 'KMS密钥ID。', 'description' => 'KMS密钥ID。', 'type' => 'string', 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], ], ], 'SSEOSS' => [ 'title' => '使用OSS完全托管密钥进行加解密，则需要有该字段，并将值设置为空字符串。', 'description' => '使用OSS完全托管密钥进行加解密。', 'type' => 'string', 'example' => 'SSE-OSS', ], 'SelectMetaRequest' => [ 'title' => 'A short description of struct', 'description' => '保存SelectMetaRequest信息的容器。', 'type' => 'object', 'properties' => [ 'InputSerialization' => [ 'description' => '输入序列化参数（可选）。', '$ref' => '#/components/schemas/InputSerialization', ], 'OverwriteIfExists' => [ 'title' => 'description', 'description' => '重新计算SelectMeta，覆盖已有数据。'."\n" .'
默认值：false（即如果Select Meta已存在则直接返回）。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], ], ], 'SelectMetaStatus' => [ 'title' => 'A short description of struct', 'description' => '保存CreateSelectObjectMeta信息的容器。', 'type' => 'object', 'properties' => [ 'Offset' => [ 'title' => 'description', 'description' => '8位整数，扫描结束时的文件偏移。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000065', ], 'TotalScannedBytes' => [ 'title' => 'description', 'description' => '8位整数，最终扫描过的数据大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000065', ], 'Status' => [ 'title' => 'description', 'description' => '4位整数，最终的status。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x000000c8', ], 'SplitsCount' => [ 'title' => 'description', 'description' => '4位整数，总split个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x00000001', ], 'RowsCount' => [ 'title' => 'description', 'description' => '8位整数，总行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x0000000000000003', ], 'ColsCount' => [ 'title' => 'description', 'description' => '4位整数，总列数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0x00000004', ], 'ErrorMessage' => [ 'title' => 'description', 'description' => '详细的错误信息。如果无错误，则error_message为空。', 'type' => 'string', 'example' => 'The body size in select request exceeds the max allowed size.', ], ], ], 'SelectProcess' => [ 'description' => 'SelectObject可选的x-oss-process参数', 'type' => 'string', 'example' => 'csv/select', ], 'SelectRequest' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'Expression' => [ 'title' => 'description', 'description' => '以Base64 编码的SQL语句。', 'type' => 'string', 'example' => 'c2VsZWN0IGNvdW50KCopIGZyb20gb3Nzb2JqZWN0IHdoZXJlIF80ID4gNDU=', ], 'InputSerialization' => [ 'description' => '输入序列化参数。', '$ref' => '#/components/schemas/InputSerialization', ], 'OutputSerialization' => [ 'description' => '输出序列化参数。', '$ref' => '#/components/schemas/OutputSerialization', ], 'Options' => [ 'description' => '其他可选参数。', '$ref' => '#/components/schemas/SelectRequestOptions', ], ], ], 'SelectRequestOptions' => [ 'title' => 'A short description of struct', 'description' => '保存Select请求的容器。', 'type' => 'object', 'properties' => [ 'SkipPartialDataRecord' => [ 'title' => 'description', 'description' => '忽略缺失数据的行。'."\n" ."\n" .'- 当该参数为false时，OSS会忽略缺失某些列（该列值当做null）而不报错。'."\n" ."\n" .'- 当该参数为true时，该行数据因为不完整而被整体跳过。当跳过的行数超过指定的最大跳过行数时OSS会报错并停止处理。', 'type' => 'boolean', 'enumValueTitles' => [ 'false' => 'false', 'true' => 'true', ], 'example' => 'false', ], 'MaxSkippedRecordsAllowed' => [ 'title' => 'description', 'description' => '指定最大能容忍的跳过的行数。当某一行数据因为不匹配SQL中期望的类型、或者某一列或者多列数据缺失且SkipPartialDataRecord为True时，该行数据会被跳过。如果跳过的行数超过该参数的值，OSS会停止处理并报错。'."\n" .'
默认值：0'."\n" ."\n" .'> 如果某一行是非法CSV行，例如在一列中间连续含有奇数个quote字符，则OSS会马上停止处理并报错，因为该错误很可能会影响对整个CSV文件的解析。即该参数用来调整对非整齐数据的容忍度，但不应用于非法的CSV文件。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], ], ], 'ServerSideEncryptionRule' => [ 'title' => 'A short description of struct', 'description' => '服务器端加密规则的容器。'."\n", 'type' => 'object', 'properties' => [ 'ApplyServerSideEncryptionByDefault' => [ 'description' => '服务器端默认加密方式的容器。'."\n", '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', ], ], ], 'StorageClass' => [ 'title' => 'The storage class of a bucket.', 'description' => 'Bucket的存储类型。 取值范围如下：'."\n" ."\n" .'- Standard（默认）：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'- ColdArchive：冷归档存储'."\n" .'- DeepColdArchive：深度冷归档存储', 'type' => 'string', 'enumValueTitles' => [ 'Archive' => 'Archive', 'ColdArchive' => 'ColdArchive', 'IA' => 'IA', 'Standard' => 'Standard', ], 'example' => 'Standard', 'default' => 'Standard', 'enum' => [ 'Standard', 'IA', 'Archive', 'ColdArchive', 'DeepColdArchive', ], ], 'Style' => [ 'title' => 'A short description of struct', 'description' => '保存Content信息列表的容器。', 'type' => 'object', 'properties' => [ 'Content' => [ 'title' => '样式内容', 'description' => '图片样式内容，图片样式可以包含一个或多个图片处理操作。'."\n" ."\n" .'- 包含单个图片处理操作的图片样式，例如image/resize,p_50，表示将原图缩放50%。'."\n" ."\n" .'- 包含多个图片处理操作的图片样式，例如image/resize,p_63/quality,q_90，表示先将图片缩放到原图的63%，再设置图片相对质量为90%。', 'type' => 'string', 'example' => 'image/resize,p_50', ], ], ], 'StyleInfo' => [ 'title' => '保存单个样式信息的容器。', 'description' => '包含存储空间图片处理样式信息的结构体', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '样式名称', 'description' => '样式名称', 'type' => 'string', 'example' => 'imagestyle', ], 'Content' => [ 'title' => '图片样式内容', 'description' => '样式内容', 'type' => 'string', 'example' => 'image/resize,p_50', ], 'CreateTime' => [ 'title' => '样式创建时间', 'description' => '样式创建时间', 'type' => 'string', 'example' => 'Wed, 20 May 2020 12:07:15 GMT', ], 'LastModifyTime' => [ 'title' => '样式创建时间', 'description' => '样式创建时间', 'type' => 'string', 'example' => 'Wed, 21 May 2020 12:07:15 GMT', ], 'Category' => [ 'title' => '样式分类。 取值：image、document、video。', 'description' => '样式分类。 取值：image、document、video。', 'type' => 'string', 'example' => 'image', ], ], ], 'Tag' => [ 'title' => '标签键值对', 'description' => '设置Bucket Tag的容器。'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'key', 'description' => '指定Bucket Tag的Key。'."\n" ."\n" .'> - 最大长度为64字节。'."\n" .'> - 不能以`http ://`、`https://`、`Aliyun`为前缀。'."\n" .'> - 必须为UTF-8编码。'."\n" .'> - 不能为空。', 'type' => 'string', 'required' => true, 'example' => 'testb', ], 'Value' => [ 'title' => 'value', 'description' => '指定Bucket Tag的Value。'."\n" .' > - 最大长度为128字节。'."\n" .' > - 必须为UTF-8编码。'."\n" .' > - 可以为空。', 'type' => 'string', 'example' => 'testv2', ], ], ], 'TagSet' => [ 'title' => 'A short description of struct', 'description' => '标签集合。', 'type' => 'object', 'properties' => [ 'Tag' => [ 'title' => 'A short description of struct', 'description' => '标签集合。', 'type' => 'array', 'items' => [ 'description' => '标签集合。', '$ref' => '#/components/schemas/Tag', ], ], ], ], 'Tagging' => [ 'title' => 'A short description of struct', 'description' => '设置Bucket TagSet的容器。'."\n", 'type' => 'object', 'properties' => [ 'TagSet' => [ 'title' => 'the container of tags', 'description' => '包含一系列Bucket Tag的容器。'."\n", 'required' => false, '$ref' => '#/components/schemas/TagSet', ], ], ], 'TransferAccelerationConfiguration' => [ 'title' => 'A short description of struct', 'description' => '传输加速配置的容器。', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'title' => '是否开启传输加速', 'description' => '目标Bucket是否开启传输加速。取值如下：'."\n" .' - **true**：开启传输加速。'."\n" .' - **false**：关闭传输加速。'."\n" ."\n" .'> 传输加速开启及关闭操作在30分钟内生效。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'Upload' => [ 'title' => 'A short description of struct', 'description' => '保存Multipart Upload事件信息的容器。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => 'description', 'description' => '初始化Multipart Upload事件的Object名称。'."\n" ."\n\n" ."\n" .'> OSS的返回结果按照Object名称字典序升序排列，对于同一个Object，则按照UploadId的字典序升序排列。', 'type' => 'string', 'example' => 'multipart.data', ], 'UploadId' => [ 'title' => 'description', 'description' => 'Multipart Upload事件的ID。'."\n", 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D6****', ], 'Initiated' => [ 'title' => 'description', 'description' => 'Multipart Upload事件初始化的时间。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2012-02-23T04:18:23.000Z', ], ], ], 'UserAntiDDOSInfo' => [ 'title' => 'A short description of struct', 'description' => '高防实例信息。', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '拥有者的UID', 'description' => '高防实例ID。', 'type' => 'string', 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', ], 'Owner' => [ 'title' => '拥有者的UID', 'description' => '高防实例拥有者的UID。', 'type' => 'string', 'example' => '114893010724****', ], 'Ctime' => [ 'title' => '高防实例创建时间', 'description' => '高防实例创建时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769503', ], 'Mtime' => [ 'title' => '高防实例更新时间', 'description' => '高防实例更新时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769840', ], 'ActiveTime' => [ 'title' => '高防实例激活时间', 'description' => '高防实例激活时间，格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1626769845', ], 'Status' => [ 'title' => '高防实的状态', 'description' => '高防实例所处状态。'."\n" ."\n" .'- Init：初始化防护状态。'."\n" ."\n" .'- Defending：防护中状态。'."\n" ."\n" .'- HaltDefending：解除防护状态。', 'type' => 'string', 'example' => 'Defending', ], ], ], 'UserDefinedLogFieldsConfiguration' => [ 'title' => '用户自定义日志配置信息的容器。', 'description' => '存储空间实时日志中用户自定义字段配置。', 'type' => 'object', 'properties' => [ 'HeaderSet' => [ 'title' => '自定义请求头配置信息的容器。', 'description' => '自定义请求头配置信息的容器。', 'type' => 'object', 'properties' => [ 'header' => [ 'title' => '自定义请求头列表', 'description' => '自定义请求头列表。', 'type' => 'array', 'items' => [ 'description' => '自定义请求头信息。', 'type' => 'string', 'example' => 'header1', ], ], ], ], 'ParamSet' => [ 'title' => '自定义URL参数配置信息的容器。', 'description' => '自定义查询参数配置信息的容器。', 'type' => 'object', 'properties' => [ 'parameter' => [ 'title' => '自定义URL参数列表', 'description' => '自定义查询参数列表。', 'type' => 'array', 'items' => [ 'description' => '自定义查询参数信息。', 'type' => 'string', 'example' => 'param1', ], 'example' => 'my-param', ], ], ], ], ], 'UserQosConfiguration' => [ 'title' => '用户级别QoS配置信息', 'description' => '用户级别流控配额', 'type' => 'object', 'properties' => [ 'TotalUploadBandwidth' => [ 'title' => '总上行带宽，单位Gbps', 'description' => '总上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'IntranetUploadBandwidth' => [ 'title' => '内网上行带宽，单位Gbps', 'description' => '内网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'ExtranetUploadBandwidth' => [ 'title' => '公网上行带宽，单位Gbps', 'description' => '公网上行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalDownloadBandwidth' => [ 'title' => '总下行带宽，单位Gbps', 'description' => '总下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'IntranetDownloadBandwidth' => [ 'title' => '内网下行带宽，单位Gbps', 'description' => '内网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'ExtranetDownloadBandwidth' => [ 'title' => '公网下行带宽，单位Gbps', 'description' => '公网下行带宽，单位Gbps', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'TotalQps' => [ 'title' => '总QPS', 'description' => '总QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'IntranetQps' => [ 'title' => '内网QPS', 'description' => '内网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'ExtranetQps' => [ 'title' => '公网QPS', 'description' => '公网QPS', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'Remark' => [ 'title' => '备注', 'description' => '备注', 'type' => 'integer', 'format' => 'int64', 'example' => '备注', ], 'Region' => [ 'title' => '所在区域', 'description' => '所在区域', 'type' => 'string', 'example' => 'oss-cn-shanghai', ], 'DefaultQoSConfiguration' => [ 'title' => '用户级别默认QoS配置信息', 'description' => '用户级别默认QoS配置信息', '$ref' => '#/components/schemas/QoSConfigurationWithRemark', ], ], ], 'VersioningConfiguration' => [ 'title' => 'Describes the versioning state of a OSS bucket', 'description' => '保存版本控制状态的容器。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '版本控制状态。取值如下：'."\n" ."\n" .'- Enabled：开启版本控制状态。'."\n" ."\n" .'- Suspended：暂停版本控制状态。', 'enumValueTitles' => [ 'Enabled' => 'Enabled', 'Suspended' => 'Suspended', ], 'example' => 'Enabled', '$ref' => '#/components/schemas/BucketVersioningStatus', ], ], ], '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' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'example' => 'vpc-t4nlw426y44rd3iq4****', ], 'WebsiteConfiguration' => [ 'title' => '静态网站托管配置与跳转规则。', 'description' => '根节点。', 'type' => 'object', 'properties' => [ 'IndexDocument' => [ 'title' => '保存默认主页配置的容器。', 'description' => '默认主页的容器。'."\n" ."\n" .'>至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。', '$ref' => '#/components/schemas/IndexDocument', ], 'ErrorDocument' => [ 'title' => '保存错误页面配置的容器。', 'description' => '404页面的容器。'."\n" ."\n" .'>至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。', '$ref' => '#/components/schemas/ErrorDocument', ], 'RoutingRules' => [ 'title' => '保存跳转规则或镜像回源规则的容器。', 'description' => 'RoutingRule的容器。'."\n" ."\n" .'>至少指定IndexDocument、ErrorDocument、RoutingRules三个容器中的一个。', 'type' => 'object', 'properties' => [ 'RoutingRule' => [ 'title' => '指定跳转规则或者镜像回源规则，最多指定20个RoutingRule。', 'description' => '指定跳转规则或者镜像回源规则，最多指定20个RoutingRule。'."\n", 'type' => 'array', 'items' => [ 'description' => '指定跳转规则或者镜像回源规则，最多指定20个RoutingRule。'."\n", '$ref' => '#/components/schemas/RoutingRule', ], ], ], ], ], ], ], ], 'apis' => [ 'ListBuckets' => [ 'summary' => '列举请求者拥有的所有存储空间（Bucket）。', 'path' => '/', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '9318', 'abilityTreeNodes' => [ 'FEATUREossTOZXHW', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'title' => '限定返回的 Bucket 名称必须以 prefix 作为前缀。如果不设定，则不过滤前缀信息。', 'description' => '限定返回的Bucket名称必须以prefix作为前缀。如果不设定，则不过滤前缀信息。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'my', ], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => [ 'title' => '设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。', 'description' => '设定结果从marker之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'mybucket10', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'title' => '限定此次返回 Bucket 的最大个数。', 'description' => '限定此次返回Bucket的最大个数。'."\n" .'取值范围：1~1000'."\n" .'默认值：100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'x-oss-resource-group-id', 'in' => 'header', 'schema' => [ 'title' => '指定资源组 ID。'."\n" ."\n" .'如果在请求中携带该请求头并指定资源组 ID，则 OSS 会返回属于该资源组的所有 Bucket。当指定的资源组 ID 为 rg-default-id 时，OSS 会返回属于默认资源组的所有 Bucket。'."\n" .'如果在请求中携带了该请求头但未指定资源组 ID，则 OSS 会返回属于默认资源组的所有 Bucket。'."\n" .'如果在请求中未携带该请求头，则 OSS 会返回请求者拥有的所有 Bucket。您可以通过资源管理的控制台或 ListResourceGroups 接口获取资源组 ID。'."\n", 'description' => 'Bucket所属资源组Id', 'required' => false, '$ref' => '#/components/schemas/ResourceGroupId', ], ], [ 'name' => 'tag-key', 'in' => 'query', 'schema' => [ 'title' => '指定Bucket标签键。列举结果中仅会包含那些打上了对应标签的Bucket。', 'description' => '指定Bucket标签键。列举结果中仅会包含那些打上了对应标签的Bucket。', 'type' => 'string', 'required' => false, 'example' => 'test-key', ], ], [ 'name' => 'tag-value', 'in' => 'query', 'schema' => [ 'title' => '指定Bucket标签值。如果请求指定了该参数，那么必须同时指定tag-value，列举结果中仅会包含那些打上了对应标签键值对的Bucket。', 'description' => '指定Bucket标签值。如果请求指定了该参数，那么必须同时指定tag-value，列举结果中仅会包含那些打上了对应标签键值对的Bucket。', 'type' => 'string', 'required' => false, 'example' => 'test-value', ], ], [ 'name' => 'tagging', 'in' => 'query', 'schema' => [ 'title' => '指定标签列表。如："k1":"v1","k2":"v2"，只有Bucket匹配列表中所有的标签键值对，才会出现在列举结果中。'."\n" .'tagging参数与tag-key和tag-value两个参数不能同时存在。', 'description' => '指定标签列表。如："k1":"v1","k2":"v2"，只有Bucket匹配列表中所有的标签键值对，才会出现在列举结果中。'."\n" .'tagging参数与tag-key和tag-value两个参数不能同时存在。', 'type' => 'string', 'required' => false, 'example' => '"test-key":"test-value"', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应体。', 'description' => 'ListBuckets（GetService）接口的响应体。', 'type' => 'object', 'properties' => [ 'ListAllMyBucketsResult' => [ 'title' => '保存存储空间列表的容器。', 'description' => '保存ListBuckets（GetService）请求结果的容器。', 'type' => 'object', 'properties' => [ 'Owner' => [ 'title' => '保存 Bucket 拥有者信息的容器。', 'description' => '保存Bucket拥有者信息的容器。', '$ref' => '#/components/schemas/Owner', ], 'Prefix' => [ 'title' => '本次查询结果的前缀。', 'description' => '本次查询结果的前缀。', 'type' => 'string', 'example' => 'logs/', ], 'Marker' => [ 'title' => '本次 ListBuckets（GetSerivce）的起点。', 'description' => '本次ListBuckets（GetSerivce）的起点。', 'type' => 'string', 'example' => 'abc', ], 'MaxKeys' => [ 'title' => '响应请求内返回结果的最大数。', 'description' => '响应请求内返回结果的最大数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'IsTruncated' => [ 'title' => '是否所有的结果都已经返回。取值范围如下：'."\n" ."\n" .'true：表示本次没有返回全部结果。'."\n" .'false：表示本次已经返回了全部结果。', 'description' => '是否所有的结果都已经返回。取值范围如下：'."\n" .'- true：表示本次没有返回全部结果。'."\n" .'- false：表示本次已经返回了全部结果。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '本次没有返回全部结果', 'false' => '本次已经返回全部结果', ], 'example' => 'true', ], 'NextMarker' => [ 'title' => '用于继续查询时给 marker 赋值。表示下一次 ListBuckets（GetService）可以以此为 marker，将未返回的结果返回。', 'description' => '用于继续查询时给marker赋值。表示下一次ListBuckets（GetService）可以以此为marker，将未返回的结果返回。', 'type' => 'string', 'example' => 'def', ], 'Buckets' => [ 'title' => '保存 Bucket 信息列表的容器。', 'description' => '保存Bucket信息列表的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'title' => '保存多个 Bucket 信息的列表。', 'description' => '保存多个Bucket信息的列表。', 'type' => 'array', 'items' => [ 'title' => '保存 Bucket 信息的容器。', 'description' => '保存Bucket信息的容器。', '$ref' => '#/components/schemas/Bucket', ], ], ], ], ], ], ], ], ], '5xx' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n logs/\\n abc\\n 20\\n true\\n def\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '列举存储空间', 'description' => '- 您也可以通过设置prefix、marker或者max-keys参数列举满足指定条件的存储空间。'."\n" .'- 要列举存储空间，您必须有oss:GetService (ListBuckets)权限。具体操作，请参见[为RAM用户授权自定义的权限策略](https://help.aliyun.com/document_detail/199058.htm?spm=a2c4g.11186623.0.0.48be7590hCA8LI#section-ucu-jv0-zip)。'."\n" .'- 调用接口时，如果所有Bucket已返回，则返回参数的XML中不包含Prefix、Marker、MaxKeys、IsTruncated和NextMarker响应元素。', ], 'DescribeRegions' => [ 'summary' => '查询所有支持地域或者指定地域对应的Endpoint信息，包括外网Endpoint、内网Endpoint和传输加速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' => '请求的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DescribeRegions接口的响应体结构。', 'type' => 'object', 'properties' => [ 'RegionInfoList' => [ 'description' => '地域信息列表。', 'type' => 'object', 'properties' => [ 'RegionInfo' => [ 'description' => '保存多个地域信息的容器。', 'type' => 'array', 'items' => [ 'description' => '地域信息。', '$ref' => '#/components/schemas/RegionInfo', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '查询地域', 'description' => '只支持在二级域名（例如oss-cn-hangzhou.aliyuncs.com）上调用DescribeRegions接口。', 'extraInfo' => '

'."\n" .'

查询所有支持地域的描述信息

'."\n" .'请求示例'."\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" .'返回示例'."\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" .'

查询指定地域的描述信息

'."\n" .'请求示例'."\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" .'返回示例'."\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" .'

', ], 'GetBucketStat' => [ 'summary' => '获取指定存储空间的存储容量以及文件数量。', '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' => '要查询的Bucket', 'type' => 'string', 'required' => true, 'example' => 'example-bucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetBucketStat接口的响应体。', 'type' => 'object', 'properties' => [ 'BucketStat' => [ 'description' => 'BucketStat结构的容器。', '$ref' => '#/components/schemas/BucketStat', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 1994\\n 32\\n 27\\n 2\\n 128\\n 12\\n 1709724731\\n 1990\\n 18\\n 120\\n 120\\n 2\\n 120\\n 120\\n 2\\n 120\\n 120\\n 2\\n 120\\n 120\\n 2\\n 481200\\n 128\\n 481200\\n 69\\n 481200\\n 56\\n 481200\\n 110\\n 481200\\n 110\\n 481200\\n","type":"xml"}]', 'title' => '获取存储空间存储容量与文件数量', 'description' => '- 调用该接口时需要拥有oss:GetBucketStat权限。'."\n" .'- 调用该接口获取的数据并非是实时数据，延时可能超过一个小时。'."\n" .'- 调用该接口获取到的存储信息的时间点不保证是最新的，即后一次调用该接口返回的LastModifiedTime字段值可能比前一次调用该接口返回的LastModifiedTime字段值小。', ], 'PutBucket' => [ 'summary' => '创建一个存储空间（Bucket）。', 'path' => '/', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '9062', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', 'FEATUREoss4HN0W2', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'Bucket 名称。存储空间的命名规范如下：'."\n" ."\n" .'只能包括小写字母、数字和短划线（-）。'."\n" .'必须以小写字母或者数字开头和结尾。'."\n" .'长度必须在 3~63 字符之间。', 'description' => 'Bucket名称。存储空间的命名规范如下：'."\n" ."\n" .'- 只能包括小写字母、数字和短划线（-）。'."\n" .'- 必须以小写字母或者数字开头和结尾。'."\n" .'- 长度必须在3~63字符之间。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-acl', 'in' => 'header', 'schema' => [ 'title' => 'Bucket 的访问权限 ACL。取值范围如下：'."\n" ."\n" .'public-read-write：公共读写'."\n" .'public-read：公共读'."\n" .'private（默认）：私有', 'description' => '指定Bucket的访问权限ACL。包含如下三种访问权限：'."\n" ."\n" .'- public-read-write：公共读写'."\n" ."\n" .'- public-read：公共读'."\n" ."\n" .'- private：私有（默认值）'."\n" ."\n" .'关于Bucket访问权限ACL的更多信息，请参见[设置存储空间访问权限ACL](~~31843~~)。', 'required' => false, 'enumValueTitles' => [], '$ref' => '#/components/schemas/BucketACL', ], ], [ 'name' => 'x-oss-resource-group-id', 'in' => 'header', 'schema' => [ 'title' => '指定资源组 ID。'."\n" ."\n" .'如果在请求中携带该请求头并指定资源组 ID，则 OSS 会返回属于该资源组的所有 Bucket。当指定的资源组 ID 为 rg-default-id 时，OSS 会返回属于默认资源组的所有 Bucket。'."\n" .'如果在请求中携带了该请求头但未指定资源组 ID，则 OSS 会返回属于默认资源组的所有 Bucket。'."\n" .'如果在请求中未携带该请求头，则 OSS 会返回请求者拥有的所有 Bucket。您可以通过资源管理的控制台或 ListResourceGroups 接口获取资源组 ID。', 'description' => '指定资源组ID。'."\n" .'- 如果在请求中携带该请求头并指定资源组ID，则创建的存储空间属于该资源组。当指定的资源组ID为rg-default-id时，创建的存储空间属于默认资源组。'."\n" .'- 如果在请求中未携带该请求头，则创建的存储空间属于默认资源组。'."\n" ."\n" .'您可以通过资源管理的控制台或ListResourceGroups接口获取资源组ID。具体操作，请分别参见[查看资源组基本信息](~~151181~~)和[ListResourceGroups](~~158855~~)。'."\n" .'> 创建无地域属性Bucket时不支持配置资源组。', 'required' => false, '$ref' => '#/components/schemas/ResourceGroupId', ], ], [ 'name' => 'x-oss-bucket-tagging', 'in' => 'header', 'schema' => [ 'title' => '指定Bucket标签，如 k1=v1&k2=v2。', 'description' => '指定Bucket标签，如 k1=v1&k2=v2。', 'type' => 'string', 'required' => false, 'example' => 'k1=v1&k2=v2', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体', 'description' => '存储创建Bucket信息的容器。', 'type' => 'object', 'properties' => [ 'CreateBucketConfiguration' => [ 'title' => '存储创建 Bucket 信息的容器。', 'description' => '创建Bucket时使用的配置信息。', 'required' => false, '$ref' => '#/components/schemas/CreateBucketConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"xml","example":"\\n","errorExample":""},{"type":"xml","example":"\\n","errorExample":""}]', 'title' => '创建存储空间', 'description' => '- 同一阿里云账号在同一地域（Region）内最多支持创建100个Bucket。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。', 'extraInfo' => '此接口所对应的各语言SDK如下：'."\n" .'- Java'."\n" .'- Python'."\n" .'- PHP'."\n" .'- Go'."\n" .'- C'."\n" .'- .NET'."\n" .'- Android'."\n" .'- iOS'."\n" .'- Node.js'."\n" .'- Ruby', ], 'DeleteBucket' => [ 'summary' => '删除存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间', 'description' => '- 只有Bucket的拥有者才有权限删除该Bucket。'."\n" .'- 为了防止误删除的发生，OSS不支持删除一个非空的Bucket。', ], 'ListObjects' => [ 'summary' => '列举存储空间（Bucket）中所有文件（Object）的信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => [ 'description' => '对Object名字进行分组的字符。所有Object名字包含指定的前缀，第一次出现delimiter字符之间的Object作为一组元素（即CommonPrefixes）。', 'type' => 'string', 'required' => false, 'example' => '/', ], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => [ 'description' => '设定从marker之后按字母排序开始返回Object。'."\n" .'
marker用来实现分页显示效果，参数的长度必须小于1024字节。'."\n" .'
做条件查询时，即使marker在列表中不存在，也会从符合marker字母排序的下一个开始打印。', 'type' => 'string', 'required' => false, 'example' => 'test1.txt', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'description' => '指定返回Object的最大数。 如果因为max-keys的设定无法一次完成列举，返回结果会附加NextMarker元素作为下一次列举的marker。
取值：大于0小于1000
默认值：100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'description' => '限定返回文件的Key必须以prefix作为前缀。'."\n" ."\n" .'- prefix参数的长度必须小于1024字节。'."\n" ."\n" .'- 使用prefix查询时，返回的Key中仍会包含prefix。'."\n" ."\n" .'如果把prefix设为某个文件夹名，则列举以此Prefix开头的文件，即该文件夹下递归的所有文件和子文件夹。
'."\n" .'在设置prefix的基础上，将delimiter设置为正斜线（/）时，返回值中只列举该文件夹下的文件，文件夹下的子文件夹名返回在CommonPrefixes中，子文件夹下递归的所有文件和文件夹不显示。
'."\n" .'例如，一个Bucket中有三个Object ，分别为fun/test.jpg、 fun/movie/001.avi和fun/movie/007.avi。如果设定prefix为fun/，则返回三个Object；如果在prefix设置为fun/的基础上，将delimiter设置为正斜线（/），则返回fun/test.jpg和fun/movie/。', 'type' => 'string', 'required' => false, 'example' => 'fun', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'description' => '对返回的内容进行编码并指定编码的类型。'."\n" ."\n" .'> delimiter、marker、prefix、NextMarker以及Key使用UTF-8字符。如果delimiter、marker、prefix、NextMarker以及Key中包含XML 1.0标准不支持的控制字符，您可以通过指定encoding-type对返回结果中的Delimiter、Marker、Prefix、NextMarker以及Key进行编码。', 'required' => false, 'enumValueTitles' => [], '$ref' => '#/components/schemas/EncodeType', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetBucket（ListObjects）接口的响应体。', 'type' => 'object', 'properties' => [ 'ListBucketResult' => [ 'description' => '保存GetBucket请求结果的容器。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'The bucket name', 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Prefix' => [ 'title' => 'The prefix that the names of returned objects contain', 'description' => '本次查询结果的前缀。', 'type' => 'string', 'example' => 'logs/', ], 'Marker' => [ 'title' => 'The name of the object from which the list operation begins', 'description' => '标识此次GetBucket（ListObjects）的起点。', 'type' => 'string', 'example' => 'abc', ], 'MaxKeys' => [ 'title' => 'The maximum number of returned objects in the response', 'description' => '响应请求内返回结果的最大数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Delimiter' => [ 'title' => 'The character used to group objects by name', 'description' => '对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现Delimiter字符之间的Object作为一组元素CommonPrefixes。', 'type' => 'string', 'example' => '/', ], 'IsTruncated' => [ 'title' => 'Indicates whether the returned results are truncated', 'description' => '请求中返回的结果是否被截断。'."\n" ."\n" .'返回值：true、false'."\n" ."\n" .'true表示本次没有返回全部结果。'."\n" ."\n" .'false表示本次已经返回了全部结果。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '本次没有返回全部结果', 'false' => '本次已经返回全部结果', ], 'example' => 'true', ], 'EncodingType' => [ 'description' => '指明了返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，则会对返回结果中的Delimiter、Marker、Prefix、NextMarker和Key这些元素进行编码。', 'type' => 'string', 'example' => 'url', ], 'NextMarker' => [ 'description' => '下一次列举文件的起点。', 'type' => 'string', 'example' => 'def', ], 'Contents' => [ 'title' => 'The container that stores the returned object metadata', 'description' => '保存每个返回Object元数据的容器。', 'type' => 'array', 'items' => [ 'description' => '保存Object元数据的容器。', '$ref' => '#/components/schemas/ObjectSummary', ], ], 'CommonPrefixes' => [ 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', 'description' => '如果请求中指定了Delimiter参数，则会在返回的响应中包含CommonPrefixes元素。该元素表明以Delimiter结尾，并有共同前缀的Object名称的集合。', 'type' => 'array', 'items' => [ 'description' => '以Delimiter结尾，并有共同前缀的Object名称。', '$ref' => '#/components/schemas/CommonPrefix', ], ], ], ], ], ], ], '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 \\n \\n \\n ongoing-request=\\"true”\\n 2012-02-24T08:42:32.000Z\\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '列举存储空间中所有文件的信息', 'description' => '- GetBucket (ListObjects)接口已修订为GetBucketV2 (ListObjectsV2)。建议您在开发应用程序时使用较新的版本GetBucketV2 (ListObjectsV2)。为保证向后兼容性，OSS继续支持GetBucket (ListObjects)。有关GetBucketV2 (ListObjectsV2)的更多信息，请参见[GetBucketV2 (ListObjectsV2)](~~187544~~)。'."\n" ."\n" .'- 执行GetBucket (ListObjects)请求时不会返回Object中自定义的元信息。', ], 'ListObjectsV2' => [ 'summary' => '列举存储空间（Bucket）中所有文件（Object）的信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => [ 'title' => 'The character used to group objects by name', 'description' => '对Object名字进行分组的字符。所有Object名字包含指定的前缀，第一次出现Delimiter字符之间的Object作为一组元素（即CommonPrefixes）。', 'type' => 'string', 'required' => false, 'example' => '/', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'title' => 'The maximum number of objects to return', 'description' => '指定返回Object的最大数。
取值：大于0小于1000
默认值：100'."\n" ."\n" .'> 如果因为Max-keys的设定无法一次完成列举，返回结果会附加一个作为下一次列举的Continuation-token。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'title' => 'The prefix that the returned object names must contain', 'description' => '限定返回文件的Key必须以Prefix作为前缀。
'."\n" ."\n" .'- 参数的长度必须小于1024字节。'."\n" ."\n" .'- 使用Prefix查询时，返回的Key中仍会包含Prefix。'."\n" ."\n" .'如果把Prefix设为某个文件夹名，则列举以此Prefix开头的文件，即该文件夹下递归的所有文件和子文件夹。
'."\n" .'在设置Prefix的基础上，将Delimiter设置为正斜线（/）时，返回值就只列举该文件夹下的文件，文件夹下的子文件夹名返回在CommonPrefixes中，子文件夹下递归的所有文件和文件夹不显示。
'."\n" .'例如，一个Bucket中有三个Object ，分别为fun/test.jpg、 fun/movie/001.avi和fun/movie/007.avi。若设定Prefix为fun/，则返回三个Object；如果在Prefix设置为fun/的基础上，将Delimiter设置为正斜线（/），则返回fun/test.jpg和fun/movie/。', 'type' => 'string', 'required' => false, 'example' => 'a', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'title' => 'The encoding type of the object name in the response', 'description' => '对返回的内容进行编码并指定编码的类型。'."\n" ."\n" .'> Delimiter、Start-after、Prefix、NextContinuationToken以及Key使用UTF-8字符。如果Delimiter、Start-after、Prefix、NextContinuationToken以及Key中包含XML 1.0标准不支持的控制字符，您可以通过指定Encoding-type对返回结果中的Delimiter、Start-after、Prefix、NextContinuationToken以及Key进行编码。', 'required' => false, 'enumValueTitles' => [], '$ref' => '#/components/schemas/EncodeType', ], ], [ 'name' => 'fetch-owner', 'in' => 'query', 'schema' => [ 'description' => '指定是否在返回结果中包含owner信息。可选值如下：'."\n" ."\n" .'- true：表示返回结果中包含owner信息。'."\n" ."\n" .'- false：表示返回结果中不包含owner信息。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], [ 'name' => 'start-after', 'in' => 'query', 'schema' => [ 'description' => '设定从Start-after之后按字母排序开始返回Object。
'."\n" .'Start-after用来实现分页显示效果，参数的长度必须小于1024字节。'."\n" .'
做条件查询时，即使Start-after在列表中不存在，也会从符合Start-after字母排序的下一个开始打印。', 'type' => 'string', 'required' => false, 'example' => 'b', ], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => [ 'description' => '指定list操作需要从此token开始。您可从ListObjectsV2结果中的NextContinuationToken获取此token。', 'type' => 'string', 'required' => false, 'example' => 'test1.txt', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListObjectsV2接口的响应体。', 'type' => 'object', 'properties' => [ 'ListBucketResult' => [ 'description' => '保存返回Object元信息的容器。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'The bucket name', 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Prefix' => [ 'title' => 'The prefix that the names of returned objects must contain', 'description' => '本次查询结果的前缀。', 'type' => 'string', 'example' => 'logs/', ], 'StartAfter' => [ 'description' => '如果请求中指定了StartAfter参数，则会在返回的响应中包含StartAfter元素。', 'type' => 'string', 'example' => 'test.txt', ], 'MaxKeys' => [ 'title' => 'The maximum number of returned objects in the response', 'description' => '响应请求内返回结果的最大数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Delimiter' => [ 'description' => '对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现Delimiter字符之间的Object作为一组元素CommonPrefixes。', 'type' => 'string', 'example' => '/', ], 'IsTruncated' => [ 'title' => 'Indicates whether the returned results are truncated', 'description' => '请求中返回的结果是否被截断。'."\n" ."\n" .'返回值：true、false'."\n" ."\n" .'true表示本次没有返回全部结果。'."\n" ."\n" .'false表示本次已经返回了全部结果。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '本次没有返回全部结果', 'false' => '本次已经返回全部结果', ], 'example' => 'true', ], 'KeyCount' => [ 'description' => '此次请求返回的Key的个数。如果指定了Delimiter，则KeyCount为Key和CommonPrefixes的元素之和。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'EncodingType' => [ 'description' => '指明返回结果中编码使用的类型。如果请求的参数中指定了Encoding-type，则会对返回结果中的Delimiter、StartAfter、Prefix、NextContinuationToken和Key这些元素进行编码。', 'type' => 'string', 'example' => 'url', ], 'ContinuationToken' => [ 'description' => '如果请求中指定了ContinuationToken参数，则会在返回的响应中包含ContinuationToken元素。', 'type' => 'string', 'example' => 'CgJiYw--', ], 'NextContinuationToken' => [ 'description' => '表明此次ListObjectsV2（GetBucketV2）请求包含后续结果，需要将NextContinuationToken指定为ContinuationToken继续获取结果。', 'type' => 'string', 'example' => 'CgJiYw--', ], 'Contents' => [ 'title' => 'The container that stores the versions of objects except for delete markers', 'description' => '保存每个返回Object元数据的容器。', 'type' => 'array', 'items' => [ 'description' => '保存单个Object元数据的容器。', '$ref' => '#/components/schemas/ObjectSummary', ], ], 'CommonPrefixes' => [ 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', 'description' => '如果请求中指定了Delimiter参数，则会在返回的响应中包含CommonPrefixes元素。该元素表明以Delimiter结尾，并有共同前缀的Object名称的集合。', 'type' => 'array', 'items' => [ 'description' => '以Delimiter结尾，并有共同前缀的Object名称。', '$ref' => '#/components/schemas/CommonPrefix', ], ], ], ], ], ], ], '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 \\n \\n \\n ongoing-request=\\"true”\\n 2012-02-24T08:42:32.000Z\\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '列举存储空间中所有文件的信息V2', 'description' => '执行GetBucketV2 (ListObjectsV2)请求时不会返回Object中自定义的元信息。', ], 'GetBucketInfo' => [ 'summary' => '查看存储空间（Bucket）的相关信息。只有Bucket的拥有者才能查看Bucket的信息。该请求可以从任何一个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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetBucketInfo接口的响应体。', 'type' => 'object', 'properties' => [ 'BucketInfo' => [ 'description' => '保存Bucket信息的容器。', '$ref' => '#/components/schemas/BucketInfo', ], ], ], ], '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 \\n \\n \\n \\n \\n None\\n ****\\n SM4\\n \\n \\n example-bucket\\n log/\\n \\n An example bucket.\\n false\\n \\n","type":"xml"}]', 'title' => '查看存储空间的相关信息', ], 'GetBucketLocation' => [ 'summary' => '查看存储空间（Bucket）的位置信息。只有Bucket的拥有者才能查看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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '存储Bucket位置信息的容器。', 'type' => 'object', 'properties' => [ 'LocationConstraint' => [ 'description' => 'Bucket所在的地域。
'."\n" .'有效值：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等。'."\n" ."\n" .'
有关Bucket所在地域与数据中心对应关系的更多信息，请参见[访问域名与数据中心。](~~31837~~)。', 'type' => 'string', 'example' => 'oss-cn-hangzhou', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\noss-cn-hangzhou","type":"xml"}]', 'title' => '查看存储空间的位置信息', ], 'ListAccessPoints' => [ 'summary' => '获取用户级别或Bucket级别的接入点信息。', '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' => '指定返回接入点的最大数量。取值如下：'."\n" ."\n" .'- 获取用户级别接入点时，取值要求大于 0 小于等于 1000。'."\n" .'- 获取 Bucket 级别接入点时，取值要求大于 0 小于等于 100。', 'description' => '指定返回接入点的最大数量。取值如下：'."\n" ."\n" .'- 获取用户级别接入点时，取值要求大于0小于等于1000。'."\n" ."\n" .'- 获取Bucket级别接入点时，取值要求大于0小于等于100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => [ 'title' => '指定 List 操作需要从此 token 开始。您可从返回结果中的 NextContinuationToken 获取此 token。', 'description' => '指定List操作需要从此token开始。您可从返回结果中的NextContinuationToken获取此token。', 'type' => 'string', 'required' => false, 'example' => 'abc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应体。', 'description' => 'ListAccessPoints接口的响应体。', 'type' => 'object', 'properties' => [ 'ListAccessPointsResult' => [ 'title' => '保存本次列举接入点信息结果的容器。', 'description' => '保存本次列举接入点信息结果的容器。', '$ref' => '#/components/schemas/ListAccessPointsResult', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n ap-test-01\\n 11489****34218\\n \\n \\n \\n \\n vpc-t4nlw426y44rd3iq4****\\n \\n \\n \\n 10\\n","type":"xml"}]', 'title' => '获取接入点信息', ], 'GetAccessPoint' => [ 'summary' => '获取接入点信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'GetAccessPointResult' => [ 'description' => '保存接入点信息的容器。', '$ref' => '#/components/schemas/GetAccessPointResult', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n 114******818\\n \\n vpc-t4nlw426y44rd3iq4****\\n \\n \\n \\n true\\n \\n Sat, 27 Apr 2024 15:04:14 GMT\\n","type":"xml"}]', 'title' => '获取接入点信息', ], 'GetAccessPointPolicy' => [ 'summary' => '获取接入点策略配置。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '接入点策略配置内容。', 'type' => 'string', 'example' => '{'."\n" .' "Version":"1",'."\n" .' "Statement":['."\n" .' {'."\n" .' "Action":['."\n" .' "oss:PutObject",'."\n" .' "oss:GetObject"'."\n" .' ],'."\n" .' "Effect":"Deny",'."\n" .' "Principal":["27737962156157xxxx"],'."\n" .' "Resource":['."\n" .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01",'."\n" .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*"'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .' } ', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\"{\\\\n \\\\\\"Version\\\\\\":\\\\\\"1\\\\\\",\\\\n \\\\\\"Statement\\\\\\":[\\\\n {\\\\n \\\\\\"Action\\\\\\":[\\\\n \\\\\\"oss:PutObject\\\\\\",\\\\n \\\\\\"oss:GetObject\\\\\\"\\\\n ],\\\\n \\\\\\"Effect\\\\\\":\\\\\\"Deny\\\\\\",\\\\n \\\\\\"Principal\\\\\\":[\\\\\\"27737962156157xxxx\\\\\\"],\\\\n \\\\\\"Resource\\\\\\":[\\\\n \\\\\\"acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01\\\\\\",\\\\n \\\\\\"acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*\\\\\\"\\\\n ]\\\\n }\\\\n ]\\\\n } \\"","type":"json"}]', 'title' => '获取接入点策略配置', ], 'DeleteAccessPointPolicy' => [ 'summary' => '删除接入点策略。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => [ 'title' => 'A short description of struct', 'description' => '接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'ap-01', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除接入点策略', ], 'PutAccessPointPolicy' => [ 'summary' => '配置接入点策略。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => false, 'example' => 'ap-01', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '接入点策略配置内容。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "Version":"1",'."\n" .' "Statement":['."\n" .' {'."\n" .' "Action":['."\n" .' "oss:PutObject",'."\n" .' "oss:GetObject"'."\n" .' ],'."\n" .' "Effect":"Deny",'."\n" .' "Principal":["27737962156157xxxx"],'."\n" .' "Resource":['."\n" .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01",'."\n" .' "acs:oss:ap-southeast-2:111933544165xxxx:accesspoint/$ap-01/object/*"'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .' } ', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '配置接入点策略', ], 'DeleteAccessPoint' => [ 'summary' => '删除接入点。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'header', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => true, 'example' => ' '."\n" .'ap-01', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除接入点', ], 'CreateAccessPoint' => [ 'summary' => '创建接入点。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存接入点信息的容器。', 'type' => 'object', 'properties' => [ 'CreateAccessPointConfiguration' => [ 'description' => '保存接入点配置的容器。', 'required' => false, '$ref' => '#/components/schemas/CreateAccessPointConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CreateAccessPointResult' => [ 'description' => '保存接入点信息的容器。', '$ref' => '#/components/schemas/CreateAccessPointResult', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '创建接入点', 'description' => '- 单个阿里云账号支持创建1000个接入点。'."\n" .'- 单个Bucket支持创建100个接入点。', ], 'InitiateBucketWorm' => [ 'summary' => '新建一条合规保留策略。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'InitiateWormConfiguration' => [ 'description' => '初始化合规保留策略的配置。', 'required' => false, '$ref' => '#/components/schemas/InitiateWormConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-worm-id' => [ 'schema' => [ 'sdkPropertyName' => 'wormId', 'type' => 'string', ], ], ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '新建合规保留策略', 'description' => '对象存储OSS支持WORM（Write Once Read Many）特性，允许以不可删除、不可篡改的方式保存和使用数据。OSS允许针对存储空间（Bucket）设置基于时间的合规保留策略，保护周期为1天到70年。'."\n" ."\n" .'- 当基于时间的合规保留策略创建24小时后未提交锁定，则该策略自动失效。当合规保留策略锁定后，您可以在Bucket中上传和读取文件（Object），但是在Object的保留时间到期之前，不允许删除Object及合规保留策略。Object的保留时间到期后，才可以删除Object。关于合规保留策略的更多信息，请参见[合规保留策略](~~90564~~)。'."\n" ."\n" .'- 同一个Bucket中，版本控制和合规保留策略无法同时配置。如果Bucket已开启版本控制功能，则无法再配置保留策略。关于版本控制功能更多信息，请参见[版本控制介绍](~~109685~~)。', ], 'AbortBucketWorm' => [ 'summary' => '删除指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除未锁定的合规保留策略', 'description' => '当基于时间的合规保留策略创建后，该策略默认处于InProgress状态，且该状态的有效期为24小时。在有效期24小时内，此策略对应的Bucket数据处于保护状态。'."\n" ."\n" .'- 启动合规保留策略24小时内：若此策略未提交锁定，则Bucket所有者以及授权用户可以删除此策略；若该保留策略已提交锁定，则不允许删除此策略，且无法缩短策略保护周期，仅可以延长保护周期。'."\n" ."\n" .'- 启动合规保留策略24小时后：若超过24小时该保留策略未提交锁定，则该策略自动失效。'."\n" ."\n" .'
如果Bucket内有文件处于保护周期内，那么您将无法删除合规保留策略，同时也无法删除Bucket。当Bucket为空时，Bucket的所有者可以删除该Bucket，从而间接删除该Bucket的保留策略。', ], 'CompleteBucketWorm' => [ 'summary' => '调用CompleteBucketWorm接口锁定合规保留策略。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'wormId', 'in' => 'query', 'schema' => [ 'title' => 'The ID of the retention policy', 'description' => '合规保留策略的ID。', 'type' => 'string', 'required' => true, 'example' => '1666E2CFB2B3418****', ], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '锁定合规保留策略', 'description' => '当基于时间的合规保留策略创建后，此策略默认处于InProgress状态，且该状态的有效期为24小时。在有效期24小时内，此策略对应的Bucket数据处于保护状态。'."\n" ."\n" .'- 启动合规保留策略24小时内：若此策略未提交锁定，则Bucket所有者以及授权用户可以删除此策略；若此保留策略已提交锁定，则不允许删除此策略，且无法缩短策略保护周期，仅可以延长保护周期。'."\n" ."\n" .'- 启动合规保留策略24小时后：若超过24小时此保留策略未提交锁定，则此策略自动失效。', ], 'ExtendBucketWorm' => [ 'summary' => '延长已锁定的合规保留策略对应Bucket中Object的保留天数。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'wormId', 'in' => 'query', 'schema' => [ 'description' => '合规保留策略的ID。'."\n" ."\n" .'> 如果指定用于延长Object保留天数对应的合规保留策略ID不存在，则返回404。', 'type' => 'string', 'required' => true, 'example' => '1666E2CFB2B3418****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存合规保留策略的容器。', 'type' => 'object', 'properties' => [ 'ExtendWormConfiguration' => [ 'description' => '保存合规保留策略的容器。', 'required' => false, '$ref' => '#/components/schemas/ExtendWormConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '4xx' => [], '5xx' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '延长存储空间中文件的保留天数', 'description' => '当基于时间的合规保留策略创建后，该策略默认处于InProgress状态，且该状态的有效期为24小时。在有效期24小时内，此策略对应的Bucket数据处于保护状态。'."\n" ."\n" .'- 启动合规保留策略24小时内：若此策略未提交锁定，则Bucket所有者以及授权用户可以删除此策略；若该保留策略已提交锁定，则不允许删除此策略，且无法缩短策略保护周期，仅可以延长保护周期。'."\n" ."\n" .'- 启动合规保留策略24小时后：若超过24小时该保留策略未提交锁定，则该策略自动失效。'."\n" ."\n" .'若Bucket内有文件处于保护周期内，那么您将无法删除合规保留策略，同时也无法删除Bucket。当Bucket为空时，Bucket的所有者可以删除该Bucket，从而间接删除该Bucket的保留策略。'."\n" ."\n\n" .'> 若指定用于延长Object保留天数对应的WORM ID不存在，则返回404。'."\n" ."\n", ], 'GetBucketWorm' => [ 'summary' => '获取指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'WormConfiguration' => [ 'description' => '存储Bucket合规保留策略的容器。', 'type' => 'object', 'properties' => [ 'WormId' => [ 'description' => '合规保留策略的ID。', 'type' => 'string', 'example' => '1666E2CFB2B3418****', ], 'State' => [ 'description' => '合规保留策略所处的状态。可选值：'."\n" ."\n" .'InProgress：合规保留策略创建后，该策略默认处于“InProgress”状态，且该状态的有效期为24小时。'."\n" ."\n" .'Locked：合规保留策略处于锁定状态。', '$ref' => '#/components/schemas/BucketWormState', ], 'RetentionPeriodInDays' => [ 'description' => 'Object的指定保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CreationDate' => [ 'description' => '合规保留策略的创建时间。', 'type' => 'string', 'example' => '2020-10-15T15:50:32', ], 'ExpirationDate' => [ 'description' => '合规保留策略的过期时间。', 'type' => 'string', 'example' => '2020-10-20T15:50:32'."\n", ], ], ], ], ], ], ], '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' => '获取存储空间的合规保留策略信息', 'description' => '对象存储OSS支持WORM（Write Once Read Many）特性，允许您以不可删除、不可篡改的方式保存和使用数据。OSS允许针对Bucket设置基于时间的合规保留策略，保护周期为1天到70年。
'."\n" .'当合规保留策略锁定后，您可以在Bucket中上传和读取文件（Object），但是在Object的保留时间到期之前，不允许删除Object及合规保留策略。Object的保留时间到期后，才可以删除Object。'."\n" ."\n\n" .'> 若指定用来获取Bucket的合规保留策略信息对应的WORM ID不存在，则返回404。'."\n", ], 'PutBucketAcl' => [ 'summary' => '设置或修改存储空间（Bucket）的访问权限（ACL）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-acl', 'in' => 'header', 'schema' => [ 'description' => '设置Bucket的访问权限ACL。PutBucketAcl接口通过Put请求中的x-oss-acl请求头来设置访问权限，如果没有该请求头，则访问权限设置不生效。'."\n" .'
取值如下：'."\n" ."\n" .'- public-read-write（公共读写）：所有用户都有该Bucket内的文件的读写权限。请谨慎使用该访问权限。'."\n" .'- public-read（公共读）：Bucket的拥有者和授权用户有该Bucket内的文件的读写权限，其他用户只有该Bucket内的文件的读权限。请谨慎使用该访问权限。'."\n" .'- private：Bucket的拥有者和授权用户有该Bucket内的文件的读写权限，其他用户没有权限操作该Bucket内的文件。', 'required' => true, 'enumValueTitles' => [ 'private' => '私有', 'public-read' => '公共读', 'public-read-write' => '公共读写', ], '$ref' => '#/components/schemas/BucketACL', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置或修改存储空间的访问权限', 'description' => '- 请求者需要对Bucket拥有写入ACL的权限`oss:PutBucketAcl`。'."\n" ."\n" .'- PutBucketAcl为覆盖语义，即新传入的ACL将覆盖原有的ACL。'."\n" ."\n" .'- 如果指定要设置ACL的Bucket不存在，调用该接口时将新建Bucket。', ], 'GetBucketAcl' => [ 'summary' => '获取某个存储空间（Bucket）的访问权限（ACL）。只有Bucket的拥有者才能获取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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessControlPolicy' => [ 'description' => '存储ACL信息的容器。', 'type' => 'object', 'properties' => [ 'Owner' => [ 'description' => '保存Bucket拥有者信息的容器。', '$ref' => '#/components/schemas/Owner', ], 'AccessControlList' => [ 'description' => '存储ACL信息的容器类。', 'type' => 'object', 'properties' => [ 'Grant' => [ 'description' => 'Bucket的ACL权限。', '$ref' => '#/components/schemas/BucketACL', ], ], ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间的访问权限', ], 'PutBucketLifecycle' => [ 'summary' => '设置存储空间的生命周期规则', 'path' => '/?lifecycle', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '9066', 'abilityTreeNodes' => [ 'FEATUREoss20S3WM', ], 'autoTest' => false, ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-allow-same-action-overlap', 'in' => 'header', 'schema' => [ 'description' => '指定生命周期规则是否允许前缀重叠。取值如下：'."\n" ."\n" .'true：允许前缀重叠。'."\n" ."\n" .'false：不允许前缀重叠。', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存Lifecycle配置的请求体。', 'type' => 'object', 'properties' => [ 'LifecycleConfiguration' => [ 'description' => 'Lifecycle配置的容器，最多可容纳1000条规则。', 'required' => false, '$ref' => '#/components/schemas/LifecycleConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间的生命周期规则', 'description' => '- 只有Bucket的拥有者以及被授予PutBucketLifecycle权限的RAM用户才能发起配置生命周期规则的请求。'."\n" ."\n" .'- 如果Bucket此前没有设置过生命周期规则，此操作会创建一个新的生命周期规则；如果Bucket此前设置过生命周期规则，此操作会覆写先前的规则配置。'."\n" ."\n" .'- PutBucketLifecycle是覆盖语义。当您需要追加生命周期规则时，请先调用GetBucketLifecycle接口获取当前生命周期规则配置，然后追加新的生命周期规则配置，最后调用PutBucketLifecycle接口更新生命周期规则配置。'."\n" ."\n" .'- PutBucketLifecycle操作可以对Object以及Part（以分片方式上传，但最后未提交的分片）设置过期时间。', ], 'GetBucketLifecycle' => [ 'summary' => '查看存储空间（Bucket）的生命周期规则（Lifecycle）。只有Bucket的拥有者才有权限查看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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应体', 'description' => '接口响应体', 'type' => 'object', 'properties' => [ 'LifecycleConfiguration' => [ 'title' => '保存存储空间生命周期规则的容器', 'description' => '存储Bucket生命周期规则的容器。', '$ref' => '#/components/schemas/LifecycleConfiguration', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n rule1\\n logs/\\n Enabled\\n \\n 2002-10-11T00:00:00.000Z\\n 365\\n true\\n 2002-10-11T00:00:00.000Z\\n \\n \\n 2002-10-11T00:00:00.000Z\\n 200\\n true\\n false\\n true\\n \\n \\n 300\\n 2002-10-11T00:00:00.000Z\\n \\n \\n \\n \\n \\n \\n 350\\n \\n \\n 200\\n true\\n false\\n true\\n \\n \\n \\n logs/keep/\\n \\n \\n \\n \\n \\n 10240\\n 10240\\n \\n 1626158525\\n \\n","type":"xml"}]', 'title' => '查询存储空间的生命周期规则', ], 'DeleteBucketLifecycle' => [ 'summary' => '调用DeleteBucketLifecycle接口删除指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的生命周期规则', 'description' => '- 只有Bucket的拥有者才能删除该Bucket的生命周期规则。'."\n" ."\n" .'- 调用DeleteBucketLifecycle接口删除指定Bucket所有的生命周期规则后，该Bucket中的文件（Object）不会被自动删除。', ], 'PutBucketTransferAcceleration' => [ 'summary' => '调用PutBucketTransferAcceleration接口为存储空间（Bucket）配置传输加速。开启传输加速后，可提升全球各地用户对OSS的访问速度，适用于远距离数据传输、GB或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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '传输加速配置的请求体。', 'type' => 'object', 'properties' => [ 'TransferAccelerationConfiguration' => [ 'description' => '传输加速配置的容器。', 'required' => false, '$ref' => '#/components/schemas/TransferAccelerationConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '为存储空间配置传输加速', 'description' => '- 只有Bucket拥有者以及被授予oss:PutBucketTransferAcceleration权限的RAM用户才能发起配置传输加速的请求。'."\n" ."\n" .'- 开启传输加速后，Bucket会在保留默认Endpoint的基础上新增传输加速域名，但必须使用OSS的传输加速域名才会提升访问速度。'."\n" ."\n" .'- 使用传输加速域名访问Bucket时，OSS会收取传输加速费用。详情请参见[传输加速费用](~~173539~~)。'."\n" ."\n" .'有关传输加速的更多信息，请参见开发指南的[传输加速](~~131312~~)。', ], 'GetBucketTransferAcceleration' => [ 'summary' => '调用GetBucketTransferAcceleration接口获取目标存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TransferAccelerationConfiguration' => [ 'description' => '保存传输加速配置信息的容器。', 'type' => 'object', 'properties' => [ 'Enabled' => [ 'description' => '是否开启传出加速。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取存储空间的传输加速配置', 'description' => '- 只有Bucket拥有者以及被授予oss:GetBucketTransferAcceleration权限的RAM用户才能发起获取传输加速配置的请求。'."\n" ."\n" .'- 如果Bucket未配置过传输加速，调用该接口时不返回加速配置状态。'."\n" ."\n" .'有关传输加速的更多信息，请参见开发指南的[传输加速](~~131312~~)。', ], 'PutBucketVersioning' => [ 'summary' => '设置指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '请求体。', 'type' => 'object', 'properties' => [ 'VersioningConfiguration' => [ 'description' => '保存版本控制配置容器。', 'required' => false, '$ref' => '#/components/schemas/VersioningConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间的版本控制状态', 'description' => '- 要配置版本控制，您必须有PutBucketVersioning权限。'."\n" ."\n" .'- Bucket包括未开启、开启（Enabled）或者暂停（Suspended）三种版本控制状态。默认情况下Bucket处于未开启版本控制状态。'."\n" ."\n" .'- 在Bucket处于开启版本控制状态下，所有新添加的文件（Object）都将拥有唯一的版本ID，OSS将累积所添加Object的多个版本。'."\n" ."\n" .'- 在Bucket处于暂停版本控制状态下，所有新添加Object的版本ID将为null，且OSS将不再为此状态下添加的Object累积更多的版本。'."\n" ."\n" .'关于版本控制的更多信息，请参见[版本控制介绍](~~109695~~)。', ], 'GetBucketVersioning' => [ 'summary' => '调用GetBucketVersioning接口获取指定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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'VersioningConfiguration' => [ 'description' => '保存版本控制状态的容器。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '版本控制状态。', '$ref' => '#/components/schemas/BucketVersioningStatus', ], ], ], ], ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '获取指定存储空间的版本控制状态', ], 'ListObjectVersions' => [ 'summary' => '列出Bucket中包括删除标记（Delete Marker）在内的所有Object的版本信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => [ 'title' => 'The character used to group objects by name', 'description' => '对Object名字进行分组的字符。所有Object名字包含指定的前缀（prefix），第一次出现delimiter字符之间的Object作为一组元素（即CommonPrefixes）。'."\n" .'如果将prefix设为文件夹名称后，再把delimiter设置为正斜线（/），则只返回该文件夹下的文件，该文件夹下的子文件名在CommonPrefixes中返回，子文件夹下递归的文件和文件夹不显示。'."\n" ."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '/', ], ], [ 'name' => 'key-marker', 'in' => 'query', 'schema' => [ 'title' => 'The name of the object from which the list operation begins', 'description' => '设定结果从key-marker之后按字母序开始返回，与version-id-marker组合使用。'."\n" .'参数的长度必须小于1024字节。'."\n" ."\n" .'默认值：无'."\n" ."\n" .'>如果version-id-marker不为空，则key-marker不能为空', 'type' => 'string', 'required' => false, 'example' => 'example', ], ], [ 'name' => 'version-id-marker', 'in' => 'query', 'schema' => [ 'title' => 'The version id of the object from which the list operation begins', 'description' => '设定结果从key-marker对象的version-id-marker之后按新旧版本排序开始返回。如果version-id-marker未设定，则默认从key-marker按字母序排序的下一个Key的第一个版本开始返回。'."\n" ."\n" .'默认值：无'."\n" ."\n" .'有效值：版本ID', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'title' => 'The maximum number of objects to return', 'description' => '限定此次返回Object的最大个数。'."\n" .'如果因为max-keys的设定无法一次完成列举，返回结果会附加`NextKeyMarker`和`NextVersionIdMarker`作为下一次列举的marker。列举结果中包含`NextKeyMarker`和`NextVersionIdMarker`的值。'."\n" .'取值：大于0小于1000'."\n" .'默认值：100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'title' => 'The prefix that the returned object names must contain', 'description' => '限定返回的Object Key必须以prefix作为前缀。'."\n" ."\n" .'- prefix的长度必须小于1024字节。'."\n" .'- 使用prefix查询时，返回结果的Key仍会包含prefix。'."\n" ."\n" .'如果将prefix设为某个文件夹名，则列举以此prefix开头的文件，即该文件夹下递归的所有的文件和子文件夹。'."\n" ."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'fun', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'title' => 'The encoding type of the object name in the response', 'description' => '对返回的内容进行编码并指定编码类型。'."\n" .'默认值：无'."\n" .'可选值：URL'."\n" .'>delimiter、marker、prefix、NextMarker以及Key使用UTF-8字符。如果delimiter、marker、prefix、NextMarker以及Key中包含XML'."\n" .' 1.0标准不支持的控制字符，您可以通过指定encoding-type对返回结果中的Delimiter、Marker、Prefix、NextMarker以及Key进行编码。', 'required' => false, '$ref' => '#/components/schemas/EncodeType', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetBucketVersions接口的响应体。', 'type' => 'object', 'properties' => [ 'ListVersionsResult' => [ 'description' => '保存GetBucketVersions请求结果的容器。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'The bucket name', 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Prefix' => [ 'title' => 'The prefix that the names of returned objects must contain', 'description' => '本次查询结果的前缀。', 'type' => 'string', 'example' => 'logs/', ], 'KeyMarker' => [ 'title' => 'Indicates the object from which the operation starts', 'description' => '标识此次GetBucketVersions的起点Object。', 'type' => 'string', 'example' => 'abc', ], 'VersionIdMarker' => [ 'title' => 'This parameter is returned with KeyMarker together to indicate the version from which the operation starts', 'description' => '与KeyMarker参数一同使用，以指定ListObjectVersions（GetBucketVersions）的起点。', 'type' => 'string', 'example' => 'CAEQGBiBgIC_jq7P9xYiIDRiZWJkNjY2Y2Q4NDQ5ZTI5ZGE5ODIxMTIyZThl****', ], 'MaxKeys' => [ 'title' => 'The maximum number of returned objects in the response', 'description' => '响应请求内返回结果的最大数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Delimiter' => [ 'description' => '用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现Delimiter字符之间的Object作为一组元素CommonPrefixes。', 'type' => 'string', 'example' => '/', ], 'IsTruncated' => [ 'title' => 'Indicates whether the returned results are truncated', 'description' => '指明是否已返回所有结果。'."\n" ."\n" .'true：表示本次没有返回全部结果。'."\n" ."\n" .'false：表示本次已返回全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'EncodingType' => [ 'description' => '指明返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，则表示对返回结果中的Delimiter、Marker、Prefix、NextMarker和Key这些元素进行编码。', 'type' => 'string', 'example' => 'url', ], 'NextKeyMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextKeyMarker元素，用于标明接下来请求的key-marker。', 'type' => 'string', 'example' => 'def', ], 'NextVersionIdMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextVersionIdMarker元素，用于标明接下来请求的version-id-marker。', 'type' => 'string', 'example' => 'CAEQMxiBgICbof2D0BYiIGRhZjgwMzJiMjA3MjQ0ODE5MWYxZDYwMzJlZjU1****', ], 'Version' => [ 'title' => 'The container that stores the versions of objects except for delete markers', 'description' => '保存除删除标记以外的Object版本信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存除删除标记以外的Object版本的容器。', '$ref' => '#/components/schemas/ObjectVersion', ], ], 'DeleteMarker' => [ 'title' => 'The container that stores delete markers', 'description' => '保存删除标记信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存删除标记的容器。', '$ref' => '#/components/schemas/DeleteMarkerEntry', ], ], 'CommonPrefixes' => [ 'title' => 'Objects whose names contain the same string that ranges from the prefix to the next occurrence of the delimiter are grouped as a single result element', 'description' => '如果请求中指定了delimiter参数，则OSS返回的响应中包含CommonPrefixes元素。该元素标明以delimiter结尾，并有共同前缀的Object名称的集合。', 'type' => 'array', 'items' => [ 'description' => '以delimiter结尾，并有共同前缀的Object名称。', '$ref' => '#/components/schemas/CommonPrefix', ], ], ], ], ], ], ], '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 dic/test.txt\\n CAEQMxiBgMDNoP2D0BYiIDE3MWUxNzgxZDQxNTRiODI5OGYwZGMwNGY3MzZjN****\\n false\\n 2023-04-09T07:27:28.000Z\\n \\"250F8A0AE989679A22926A875F0A2****\\"\\n 93731\\n \\n \\n \\n \\n ongoing-request=\\"true\\"\\n 2023-04-09T07:27:28.000Z\\n \\n \\n \\n \\n true\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取文件的版本信息', 'description' => '- GetBucket(ListObjects)接口仅返回Object的当前版本，且当前版本不能为删除标记。'."\n" .'- GetBucketVersions(ListObjectVersions)接口返回Bucket中所有Object的所有版本。'."\n" ."\n" .'不同Object之间按字母排序返回，同一个Object的不同版本则按从新到旧排序，与版本ID的字母序无关。', ], 'PutBucketPolicy' => [ 'summary' => '为指定的存储空间（Bucket）设置授权策略（Policy)。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'type' => 'string', 'format' => 'binary', 'required' => true, 'example' => '二进制内容', ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间的授权策略', 'description' => '- 向其他账号的RAM用户授权访问。'."\n" ."\n" .'您可以授予其他账号的RAM用户访问您的OSS资源的权限。'."\n" ."\n" .'- 向匿名用户授予带特定IP条件限制的访问权限。'."\n" ."\n" .'某些场景下，您需要向匿名用户授予带IP限制的访问策略。例如，企业内部的机密文档，只允许在企业内部访问，不允许在其他区域访问。由于企业内部人员较多，如果针对每个人配置RAM Policy，工作量非常大。此时，您可以基于Bucket Policy设置带IP限制的访问策略，从而高效方便地进行授权。'."\n" ."\n" .'有关Bucket Policy的配置详情及场景案例，请参见[使用Bucket Policy授权其他用户访问OSS资源](~~85111~~)。有关Policy语法，请参见[权限策略语法和结构](~~93739~~)。', ], 'GetBucketPolicy' => [ 'summary' => '获取指定存储空间（Bucket）的权限策略（Policy）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '字节流形式的Object内容。', 'type' => 'string', 'example' => '-', ], ], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\"-\\"","type":"json"}]', 'title' => '获取存储空间的权限策略', 'description' => '- 向其他账号的RAM用户授权访问。'."\n" ."\n" .'您可以授予其他账号的RAM用户访问您的OSS资源的权限。'."\n" ."\n" .'- 向匿名用户授予带特定IP条件限制的访问权限。'."\n" ."\n" .'某些场景下，您需要向匿名用户授予带IP限制的访问策略。例如，企业内部的机密文档，只允许在企业内部访问，不允许在其他区域访问。由于企业内部人员较多，如果针对每个人配置RAM Policy，工作量非常大。此时，您可以基于Bucket Policy设置带IP限制的访问策略，从而高效方便地进行授权。'."\n" ."\n" .'有关Bucket Policy的配置详情及场景案例，请参见[使用Bucket Policy授权其他用户访问OSS资源](~~85111~~)。有关Policy语法，请参见[权限策略语法和结构](~~93739~~)。'."\n", ], 'DeleteBucketPolicy' => [ 'summary' => '删除指定存储空间（Bucket）的权限策略（Policy）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的权限策略', 'description' => '- 向其他账号的RAM用户授权访问。'."\n" ."\n" .'您可以授予其他账号的RAM用户访问您的OSS资源的权限。'."\n" ."\n" .'- 向匿名用户授予带特定IP条件限制的访问权限。'."\n" ."\n" .'某些场景下，您需要向匿名用户授予带IP限制的访问策略。例如，企业内部的机密文档，只允许在企业内部访问，不允许在其他区域访问。由于企业内部人员较多，如果针对每个人配置RAM Policy，工作量非常大。此时，您可以基于Bucket Policy设置带IP限制的访问策略，从而高效方便地进行授权。'."\n" ."\n" .'有关Bucket Policy的配置详情及场景案例，请参见[使用Bucket Policy授权其他用户访问OSS资源](~~85111~~)。有关Policy语法，请参见[权限策略语法和结构](~~93739~~)。'."\n", ], 'GetBucketPolicyStatus' => [ 'summary' => '查看当前Bucket Policy是否允许公共访问。', 'path' => '/?policyStatus', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207996', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', 'FEATUREossHKEIZ2', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => false, 'example' => 'example-bucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'PolicyStatus' => [ 'description' => '保存公共访问信息的容器。', 'type' => 'object', 'properties' => [ 'IsPublic' => [ 'description' => '当前Bucket Policy是否包含公共访问的语义。'."\n" .'- true：包含公共访问的语义。'."\n" .'- false：不包含公共访问的语义或者没有设置Bucket Policy。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取存储空间授权策略是否是公共访问', 'description' => '阿里云账号默认拥有查看当前Bucket Policy是否允许公共访问的权限。如果您希望通过RAM用户或者STS的方式进行查看，您必须拥有`oss:GetBucketPolicyStatus`权限。', ], 'PutBucketRtc' => [ 'summary' => '为已有的跨区域复制规则开启或关闭数据复制时间控制（RTC）功能。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存RTC配置规则的请求体。', 'type' => 'object', 'properties' => [ 'ReplicationRule' => [ 'description' => '保存RTC配置规则的容器。', 'required' => false, '$ref' => '#/components/schemas/RtcConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置RTC', ], 'PutBucketReplication' => [ 'summary' => '为存储空间（Bucket）指定数据复制规则。OSS支持跨区域复制（Cross-Region Replication）和同区域复制（Same-Region Replication）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '指定数据复制配置的请求体。', 'type' => 'object', 'properties' => [ 'ReplicationConfiguration' => [ 'description' => '保存数据复制配置信息的容器。', 'type' => 'object', 'properties' => [ 'Rule' => [ 'required' => false, '$ref' => '#/components/schemas/ReplicationRule', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-replication-rule-id' => [ 'schema' => [ 'title' => '新增数据复制规则的ID', 'type' => 'string', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '指定存储空间的数据复制规则', 'description' => '数据复制是以异步（近实时）方式将源Bucket中的文件（Object）以及对Object的创建、更新和删除等操作自动复制到目标Bucket。使用数据复制时，有如下注意事项：'."\n" ."\n" .'- 数据复制采用异步复制，数据复制到目标Bucket需要一定的时间，通常几分钟到几小时不等，具体取决于数据的大小。'."\n" ."\n" .'- 源Bucket与目标Bucket的名称不能相同。'."\n" ."\n" .'- 使用跨区域复制时，源Bucket与目标Bucket必须处于不同的数据中心；使用同地域复制时，源Bucket与目标Bucket必须处于相同的数据中心。'."\n" ."\n" .'关于数据复制的更多信息，请分别参见[跨区域复制介绍](https://help.aliyun.com/document_detail/31864.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-zjp-31z-5db)和[同区域复制介绍](https://help.aliyun.com/document_detail/254865.htm?spm=a2c4g.11186623.0.0.32af6265m8tpXg#concept-2067125)。', ], 'GetBucketReplication' => [ 'summary' => '获取某个存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ReplicationConfiguration' => [ 'description' => '保存复制规则的列表。', 'type' => 'object', 'properties' => [ 'Rule' => [ 'description' => '保存复制规则的容器。', 'type' => 'array', 'items' => [ 'description' => '复制规则信息。', '$ref' => '#/components/schemas/ReplicationRule', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n first-repl-rule\\n \\n to-backup/\\n \\n ALL\\n \\n destbucket\\n oss-cn-hangzhou\\n internal\\n \\n doing\\n disabled\\n aliyunramrole\\n \\n \\n Disabled\\n \\n \\n \\n c4d49f85-ee30-426b-a5ed-95e9139dxxxxx\\n \\n \\n Enabled\\n \\n \\n","type":"xml"}]', 'title' => '设置存储空间的数据复制规则', ], 'GetBucketReplicationLocation' => [ 'summary' => '获取可复制到的目标存储空间（Bucket）所在的地域。您可以根据返回结果决定将源Bucket的数据复制到哪个地域。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '获取可复制地域请求的响应体。', 'type' => 'object', 'properties' => [ 'ReplicationLocation' => [ 'description' => '可复制地域信息的容器。', 'type' => 'object', 'properties' => [ 'Location' => [ 'description' => '可复制到的目标Bucket所在的地域列表。'."\n" ."\n" .'> 如果有多个可复制到的目标地域，那么返回的结果中包含多个Location。如果没有可复制到的目标地域，则返回的Location为空。', 'type' => 'array', 'items' => [ 'description' => '可复制到的目标Bucket所在的地域，例如oss-cn-beijing。', 'type' => 'string', 'example' => 'oss-cn-beijing', ], ], 'LocationTransferTypeConstraint' => [ 'description' => '包含TransferType约束的Location信息容器。', 'type' => 'object', 'properties' => [ 'LocationTransferType' => [ 'description' => '包含TransferType的Location信息容器。', 'type' => 'array', 'items' => [ 'description' => 'TransferType的Location信息。', '$ref' => '#/components/schemas/LocationTransferType', ], ], ], ], 'LocationRTCConstraint' => [ 'description' => '包含RTC约束的Location信息容器。', 'type' => 'object', 'properties' => [ 'Location' => [ 'description' => '支持RTC的Location信息列表。', 'type' => 'array', 'items' => [ 'description' => '支持RTC的Location信息。', 'type' => 'string', 'example' => 'oss-cn-beijing', ], ], ], ], ], ], ], ], ], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n oss-cn-beijing\\n \\n \\n oss-eu-west-1\\n \\n oss_acc\\n \\n \\n \\n \\n oss-cn-beijing\\n \\n","type":"xml"}]', 'title' => '获取可复制到的目标存储空间的地域', ], 'GetBucketReplicationProgress' => [ 'summary' => '获取某个存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'rule-id', 'in' => 'query', 'schema' => [ 'description' => '复制规则对应的ID。此ID可从GetBucketReplication中获取。', 'type' => 'string', 'required' => true, 'example' => 'test_replication_1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存每个复制规则进度条目的响应体。', 'type' => 'object', 'properties' => [ 'ReplicationProgress' => [ 'description' => '保存每个复制规则进度条目的列表。', 'type' => 'object', 'properties' => [ 'Rule' => [ 'description' => '保存复制规则进度信息的容器。', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/ReplicationProgressRule', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n replicate001\\n \\n to-backup/\\n \\n ALL\\n \\n destbucket\\n oss-cn-hangzhou\\n internal\\n \\n doing\\n disabled\\n \\n 0.85\\n Thu, 24 Sep 2015 15:39:18 GMT\\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间的数据复制进度', ], 'DeleteBucketReplication' => [ 'summary' => '停止某个存储空间（Bucket）的数据复制并删除Bucket的复制配置，此时源Bucket中的任何操作都不会被同步到目标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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存需要删除的数据复制规则的请求体。', 'type' => 'object', 'properties' => [ 'ReplicationRules' => [ 'description' => '保存需要删除的数据复制规则的容器。', 'type' => 'object', 'properties' => [ 'ID' => [ 'description' => '需要删除的数据复制规则的名称。', 'type' => 'string', 'required' => false, 'example' => 'first-rule', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '停止存储空间的数据复制并删除其复制配置', 'description' => '- 当请求的Bucket没有配置数据复制规则时，调用此接口将返回200 HTTP OK。'."\n" ."\n" .'- 调用此接口删除某个数据复制规则时，该复制规则不会立刻被删除。OSS需要一定的时间来执行清理操作，此时复制规则的状态为closing。当清理工作完成后，该复制规则才被删除。'."\n" ."\n" .'- 当请求的Bucket的数据复制规则处于closing状态时，调用此接口将返回204 NoContent。', ], 'PutBucketInventory' => [ 'summary' => '为指定存储空间（Bucket）配置清单（Inventory）规则。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => [ 'description' => '配置的清单规则Id。', 'type' => 'string', 'required' => true, 'example' => 'report1', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '存储清单配置信息的请求体。', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => [ 'description' => '存储清单配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/InventoryConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"type":"xml","example":"\\n","errorExample":""},{"type":"xml","example":"\\n","errorExample":""}]', 'title' => '配置存储空间的清单规则', 'description' => "\n" .'- 只有Bucket的拥有者以及被授予PutBucketInventory权限的用户才能发起配置清单规则的请求。'."\n" ."\n" .'- 配置清单规则前需生成一个RAM角色，该角色需要拥有读取源Bucket所有文件和向目标Bucket写入文件的权限。首次使用清单功能时，建议您通过OSS控制台进行配置。清单规则配置完成后，您可以获取拥有所有权限的RAM角色。有关配置清单规则中RAM角色的权限说明，请参见[存储空间清单](~~163489~~)。'."\n" ."\n" .'- 单个Bucket最多只能配置1000条清单规则。'."\n" ."\n" .'- 配置清单的源Bucket与存放清单文件的目标Bucket必须位于同一个Region。', 'extraInfo' => '### SDK'."\n" .'- [Java](~~177804~~)'."\n" .'- [Python](~~177819~~)'."\n" .'- [Go](~~177811~~)'."\n" .'- [C++](~~177809~~)'."\n" .'- [.NET](~~178701~~)'."\n" .'- [Node.js](~~186530~~)'."\n" ."\n" .'### 错误码'."\n" .'|错误码|HTTP状态码|描述|'."\n" .'|--|--|--|'."\n" .'|InvalidArgument|400|传入非法参数。|'."\n" .'|InventoryExceedLimit|400|超出清单配置规则的数量限制。|'."\n" .'|AccessDenied|403|
**·**发起PutBucketInventory请求时，没有传入用户验证信息。
**·**用户无操作权限。'."\n" .'|InventoryAlreadyExist|409|请求的清单规则已存在。|', ], 'GetBucketInventory' => [ 'summary' => '查看某个存储空间（Bucket）中指定的清单（Inventory）任务。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => [ 'title' => 'The ID of the inventory rule to query', 'description' => '查询的清单规则Id。', 'type' => 'string', 'required' => true, 'example' => 'list1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'The inventory task configured for a bucket', 'description' => 'The inventory task configured for a bucket', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => [ 'description' => 'Bucket的清单任务信息。', '$ref' => '#/components/schemas/InventoryConfiguration', ], ], ], ], '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 abcd\\n \\n \\n \\n \\n \\n \\n Pics/\\n 1637883649\\n 1638347592\\n 1024\\n 1048576\\n All\\n OR_FILTER\\n tag1#val1;tag2#val2\\n \\n Current\\n \\n \\n true\\n \\n 600\\n \\n \\n Etag\\n \\n \\n","type":"xml"}]', 'title' => '查看存储空间的清单任务', 'description' => '调用该请求时，请确保您有足够的权限对存储空间的清单任务进行操作。存储空间所有者默认拥有该权限，若您无该项权限，请先向存储空间所有者申请该项操作的权限。', ], 'ListBucketInventory' => [ 'summary' => '批量获取某个存储空间（Bucket）中的所有清单（Inventory）任务。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => [ 'description' => '指定List操作需要从此token开始。您可从ListBucketInventory结果中的NextContinuationToken获取此token。', 'type' => 'string', 'required' => false, 'example' => 'first', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ListInventoryConfigurationsResult' => [ 'description' => '存放清单配置参数的容器。', 'type' => 'object', 'properties' => [ 'InventoryConfiguration' => [ 'description' => '存放清单配置参数的容器。', 'type' => 'array', 'items' => [ 'description' => '清单配置内容。', '$ref' => '#/components/schemas/InventoryConfiguration', ], ], 'IsTruncated' => [ 'description' => '是否列举全部的清单任务。'."\n" ."\n" .'有效值：true或false'."\n" ."\n" .'如果值为false，则表明存储空间中的所有清单任务已全部列出。'."\n" ."\n" .'如果值为true，表示还未完整列出存储空间中的所有清单任务，您可以将NextContinuationToken字段的值作为下一次list请求的continuation-token参数，以获取下一页的清单配置列表。', 'type' => 'boolean', 'example' => 'true', ], 'NextContinuationToken' => [ 'description' => '当响应中的IsTruncated为true且NextContinuationToken非空时，使用该字段作为下一次list请求的continuation-token参数。', 'type' => 'string', 'example' => '当响应中的IsTruncated为true且NextContinuationToken非空时，使用该字段作为下一次list请求的continuation-token参数。', ], ], ], ], ], ], '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 abcd\\n \\n \\n \\n \\n \\n \\n Pics/\\n 1637883649\\n 1638347592\\n 1024\\n 1048576\\n All\\n OR_FILTER\\n tag1#val1;tag2#val2\\n \\n Current\\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' => '批量获取存储空间的所有清单任务', 'description' => '- 单次请求最多可获取100条清单配置项内容。若需获取超过100条清单配置项，则需发送多次请求，并保留相应的token，作为下一次请求的参数。'."\n" ."\n" .'- 调用该请求时，请确保您有足够的权限对存储空间的清单任务进行操作。存储空间所有者默认拥有该权限，若您无该项权限，请先向存储空间所有者申请该项操作的权限。', ], 'DeleteBucketInventory' => [ 'summary' => '删除某个存储空间（Bucket）中指定的清单（Inventory）任务。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'inventoryId', 'in' => 'query', 'schema' => [ 'title' => 'The ID of the inventory task to delete', 'description' => '删除的清单任务Id。', 'type' => 'string', 'required' => true, 'example' => 'list1', ], ], ], 'responses' => [ 200 => [], '4xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的指定清单任务', 'description' => '- 调用该请求时，请确保您有足够的权限对存储空间的清单任务进行操作。存储空间所有者默认拥有该权限，若您无该项权限，请先向存储空间所有者申请该项操作的权限。'."\n" .'- 请求成功将返回HTTP状态码204。', ], 'PutBucketLogging' => [ 'summary' => '为存储空间（Bucket）开启日志转存功能，可将OSS的访问日志按照固定命名规则，以小时为单位生成日志文件写入您指定的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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '存储访问日志状态信息的请求体。', 'type' => 'object', 'properties' => [ 'BucketLoggingStatus' => [ 'description' => '存储访问日志状态信息的容器。', 'required' => false, '$ref' => '#/components/schemas/BucketLoggingStatus', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '开启存储空间的日志转存功能', 'description' => '- 生成日志的源Bucket和存储日志的目标Bucket可以相同也可以不同，但是必须属于同一账号下的相同地域。'."\n" ."\n" .'- 日志文件以小时为单位生成，但并不表示某个时段的日志文件记录了该时段的所有请求，部分请求可能会出现在上一时段或下一时段的日志文件中。'."\n" .'日志文件命名规则及日志格式说明，请参见[日志转存](~~31868~~)。'."\n" ."\n" .'- 在您关闭日志转存功能前，OSS的日志文件会一直生成。请及时清理不再需要的日志文件，以减少您的存储费用。'."\n" .'您可以通过生命周期规则定期删除日志文件。更多信息，请参见[生命周期规则介绍](~~31863~~)。'."\n" ."\n" .'- OSS会根据需求在日志的尾部添加一些字段，请您在开发日志处理工具时考虑兼容性的问题。', ], 'GetBucketLogging' => [ 'summary' => '查看存储空间（Bucket）的访问日志配置。只有Bucket的拥有者才能查看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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BucketLoggingStatus' => [ 'title' => '保存存储空间日志转存配置的容器', 'description' => '访问日志状态信息的容器。', '$ref' => '#/components/schemas/BucketLoggingStatus', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n examplebucket\\n MyLog-\\n AliyunOSSLoggingDefaultRole\\n \\n","type":"xml"}]', 'title' => '查看存储空间的访问日志配置', ], 'DeleteBucketLogging' => [ 'summary' => '关闭存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '关闭存储空间的访问日志记录功能', 'description' => '- 只有Bucket的拥有者才有权限关闭Bucket访问日志记录功能。'."\n" .'- 如果目标Bucket没有开启访问日志记录功能，则返回参数显示204状态码。', ], 'PutUserDefinedLogFieldsConfig' => [ 'summary' => '为存储空间（Bucket）实时日志中的user_defined_log_fields字段进行个性化配置。您可以将OSS请求中用户关心的请求头或查询参数信息记录到该字段中去以便后续分析请求。', 'path' => '/?userDefinedLogFieldsConfig', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '接口请求体。', 'type' => 'object', 'properties' => [ 'UserDefinedLogFieldsConfiguration' => [ 'description' => '用户自定义日志配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/UserDefinedLogFieldsConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间实时日志用户自定义字段配置', 'description' => '- 本功能将相关信息统一编码后填入固定字段user_defined_log_fields中。user_defined_log_fields字段的值是一个JSON文本Base64编码后的值，这个JSON文本默认有一个字段为“truncated”用于表示是否有截断发生，另外有两个字段“headers”和“querys”分别对应用户配置的请求头和查询参数信息。'."\n" ."\n" .'- 自定义请求头个数和查询参数的个数之和不能超过6。'."\n" ."\n" .'- 自定义请求头及查询参数的key、value长度总和不能超过1024字节，超过部分会被截断。'."\n" ."\n" .'- 请求头不支持下划线（_），可以使用短划线（-）替代。查询参数支持下划线（_）。'."\n" ."\n" .'- 请求头需要遵从HTTP协议的规定。必须是可打印的ASCII字符，即字符33到字符126，支持小数点（.），不支持冒号（：）。', ], 'GetUserDefinedLogFieldsConfig' => [ 'summary' => '获取存储空间（Bucket）实时日志中user_defined_log_fields字段的个性化配置。', 'path' => '/?userDefinedLogFieldsConfig', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存用户自定义日志配置信息的容器。', 'type' => 'object', 'properties' => [ 'UserDefinedLogFieldsConfiguration' => [ 'description' => '用户自定义日志配置信息的容器。', '$ref' => '#/components/schemas/UserDefinedLogFieldsConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n

header1

\\n \\n \\n param1\\n \\n","type":"xml"}]', 'title' => '获取存储空间实时日志用户自定义字段配置', ], 'DeleteUserDefinedLogFieldsConfig' => [ 'summary' => '删除存储空间（Bucket）实时日志中user_defined_log_fields字段的个性化配置。', 'path' => '/?userDefinedLogFieldsConfig', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => false, 'example' => 'example-bucket'."\n", ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间实时日志用户自定义字段配置', ], 'GetBucketWebsite' => [ 'summary' => '查看存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'WebsiteConfiguration' => [ 'description' => '保存静态网站配置信息的容器。', '$ref' => '#/components/schemas/WebsiteConfiguration', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n index.html\\n true\\n 0\\n \\n \\n error.html\\n 200\\n \\n \\n \\n 1\\n \\n abc/\\n .txt\\n 404\\n \\n test-header\\n test-value\\n test-prefix-\\n -test-suffix\\n \\n \\n \\n Mirror\\n true\\n http://example.com/\\n true\\n true\\n true\\n false\\n \\n false\\n pass-header\\n remove-header\\n \\n set-header\\n set-value\\n \\n \\n https\\n example.com\\n def/\\n true\\n prefix/${key}.suffix\\n 302\\n false\\n https://example.com\\n https://example.com/hartbeat\\n true\\n false\\n true\\n false\\n true\\n cn-hangzhou\\n vpc-test-id\\n vpc-test-id\\n false\\n false\\n test-tunnel-id\\n false\\n aliyun-test-role\\n true\\n false\\n 303\\n \\n \\n test-tagging\\n test-value\\n \\n \\n \\n \\n test-header\\n test-value\\n \\n \\n \\n S3V4\\n ap-southeast-1\\n TESTAK\\n TESTSK\\n \\n \\n \\n 32\\n https://test-multi-alter.example.com\\n vpc-test-id\\n ap-southeast-1\\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '查看存储空间的静态网站托管状态和规则', ], 'PutBucketWebsite' => [ 'summary' => '将存储空间（Bucket）设置为静态网站托管模式并设置跳转规则（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存静态网站配置的容器。', 'type' => 'object', 'properties' => [ 'WebsiteConfiguration' => [ 'description' => '保存静态网站配置的容器。', 'required' => false, '$ref' => '#/components/schemas/WebsiteConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间为静态网站托管模式并设置跳转规则', 'description' => '- 功能支持：此接口主要用于设置默认主页、默认404页和RoutingRule。RoutingRule用来指定3xx跳转规则以及镜像回源规则。其中镜像回源支持公共云和金融云。'."\n" ."\n" .'- 使用自有域名访问静态网站：如果要使用自有域名来访问基于Bucket的静态网站，您可以通过域名CNAME来实现。具体操作，请参见绑定自定义域名。'."\n" ."\n" .'- 索引页面和错误页面：将一个Bucket设置为静态网站托管模式时，如果指定了索引页面或错误页面，则指定的索引页面和错误页面为该Bucket内的某个Object。'."\n" ."\n" .'- 对静态网站根域名的匿名访问：将一个Bucket设置为静态网站托管模式后，对静态网站根域名的匿名访问，OSS将返回索引页面。对静态网站根域名的签名访问，OSS将返回GetBucket(ListObjects)的结果。', ], 'DeleteBucketWebsite' => [ 'summary' => '关闭存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '关闭存储空间的静态网站托管模式以及跳转规则', 'description' => '只有Bucket的拥有者才能关闭Bucket的静态网站托管模式。', ], 'PutBucketReferer' => [ 'summary' => '设置存储空间（Bucket）级别的防盗链（Referer）访问白名单，支持设置是否允许Referer字段为空以及是否允许截断QueryString的请求访问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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存Referer配置内容的请求体。', 'type' => 'object', 'properties' => [ 'RefererConfiguration' => [ 'description' => '保存Referer配置内容的容器。', 'required' => false, '$ref' => '#/components/schemas/RefererConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间的防盗链', ], 'GetBucketReferer' => [ 'summary' => '查看存储空间（Bucket）的防盗链（Referer）相关配置。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存Referer配置内容的容器。', 'type' => 'object', 'properties' => [ 'RefererConfiguration' => [ '$ref' => '#/components/schemas/RefererConfiguration', ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n false\\n false\\n \\n https://www.aliyun.com\\n \\n \\n https://www.abc.com\\n \\n","type":"xml"}]', 'title' => '查看存储空间的防盗链相关配置', ], 'PutBucketTags' => [ 'summary' => '给某个存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '设置Bucket TagSet的请求体。', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => '设置Bucket TagSet的容器。', 'required' => false, '$ref' => '#/components/schemas/Tagging', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '为存储空间添加或修改标签', 'description' => '- 只有Bucket的拥有者及授权RAM账户才能为Bucket设置用户标签，否则返回403 Forbidden错误，错误码为AccessDenied。'."\n" ."\n" .'- 最多可设置20对Bucket用户标签（Key-Value对）。'."\n" ."\n" .'- PutBucketTags是覆盖语义，即新添加的标签会完全覆盖已有的标签。'."\n", ], 'GetBucketTags' => [ 'summary' => '获取存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => '保存Bucket Tag结果的容器。', 'type' => 'object', 'properties' => [ 'TagSet' => [ 'description' => '保存标签集合的容器。', '$ref' => '#/components/schemas/TagSet', ], ], ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间的标签信息', ], 'DeleteBucketTags' => [ 'summary' => '删除存储空间（Bucket）标签。', 'path' => '/?tagging', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的标签', 'description' => '如果目标Bucket没有任何标签或指定标签的Key不存在，则返回HTTP状态码204。', ], 'ListUserDataRedundancyTransition' => [ 'summary' => '获取用户级别存储冗余类型转换的列表。', 'path' => '/?redundancyTransition', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207254', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => [ 'title' => '指定List操作需要从此token开始。', 'description' => '指定List操作需要从此token开始。', 'type' => 'string', 'required' => false, 'example' => 'abc', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'title' => '限定此次返回任务的最大个数。取值范围：1-100。', 'description' => '限定此次返回任务的最大个数。取值范围：1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '保存接口响应内容的容器。', 'description' => '保存接口响应内容的容器。', 'type' => 'object', 'properties' => [ 'ListBucketDataRedundancyTransition' => [ 'title' => '列举存储冗余转换任务的容器。', 'description' => '列举存储冗余转换任务的容器。', 'type' => 'object', 'properties' => [ 'IsTruncated' => [ 'title' => '请求中返回的结果是否被截断。取值如下：'."\n" ."\n" .'true：表示本次未返回全部结果。'."\n" ."\n" .'false：表示本次已返回全部结果。', 'description' => '请求中返回的结果是否被截断。取值如下：'."\n" ."\n" .'true：表示本次未返回全部结果。'."\n" ."\n" .'false：表示本次已返回全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'NextContinuationToken' => [ 'title' => '表明本次ListUserDataRedundancyTransition请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', 'description' => '表明本次ListUserDataRedundancyTransition请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', 'type' => 'string', 'example' => 'def', ], 'BucketDataRedundancyTransition' => [ 'title' => '存储冗余转换任务的容器。', 'description' => '存储冗余转换任务的容器。', 'type' => 'array', 'items' => [ 'title' => '存储冗余转换任务的结构信息。', 'description' => '存储冗余转换任务的结构信息。', '$ref' => '#/components/schemas/BucketDataRedundancyTransition', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n def\\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' => '列举用户级别存储冗余类型转换任务', ], 'ListBucketDataRedundancyTransition' => [ 'summary' => '列举某个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' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '存储空间冗余类型转换任务。', 'type' => 'object', 'properties' => [ 'ListBucketDataRedundancyTransition' => [ 'description' => '列举存储冗余转换任务的容器。', 'type' => 'object', 'properties' => [ 'BucketDataRedundancyTransition' => [ 'description' => '存储冗余转换任务的信息。', '$ref' => '#/components/schemas/BucketDataRedundancyTransition', ], ], ], ], ], ], ], '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' => '列举存储空间冗余类型转换任务', 'description' => '- 要列举Bucket下所有的存储冗余转换任务，您必须具有`oss:ListBucketDataRedundancyTransition`权限。具体操作，请参见[为RAM用户授权自定义的权限策略](~~199058~~)。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。', ], 'GetBucketDataRedundancyTransition' => [ 'summary' => '获取存储冗余转换任务。', 'path' => '/?redundancyTransition', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207237', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-redundancy-transition-taskid', 'in' => 'query', 'schema' => [ 'description' => '存储转换任务的ID。', 'type' => 'string', 'required' => true, 'example' => '751f5243f8ac4ae89f34726534d1****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '存储冗余转换任务的容器。', 'type' => 'object', 'properties' => [ 'BucketDataRedundancyTransition' => [ 'description' => '存储冗余转换任务的容器。', '$ref' => '#/components/schemas/BucketDataRedundancyTransition', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\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","type":"xml"}]', 'title' => '获取存储空间存储冗余转换任务', 'description' => '- 要获取存储冗余转换任务，您必须具有oss:GetBucketDataRedundancyTransition权限。具体操作，请参见[为RAM用户授权自定义的权限策略](~~199058~~)。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。', ], 'CreateBucketDataRedundancyTransition' => [ 'summary' => '为Bucket创建存储冗余转换任务。', 'path' => '/?redundancyTransition', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '207235', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '要创建存储冗余类型转换任务的Bucket。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-target-redundancy-type', 'in' => 'query', 'schema' => [ 'description' => '目标存储冗余类型。OSS仅支持将LRS（本地冗余存储）转换为ZRS（同城冗余存储）。', 'type' => 'string', 'required' => true, 'example' => 'ZRS', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'BucketDataRedundancyTransition' => [ 'description' => '存储冗余转换任务的容器。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '存储冗余转换任务的ID。该ID可以用于后续查看、删除存储冗余转换任务。', 'type' => 'string', 'example' => ' '."\n" .'4be5beb0f74f490186311b268bf6****', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\t\\n4be5beb0f74f490186311b268bf6****\\n","type":"xml"}]', 'title' => '创建存储冗余类型转换任务', 'description' => '- Bucket所属地域支持转换存储冗余类型。支持转换存储冗余类型的地域：华东1（杭州）、华东2（上海）、华北2（北京）、华北3（张家口）、华北6（乌兰察布）、华南1（深圳）、中国香港、日本（东京）、新加坡、印度尼西亚（雅加达）、德国（法兰克福）'."\n" .'- Bucket的存储冗余类型必须为本地冗余存储。OSS仅支持将本地冗余存储转换为同城冗余存储。'."\n" .'- Bucket的存储类型必须为标准存储、低频访问存储或归档存储，但Bucket中的文件的存储类型可以为冷归档存储和深度冷归档存储。冷归档存储和深度冷归档存储的文件转换后依然为本地冗余存储。冷归档存储和深度冷归档存储的Bucket不支持转换存储冗余类型。'."\n" .'- 要创建存储冗余转换任务，您必须具有oss:CreateBucketDataRedundancyTransition权限。具体操作，请参见为[RAM用户授权自定义的权限策略](~~199058~~)。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。', ], 'DeleteBucketDataRedundancyTransition' => [ 'summary' => '删除存储空间数据冗余类型转换任务。', 'path' => '/?redundancyTransition', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '207246', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '要删除存储冗余类型转换任务的Bucket。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-redundancy-transition-taskid', 'in' => 'query', 'schema' => [ 'description' => '存储冗余转换任务的ID。', 'type' => 'string', 'required' => true, 'example' => '4be5beb0f74f490186311b268bf6****', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储冗余类型转换任务', 'description' => '- 要删除存储冗余转换任务，您必须具有`oss:DeleteBucketDataRedundancyTransition`权限。具体操作，请参见[为RAM用户授权自定义的权限策略](~~199058~~)。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。'."\n" .'- 处于Processing状态的任务不支持删除。', ], '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '配置服务器端加密规则的请求体。', 'type' => 'object', 'properties' => [ 'ServerSideEncryptionRule' => [ 'description' => '服务器端加密规则的容器。', 'required' => false, '$ref' => '#/components/schemas/ServerSideEncryptionRule', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '配置存储空间的加密规则', 'summary' => '配置存储空间（Bucket）的加密规则。', 'description' => '只有Bucket的拥有者及授权的RAM用户才能为Bucket设置加密规则，否则返回403错误。有关Bucket加密的更多信息，请参见[服务器端加密](~~31871~~)。'."\n", ], 'GetBucketEncryption' => [ 'summary' => '获取存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存服务端加密规则的响应体。', 'type' => 'object', 'properties' => [ 'ServerSideEncryptionRule' => [ 'description' => '保存服务端加密规则的容器。', 'type' => 'object', 'properties' => [ 'ApplyServerSideEncryptionByDefault' => [ 'description' => '服务端加密规则信息。', '$ref' => '#/components/schemas/ApplyServerSideEncryptionByDefault', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间的加密规则', 'description' => '只有Bucket的拥有者及授权的RAM用户才能获取Bucket的加密规则，否则返回403错误。有关Bucket加密的更多信息，请参见**[服务器端加密](~~31871~~)**。', ], 'DeleteBucketEncryption' => [ 'summary' => '删除指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的加密规则', 'description' => '只有Bucket的拥有者及授权的RAM用户才能删除Bucket的加密规则，否则返回403错误。有关Bucket加密的更多信息，请参见[服务器端加密](~~31871~~)。', ], 'PutBucketRequestPayment' => [ 'summary' => '设置某个存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '配置请求者付费的请求体。', 'type' => 'object', 'properties' => [ 'RequestPaymentConfiguration' => [ 'description' => '保存请求者付费配置的容器。', 'required' => false, '$ref' => '#/components/schemas/RequestPaymentConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置请求者付费模式', 'description' => '- 不允许匿名访问：如果您在Bucket上启用了请求者付费模式，则不允许匿名访问该Bucket。请求方必须提供身份验证信息，以便OSS能够识别请求方，从而对请求方而非Bucket拥有者收取请求所产生的费用。'."\n" .'当请求者是通过扮演阿里云RAM角色来请求数据时，该角色所属的账户将为此请求付费。'."\n" ."\n" .'- 申请方需携带x-oss-request-payer信息：如果您在Bucket上启用了请求者付费模式，请求方必须在其请求中包含x-oss-request-payer:requester（在POST、GET和HEAD请求的Header信息中），以表明请求方已知悉请求和数据下载将产生费用。否则，请求方无法通过验证。'."\n" .'数据拥有者访问该Bucket时，可以不携带x-oss-request-payer请求头。数据拥有者作为请求者访问该Bucket时，请求产生的费用由数据拥有者（也是请求者）来支付。', ], 'GetBucketRequestPayment' => [ 'summary' => '获取请求者付费模式的配置信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '获取请求者付费配置的响应体。', 'type' => 'object', 'properties' => [ 'RequestPaymentConfiguration' => [ 'description' => '请求者付费配置的容器。', 'type' => 'object', 'properties' => [ 'Payer' => [ 'description' => '指定Bucket付费类型。'."\n" ."\n" .'取值：BucketOwner、Requester', 'type' => 'string', 'enumValueTitles' => [ 'Requester' => '请求者付费', 'BucketOwner' => 'Bucket所有者付费', ], 'example' => 'Requester', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Requester\\n","type":"xml"}]', 'title' => '获取请求者付费模式配置信息', ], 'PutBucketCors' => [ 'summary' => '设置指定存储空间（Bucket）的跨域资源共享CORS（Cross-Origin Resource Sharing）规则。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '设置跨域资源共享规则的请求体。', 'type' => 'object', 'properties' => [ 'CORSConfiguration' => [ 'description' => '保存Bucket的CORS规则容器。', 'required' => false, '$ref' => '#/components/schemas/CORSConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"type":"xml","example":"\\n","errorExample":""},{"type":"xml","example":"\\n","errorExample":""}]', 'title' => '设置存储空间的跨域资源共享规则', 'description' => "\n" .'- 默认不开启CORS'."\n" .'
Bucket默认不开启CORS功能，所有跨域请求的Origin都不被允许。'."\n" ."\n" .'- 覆盖语义'."\n" .'
PutBucketCors为覆盖语义，即新配置的CORS规则将覆盖已有的CORS规则。'."\n" ."\n" .'- 应用程序中使用CORS'."\n" .'
在应用程序中使用CORS功能时，需通过PutBucketCors接口手动上传CORS规则来开启CORS功能。'."\n" .'
例如从`example.com`通过浏览器的`XMLHttpRequest`功能来访问OSS，需要通过本接口手动上传CORS规则，且CORS规则需由XML文档进行描述。'."\n" ."\n" .'- CORS规则匹配'."\n" .'
当OSS收到一个跨域请求或OPTIONS请求，会先读取Bucket对应的CORS规则，然后进行相应的权限检查。OSS会依次检查每一条规则，使用第一条匹配的规则来允许请求并返回对应的Header。如果所有规则都匹配失败，则不附加任何CORS相关的Header。'."\n" .'
CORS规则匹配成功必须满足以下三个条件：'."\n" .' - 请求的Origin必须匹配一个`AllowedOrigin`项。'."\n" ."\n" .' - 请求的方法（例如GET、PUT等）或者OPTIONS请求的`Access-Control-Request-Method`头对应的方法必须匹配一个`AllowedMethod`项。'."\n" ."\n" .' - OPTIONS请求的`Access-Control-Request-Headers`头包含的每个header都必须匹配一个`AllowedHeader`项。', '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" .'### 错误码'."\n" .'|错误码|HTTP状态码|描述|'."\n" .'|--|--|--|'."\n" .'|InvalidDigest|400|上传了Content-MD5请求头后，OSS会计算消息体的Content-MD5并检查一致性，如果不一致则返回此错误码。|', ], 'GetBucketCors' => [ 'summary' => '获取指定存储空间（Bucket）当前的跨域资源共享CORS（Cross-Origin Resource Sharing）规则。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CORSConfiguration' => [ 'description' => '保存CORS规则配置的容器。', 'type' => 'object', 'properties' => [ 'CORSRule' => [ 'description' => '保存CORS规则的列表。', 'type' => 'array', 'items' => [ 'description' => '保存CORS规则的容器。', '$ref' => '#/components/schemas/CORSRule', ], ], 'ResponseVary' => [ 'description' => '是否返回Vary: Origin头。'."\n" ."\n" .'true：不管发送的是否是跨域请求或跨域请求是否成功，均会返回Vary: Origin头。'."\n" ."\n" .'false：任何情况下均不返回Vary: Origin头。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n *\\n GET\\n x-oss-*\\n Expires\\n 300\\n \\n true\\n","type":"xml"}]', 'title' => '获取存储空间当前的跨域资源共享规则', 'description' => ' ', ], 'DeleteBucketCors' => [ 'summary' => '调用DeleteBucketCors接口关闭指定存储空间（Bucket）的跨域资源共享CORS（Cross-Origin Resource Sharing）功能并清空所有规则。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '关闭存储空间跨域资源共享功能', 'description' => '### 注意事项'."\n" .'要关闭CORS功能，您必须有`oss:DeleteBucketCors`权限。', ], 'OptionObject' => [ 'summary' => '浏览器在发送跨域请求之前会发送一个preflight请求（Options）给OSS，并带上特定的来源域、HTTP方法和header等信息，以决定是否发送真正的请求。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'Origin', 'in' => 'header', 'schema' => [ 'description' => '请求来源域，用于标识跨域请求。'."\n" .'在实际请求中只能设置一个该请求头。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com', ], ], [ 'name' => 'Access-Control-Request-Method', 'in' => 'header', 'schema' => [ 'description' => '在实际请求中会用到的方法。'."\n" .'在实际请求中只能设置一个该请求头。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'PUT', ], ], [ 'name' => 'Access-Control-Request-Headers', 'in' => 'header', 'schema' => [ 'description' => '在实际请求中会用到的除了简单头部之外的header。'."\n" .'在实际请求中可以为该请求头设置多个header，多个header之间使用英文逗号(,)隔开。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'x-oss-test1,x-oss-test2', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Access-Control-Allow-Origin' => [ 'schema' => [ 'type' => 'string', ], ], 'Access-Control-Allow-Methods' => [ 'schema' => [ 'type' => 'string', ], ], 'Access-Control-Allow-Headers' => [ 'schema' => [ 'type' => 'string', ], ], 'Access-Control-Expose-Headers' => [ 'schema' => [ 'type' => 'string', ], ], 'Access-Control-Max-Age' => [ 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '发送预检请求', 'description' => 'Options请求是由浏览器自动根据是否跨域来决定是否发送。', ], 'PutBucketAccessMonitor' => [ 'summary' => '修改存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '修改访问跟踪状态配置的请求体。', 'type' => 'object', 'properties' => [ 'AccessMonitorConfiguration' => [ 'description' => '保存Bucket的访问跟踪状态配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/AccessMonitorConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间访问追踪状态', ], 'GetBucketAccessMonitor' => [ 'summary' => '获取存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '请求响应体结构', 'description' => '请求响应体结构', 'type' => 'object', 'properties' => [ 'AccessMonitorConfiguration' => [ 'description' => '保存Bucket的访问跟踪状态配置信息的容器。', '$ref' => '#/components/schemas/AccessMonitorConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取存储空间访问追踪状态', ], 'GetMetaQueryStatus' => [ 'summary' => '获取指定存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '获取元数据索引信息的响应。', 'type' => 'object', 'properties' => [ 'MetaQueryStatus' => [ 'description' => '保存元数据索引信息的容器。', 'type' => 'object', 'properties' => [ 'State' => [ 'description' => '元数据索引库的状态。取值范围如下：'."\n" ."\n" .'Ready：创建后准备中'."\n" ."\n" .'元数据索引库正在准备中，您无法通过元数据索引库查询到数据。'."\n" ."\n" .'Stop：已暂停'."\n" ."\n" .'Running：运行中'."\n" ."\n" .'Retrying：创建失败后重试中'."\n" ."\n" .'Failed：创建失败'."\n" ."\n" .'Deleted：已删除', 'type' => 'string', 'example' => 'Runing', ], 'Phase' => [ 'description' => '当前扫描类型。取值范围如下：'."\n" ."\n" .'FullScanning：全量扫描中'."\n" ."\n" .'IncrementalScanning：增量扫描中', 'type' => 'string', 'example' => 'FullScanning', ], 'CreateTime' => [ 'description' => '元数据索引库的创建时间，遵循RFC 3339标准格式，格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE。其中YYYY-MM-DD表示年月日，T表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区。', 'type' => 'string', 'example' => '2021-08-02T10:49:17.289372919+08:00', ], 'UpdateTime' => [ 'description' => '元数据索引库的创建时间，遵循RFC 3339标准格式，格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE。其中YYYY-MM-DD表示年月日，T表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区。', 'type' => 'string', 'example' => '2021-08-02T10:49:17.289372919+08:00', ], ], ], ], ], ], ], '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' => '获取元数据索引库信息', ], 'CloseMetaQuery' => [ 'summary' => '关闭存储空间（Bucket）的元数据管理功能。OSS会自动删除Bucket的元数据索引库，将无法进行元数据索引。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '关闭存储空间元数据管理', ], 'DoMetaQuery' => [ 'summary' => '通过存储空间（Bucket）的元数据索引功能，查询满足指定条件的文件（Object），并按照字段和排序方式列出文件信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => [ 'title' => '指定检索模式。'."\n" .'- basic：标量检索（默认）'."\n" .'- semantic：向量检索', 'description' => '指定检索模式。'."\n" .'- basic：标量检索（默认）'."\n" .'- semantic：向量检索', 'type' => 'string', 'required' => false, 'example' => 'semantic', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体结构', 'description' => '保存查询条件的请求体。', 'type' => 'object', 'properties' => [ 'MetaQuery' => [ 'title' => '数据索引查询参数', 'description' => '保存查询条件的容器。', 'required' => false, '$ref' => '#/components/schemas/MetaQuery', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应体结构', 'description' => '保存查询结果的响应体。', 'type' => 'object', 'properties' => [ 'MetaQuery' => [ 'description' => '保存查询结果的容器。', '$ref' => '#/components/schemas/MetaQueryResp', ], ], ], ], ], '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 2\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\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 \\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 图片中有一人，穿着深色西装外套，内搭白色衬衫。背景为渐变的浅蓝色至灰色\\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' => '查询满足条件的文件', ], 'OpenMetaQuery' => [ 'summary' => '开启元数据管理功能。开启元数据管理功能后，OSS会为Bucket创建元数据索引库并为Bucket中的所有文件（Object）建立元数据索引。元数据索引库创建完成后，OSS会继续对Bucket中新增文件进行准实时的增量追踪扫描并为增量文件建立元数据索引。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => [ 'title' => '检索模式。取值如下：'."\n" ."\n" .'basic（默认值）：标量检索'."\n" ."\n" .'semantic：向量检索', 'description' => '检索模式。取值如下：'."\n" ."\n" .'basic（默认值）：标量检索'."\n" ."\n" .'semantic：向量检索', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'role', 'in' => 'query', 'schema' => [ 'title' => '指定用于访问 OSS 服务的 RAM 角色名称，支持在控制台为角色授予权限，实现安全访问。', 'description' => '指定用于访问 OSS 服务的 RAM 角色名称，支持在控制台为角色授予权限，实现安全访问。', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体参数', 'description' => '接口请求体参数', 'type' => 'object', 'properties' => [ 'MetaQuery' => [ 'title' => '保存为Bucket开启元数据管理功能的请求体参数', 'description' => '保存为Bucket开启元数据管理功能的请求体参数', 'required' => false, '$ref' => '#/components/schemas/MetaQueryOpenRequest', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '开启元数据管理功能', ], 'UpdateUserAntiDDosInfo' => [ 'summary' => '更改高防OSS实例状态。', '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' => '高防实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', ], ], [ 'name' => 'x-oss-defender-status', 'in' => 'header', 'schema' => [ 'description' => '更改高防OSS实例状态。取值为：HaltDefending，表示解除防护。', 'type' => 'string', 'required' => true, 'example' => 'HaltDefending', ], ], ], 'responses' => [ 200 => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '更改高防OSS实例状态', ], 'UpdateBucketAntiDDosInfo' => [ 'summary' => '更新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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-defender-instance', 'in' => 'header', 'schema' => [ 'description' => '高防实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', ], ], [ 'name' => 'x-oss-defender-status', 'in' => 'header', 'schema' => [ 'description' => '更新高防实例状态。取值如下：'."\n" ."\n" .'- Init：初始化防护状态。该状态下需要传入待防护的自定义域名。'."\n" ."\n" .'- Defending：防护中状态。该状态下可以选择是否传入待防护的自定义域名。'."\n" ."\n" .'- HaltDefending：解除防护状态。该状态下不需要传入待防护的自定义域名。', 'type' => 'string', 'required' => true, 'example' => 'Init', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存高防实例配置信息的请求体。', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => [ 'description' => '保存高防实例配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '更新Bucket防护状态', ], 'ListBucketAntiDDosInfo' => [ 'summary' => '获取Bucket防护信息列表。', 'path' => '/?bucketAntiDDos', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169392', 'abilityTreeNodes' => [ 'FEATUREossB6Q3Z5', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'marker', 'in' => 'query', 'schema' => [ 'description' => '设定从marker之后按字母排序开始返回高防实例。'."\n" ."\n" .'> 第一次请求时可以将marker设置为空字符串。如果返回结果中IsTruncated存在且为true，则需要将返回结果中的marker字段作为参数进行下一次请求。', 'type' => 'string', 'required' => false, 'example' => 'nextMarker', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'description' => '指定返回的高防实例最大数量。'."\n" ."\n" .'取值：[1,100]'."\n" ."\n" .'默认值：100', 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'AntiDDOSListConfiguration' => [ 'description' => '保存Bucket防护信息列表的容器。', 'type' => 'object', 'properties' => [ 'Marker' => [ 'description' => '返回字母排序在指定marker之后的高防实例。', 'type' => 'string', 'example' => 'abc', ], 'IsTruncated' => [ 'description' => '是否已返回所有高防实例。'."\n" ."\n" .'true：本次请求未返回所有高防实例。'."\n" ."\n" .'false：本次请求已返回所有高防实例。', 'type' => 'boolean', 'example' => 'true', ], 'AntiDDOSConfiguration' => [ 'description' => '保存高防实例信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存高防实例信息的容器。', '$ref' => '#/components/schemas/BucketAntiDDOSInfo', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n abc\\n true\\n \\n \\n \\n \\n 0\\n 0\\n 0\\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取Bucket防护信息列表', ], 'InitUserAntiDDosInfo' => [ 'summary' => '创建高防OSS实例。', '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' => '创建高防OSS实例', ], 'InitBucketAntiDDosInfo' => [ 'summary' => '初始化Bucket防护。', 'path' => '/?antiDDos', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'x-oss-defender-instance', 'in' => 'header', 'schema' => [ 'description' => '高防实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cbcac8d2-4f75-4d6d-9f2e-c3447f73****', ], ], [ 'name' => 'x-oss-defender-type', 'in' => 'header', 'schema' => [ 'description' => '高防实例类型。取值固定为AntiDDosPremimum。', 'type' => 'string', 'required' => true, 'example' => 'AntiDDosPremimum', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存高防实例配置信息的请求体。', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => [ 'description' => '保存高防实例配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/BucketAntiDDOSConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '初始化Bucket防护', ], 'GetUserAntiDDosInfo' => [ 'summary' => '查询指定账号下的高防OSS实例信息。', 'path' => '/?antiDDos', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169391', 'abilityTreeNodes' => [ 'FEATUREossB6Q3Z5', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '保存高防实例信息列表的响应体。', 'type' => 'object', 'properties' => [ 'AntiDDOSListConfiguration' => [ 'description' => '保存高防实例信息列表的容器。', 'type' => 'object', 'properties' => [ 'AntiDDOSConfiguration' => [ 'description' => '保存高防实例信息的容器。', 'type' => 'array', 'items' => [ 'description' => '高防实例信息。', '$ref' => '#/components/schemas/UserAntiDDOSInfo', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n 0\\n 0\\n 0\\n \\n \\n","type":"xml"}]', 'title' => '查询高防OSS实例信息', ], 'GetBucketResourceGroup' => [ 'summary' => '获取存储空间（Bucket）所属的资源组ID。', 'path' => '/?resourceGroup', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '要查询的目标Bucket', 'description' => '要查询的目标Bucket', 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '资源组ID的容器。', 'description' => '获取资源组ID的响应体。', 'type' => 'object', 'properties' => [ 'BucketResourceGroupConfiguration' => [ 'description' => '资源组ID的容器。', 'type' => 'object', 'properties' => [ 'ResourceGroupId' => [ 'title' => 'Bucket所属的资源组ID。', 'description' => 'Bucket所属的资源组ID。', 'type' => 'string', 'example' => 'rg-asdfklj***', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n rg-asdfklj***\\n","type":"xml"}]', 'title' => '获取存储空间资源组ID', ], 'PutBucketResourceGroup' => [ 'summary' => '修改存储空间（Bucket）所属的资源组ID。', 'path' => '/?resourceGroup', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '要修改的目标Bucket', 'description' => '要修改的目标Bucket', 'type' => 'string', 'required' => false, 'example' => 'example-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '配置资源组ID的请求体。', 'type' => 'object', 'properties' => [ 'BucketResourceGroupConfiguration' => [ 'description' => '配置资源组ID的容器。', 'required' => false, '$ref' => '#/components/schemas/BucketResourceGroupConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间资源组', ], 'PutCname' => [ 'summary' => '为某个存储空间（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存Cname配置的请求体。', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => [ 'description' => '保存Cname配置的容器。', 'required' => false, '$ref' => '#/components/schemas/BucketCnameConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '绑定自定义域名', ], 'ListCname' => [ 'summary' => '查询某个存储空间（Bucket）下绑定的所有的自定义域名（Cname）列表。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '查询Cname信息列表的响应体。', 'type' => 'object', 'properties' => [ 'ListCnameResult' => [ 'description' => '查询Cname信息列表的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'description' => '存储空间名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Owner' => [ 'description' => 'Bucket拥有者的用户ID。', 'type' => 'string', 'example' => '133413***273506', ], 'Cname' => [ 'description' => '保存Cname信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存Cname信息的容器。', '$ref' => '#/components/schemas/CnameInfo', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n 133413***273506\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '查询自定义域名列表', ], 'DeleteCname' => [ 'summary' => '删除某个存储空间（Bucket）已绑定的Cname。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '删除Cname配置信息的请求体。', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => [ 'description' => '保存Cname配置的容器。', 'type' => 'object', 'properties' => [ 'Cname' => [ 'description' => '保存目标Cname域名的容器。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'description' => '要删除的Cname。', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除Cname', ], 'GetCnameToken' => [ 'summary' => '获取已创建的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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'cname', 'in' => 'query', 'schema' => [ 'description' => '绑定的Cname名称。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存CnameToken的响应体。', 'type' => 'object', 'properties' => [ 'CnameToken' => [ 'description' => '保存CnameToken的容器。', '$ref' => '#/components/schemas/CnameToken', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取CnameToken', ], 'CreateCnameToken' => [ 'summary' => '创建域名所有权验证所需的CnameToken。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '创建CnameToken的请求体。', 'type' => 'object', 'properties' => [ 'BucketCnameConfiguration' => [ 'description' => '保存Cname配置的容器。', 'type' => 'object', 'properties' => [ 'Cname' => [ 'description' => '保存要生成Token的Cname域名。', 'type' => 'object', 'properties' => [ 'Domain' => [ 'description' => '目标Cname域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存CnameToken的相应。', 'type' => 'object', 'properties' => [ 'CnameToken' => [ 'description' => '保存CnameToken的容器。', '$ref' => '#/components/schemas/CnameToken', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '创建CnameToken', ], 'PutStyle' => [ 'summary' => '新增图片样式。一个图片样式中可以包含单个或多个图片处理参数。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket'."\n", ], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => [ 'description' => '图片样式名称。', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', ], ], [ 'name' => 'category', 'in' => 'query', 'schema' => [ 'description' => '样式分类。'."\n" ."\n" .'取值：image、document、video。', 'type' => 'string', 'required' => false, 'example' => 'image', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存图片样式信息的请求体。', 'type' => 'object', 'properties' => [ 'Style' => [ 'description' => '保存图片样式信息列表的容器。', 'required' => false, '$ref' => '#/components/schemas/Style', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '新增图片样式', ], 'ListStyle' => [ 'summary' => '查询某个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' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存图片样式信息的响应体。', 'type' => 'object', 'properties' => [ 'StyleList' => [ 'description' => '保存图片样式信息列表的容器。', 'type' => 'object', 'properties' => [ 'Style' => [ 'description' => '保存图片样式信息的列表。', 'type' => 'array', 'items' => [ 'description' => '图片样式信息。', '$ref' => '#/components/schemas/StyleInfo', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n","type":"xml"}]', 'title' => '查询图片样式', ], 'GetStyle' => [ 'summary' => '查询某个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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => [ 'description' => '图片样式名称。', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '保存已获取图片样式内容的响应体。', 'type' => 'object', 'properties' => [ 'Style' => [ 'description' => '保存已获取样式内容的容器。', '$ref' => '#/components/schemas/StyleInfo', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '获取图片样式', ], 'DeleteStyle' => [ 'summary' => '删除某个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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'styleName', 'in' => 'query', 'schema' => [ 'description' => '图片样式名称。', 'type' => 'string', 'required' => true, 'example' => 'imagestyle', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除图片样式', ], 'GetBucketHttpsConfig' => [ 'summary' => '调用GetBucketHttpsConfig接口查看Bucket的TLS版本设置。', 'path' => '/?httpsConfig', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存HTTPS配置的响应。', 'type' => 'object', 'properties' => [ 'HttpsConfiguration' => [ 'description' => '保存HTTPS配置的容器。', '$ref' => '#/components/schemas/HttpsConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n true\\n TLSv1.2\\n \\n \\n true\\n false\\n ECDHE-ECDSA-AES128-SHA256\\n ECDHE-ECDSA-AES256-CCM8\\n \\n","type":"xml"}]', 'title' => '获取存储空间HTTPS配置', 'description' => '- 要查看Bucket的TLS版本设置，您必须有oss:GetBucketHttpsConfig权限。具体操作，请参见[为RAM用户授权自定义的权限策略](https://help.aliyun.com/zh/oss/user-guide/common-examples-of-ram-policies#section-ucu-jv0-zip)。'."\n" ."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](https://help.aliyun.com/zh/oss/user-guide/regions-and-endpoints)。', ], 'PutBucketHttpsConfig' => [ 'summary' => '调用PutBucketHttpsConfig接口为Bucket开启或关闭TLS版本设置。', 'path' => '/?httpsConfig', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存HTTPS配置的请求体。', 'type' => 'object', 'properties' => [ 'HttpsConfiguration' => [ 'description' => '保存HTTPS配置的容器。', 'required' => false, '$ref' => '#/components/schemas/HttpsConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间HTTPS配置', ], 'CreateAccessPointForObjectProcess' => [ 'summary' => '创建对象FC接入点。', 'path' => '/?accessPointForObjectProcess', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '207844', 'abilityTreeNodes' => [ 'FEATUREoss3VNG8Q', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '要创建对象FC接入点的Bucket。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。接入点命名规范说明如下：'."\n" .'- 命名长度不能超过63个字符'."\n" .'- 只允许包含小写字母、数字、短划线（-），且不能以短划线开头或结尾。'."\n" .'- 名称在当前地域必须唯一。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ 'CreateAccessPointForObjectProcessConfiguration' => [ 'description' => '保存对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointName' => [ 'description' => 'OSS接入点名称。更多信息，请参见[创建接入点](~~2365063~~)。', 'type' => 'string', 'required' => false, 'example' => 'ap-01', ], 'ObjectProcessConfiguration' => [ 'description' => '保存对象处理信息的容器。', 'required' => false, '$ref' => '#/components/schemas/ObjectProcessConfiguration', ], 'AllowAnonymousAccessForObjectProcess' => [ 'description' => '是否允许匿名访问。'."\n" ."\n" .'> 开启该选项之后将会允许匿名账号通过ObjectFC接入点访问您的Bucket，会产生相关费用。', 'type' => 'string', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'CreateAccessPointForObjectProcessResult' => [ 'description' => '保存对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointForObjectProcessArn' => [ 'description' => '对象FC接入点ARN。', 'type' => 'string', 'example' => 'acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01', ], 'AccessPointForObjectProcessAlias' => [ 'description' => '对象FC接入点别名。', 'type' => 'string', 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01\\n fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias\\n","type":"xml"}]', 'title' => '创建对象FC接入点', 'description' => '- 阿里云账号默认拥有创建对象FC接入点的权限。如果您希望通过RAM用户或者STS的方式创建对象FC接入点，您必须拥有`oss:CreateAccessPointForObjectProcess`权限。'."\n" .'- 单个阿里云账号支持创建1000个对象FC接入点。'."\n" .'- 单个Bucket支持创建100个对象FC接入点。', ], 'GetAccessPointForObjectProcess' => [ 'summary' => '获取对象FC接入点基础信息。', 'path' => '/?accessPointForObjectProcess', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207845', 'abilityTreeNodes' => [ 'FEATUREoss3VNG8Q', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'GetAccessPointForObjectProcessResult' => [ 'description' => '保存对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointNameForObjectProcess' => [ 'description' => '对象FC接入点名称。', 'type' => 'string', 'example' => 'fc-ap-01', ], 'AccessPointForObjectProcessAlias' => [ 'description' => '对象FC接入点别名。', 'type' => 'string', 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', ], 'AccessPointName' => [ 'description' => '接入点名称。', 'type' => 'string', 'example' => 'ap-01', ], 'AccountId' => [ 'description' => '配置对象FC接入点的阿里云账号UID。', 'type' => 'string', 'example' => '111933544165****', ], 'AccessPointForObjectProcessArn' => [ 'description' => '对象FC接入点ARN。', 'type' => 'string', 'example' => 'acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01', ], 'CreationDate' => [ 'description' => '对象FC接入点创建时间，格式为时间戳。', 'type' => 'string', 'example' => '1626769503', ], 'Status' => [ 'description' => '对象FC接入点所处状态。返回值如下：'."\n" .'- enable：对象FC接入点已创建完成。'."\n" .'- disable：对象FC接入点已禁用。'."\n" .'- creating：对象FC接入点正在创建中。'."\n" .'- deleting：对象FC接入点已删除。', 'type' => 'string', 'example' => 'enable', ], 'Endpoints' => [ 'description' => '保存对象FC接入点访问域名信息的容器。', 'type' => 'object', 'properties' => [ 'PublicEndpoint' => [ 'description' => '对象FC接入点的外网Endpoint。', 'type' => 'string', 'example' => 'fc-ap-01-111933544165****.oss-cn-qingdao.oss-object-process.aliyuncs.com', ], 'InternalEndpoint' => [ 'description' => '对象FC接入点的内网Endpoint。', 'type' => 'string', 'example' => 'fc-ap-01-111933544165****.oss-cn-qingdao-internal.oss-object-process.aliyuncs.com', ], ], ], 'AllowAnonymousAccessForObjectProcess' => [ 'description' => '是否允许匿名访问。'."\n" ."\n" .'> 开启该选项之后将会允许匿名账号通过ObjectFC接入点访问您的Bucket，会产生相关费用。', 'type' => 'string', 'example' => 'false', ], 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问信息的容器。', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n fc-ap-01\\n fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias\\n ap-01\\n 111933544165****\\n acs:oss:cn-qingdao:119335441657143:accesspointforobjectprocess/fc-ap-01\\n 1626769503\\n enable\\n \\n fc-ap-01-111933544165****.oss-cn-qingdao.oss-object-process.aliyuncs.com\\n fc-ap-01-111933544165****.oss-cn-qingdao-internal.oss-object-process.aliyuncs.com\\n \\n false\\n \\n true\\n \\n","type":"xml"}]', 'title' => '获取对象FC接入点详情', 'description' => '阿里云账号默认拥有获取对象FC接入点基础信息的权限。如果您希望通过RAM用户或者STS的方式获取对象FC接入点基础信息，您必须拥有`oss:GetAccessPointForObjectProcess`权限。', ], 'ListAccessPointsForObjectProcess' => [ 'summary' => '获取用户级别的对象FC接入点信息。', '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' => '指定返回对象FC接入点的最大数量。'."\n" ."\n" .'取值：大于0小于等于1000。'."\n" ."\n" .'> 如果因为max-keys的设置无法一次完成列举，返回结果会附加一个``作为下一次列举的continuation-token。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'continuation-token', 'in' => 'query', 'schema' => [ 'description' => '指定List操作需要从此token开始。您可以从返回结果中的NextContinuationToken获取此token。', 'type' => 'string', 'required' => false, 'example' => 'abc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'ListAccessPointsForObjectProcessResult' => [ 'description' => '保存本次列举对象FC接入点信息结果的容器。', 'type' => 'object', 'properties' => [ 'IsTruncated' => [ 'description' => '请求中返回的结果是否被截断。返回值如下：'."\n" ."\n" .'- true：表示本次未返回全部结果。'."\n" .'- false：表示本次已返回全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'NextContinuationToken' => [ 'description' => '表明本次ListAccessPointsForObjectProcess请求包含后续结果，需要将NextContinuationToken指定为continuation-token继续获取结果。', 'type' => 'string', 'example' => 'abc', ], 'AccountId' => [ 'description' => '对象FC接入点所属的阿里云账号UID。', 'type' => 'string', 'example' => '111933544165****', ], 'AccessPointsForObjectProcess' => [ 'description' => '保存所有对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointForObjectProcess' => [ 'description' => '保存单个对象FC接入点信息的容器。', 'type' => 'array', 'items' => [ 'description' => '保存单个对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'AccessPointNameForObjectProcess' => [ 'description' => '对象FC接入点名称。', 'type' => 'string', 'example' => 'fc-ap-01', ], 'AccessPointForObjectProcessAlias' => [ 'description' => '对象FC接入点别名。', 'type' => 'string', 'example' => 'fc-ap-01-3b00521f653d2b3223680ec39dbbe2****-opapalias', ], 'AccessPointName' => [ 'description' => '接入点名称。', 'type' => 'string', 'example' => 'fc-01', ], 'Status' => [ 'description' => '对象FC接入点所处状态。返回值如下：'."\n" ."\n" .'- enable：对象FC接入点已创建完成。'."\n" .'- disable：对象FC接入点已禁用。'."\n" .'- creating：对象FC接入点正在创建中。'."\n" .'- deleting：对象FC接入点已删除。', 'type' => 'string', 'example' => 'enable', ], 'AllowAnonymousAccessForObjectProcess' => [ 'description' => '是否允许匿名访问。'."\n" ."\n" .'> 开启该选项之后将会允许匿名账号通过ObjectFC接入点访问您的Bucket，会产生相关费用。', 'type' => 'string', 'example' => 'false', ], ], ], ], ], ], ], ], ], ], ], ], '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' => '列举对象FC接入点', 'description' => '阿里云账号默认拥有获取对象FC接入点信息的权限。如果您希望通过RAM用户或者STS的方式获取对象FC接入点信息，您必须拥有`oss:ListAccessPointsForObjectProcess`权限。', ], 'DeleteAccessPointForObjectProcess' => [ 'summary' => '删除对象FC接入点。', 'path' => '/?accessPointForObjectProcess', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '要删除对象FC接入点的Bucket。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除对象FC接入点', 'description' => '阿里云账号默认拥有删除对象FC接入点的权限。如果您希望通过RAM用户或者STS的方式删除对象FC接入点，您必须拥有`oss:DeleteAccessPointForObjectProcess`权限。', ], 'GetAccessPointConfigForObjectProcess' => [ 'summary' => '获取对象FC接入点配置信息。', 'path' => '/?accessPointConfigForObjectProcess', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207952', 'abilityTreeNodes' => [ 'FEATUREoss3VNG8Q', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回响应。', 'type' => 'object', 'properties' => [ 'GetAccessPointConfigForObjectProcessResult' => [ 'description' => '保存对象FC接入点配置信息的容器。', 'type' => 'object', 'properties' => [ 'ObjectProcessConfiguration' => [ 'description' => '保存对象处理信息的容器。', '$ref' => '#/components/schemas/ObjectProcessConfiguration', ], 'AllowAnonymousAccessForObjectProcess' => [ 'description' => '是否允许匿名访问。', 'type' => 'string', 'example' => 'false', ], 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问信息的容器。', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n GetObject-Range\\n \\n \\n \\n \\n OSS API操作，目前仅支持GetObject\\n \\n \\n \\n acs:ram::111933544165****:role/aliyunfcdefaultrole\\n acs:fc:cn-qingdao:111933544165****:services/test-oss-fc.LATEST/functions/fc-01\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n false\\n \\n true\\n \\n","type":"xml"}]', 'title' => '获取对象FC接入点配置', 'description' => '阿里云账号默认拥有获取对象FC接入点配置信息的权限。如果您希望通过RAM用户或者STS的方式获取对象FC接入点配置信息，您必须拥有`oss:GetAccessPointConfigForObjectProcess`权限。', ], 'PutAccessPointConfigForObjectProcess' => [ 'summary' => '修改对象FC接入点的配置。', 'path' => '/?accessPointConfigForObjectProcess', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '207951', 'abilityTreeNodes' => [ 'FEATUREoss3VNG8Q', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。接入点命名规范说明如下：'."\n" ."\n" .'- 命名长度不能超过63个字符。'."\n" .'- 只允许包含小写字母、数字、短划线（-），且不能以短划线开头或结尾。'."\n" .'- 名称在当前地域必须唯一。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ 'PutAccessPointConfigForObjectProcessConfiguration' => [ 'description' => '保存对象FC接入点信息的容器。', 'type' => 'object', 'properties' => [ 'ObjectProcessConfiguration' => [ 'description' => '保存对象处理信息的容器。', 'required' => false, '$ref' => '#/components/schemas/ObjectProcessConfiguration', ], 'AllowAnonymousAccessForObjectProcess' => [ 'description' => '是否允许匿名访问。'."\n" ."\n" .'> 开启该选项之后将会允许匿名账号通过ObjectFC接入点访问您的Bucket，会产生相关费用。', 'type' => 'string', 'required' => false, 'example' => 'false', ], 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问信息的容器。', 'required' => false, '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改对象FC接入点配置', 'description' => '阿里云账号默认拥有修改对象FC接入点配置的权限。如果您希望通过RAM用户或者STS的方式修改对象FC接入点配置，您必须拥有`oss:PutAccessPointConfigForObjectProcess`权限。', ], 'PutAccessPointPolicyForObjectProcess' => [ 'summary' => '为对象FC接入点配置权限策略。', 'path' => '/?accessPointPolicyForObjectProcess', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => ' '."\n" .'fc-ap-01', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '接口请求体。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "Version": "1",'."\n" .' "Statement": [{'."\n" .' "Effect": "Allow",'."\n" .' "Action": ['."\n" .' "oss:GetObject"'."\n" .' ],'."\n" .' "Principal": ['."\n" .' "237210000000000xxxx"'."\n" .' ],'."\n" .' "Resource": ['."\n" .' "acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*"'."\n" .' ]'."\n" .' }]'."\n" .' }', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改对象FC接入点授权策略', 'description' => '阿里云账号默认拥有为对象FC接入点配置权限策略的权限。如果您希望通过RAM用户或者STS的方式为对象FC接入点配置权限策略，您必须拥有`oss:PutAccessPointPolicyForObjectProcess`权限。', ], 'GetAccessPointPolicyForObjectProcess' => [ 'summary' => '获取对象FC接入点的权限策略配置。', 'path' => '/?accessPointPolicyForObjectProcess', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/octet-stream', ], 'produces' => [ 'application/json', 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '对象FC接入点权限策略配置。', 'type' => 'string', 'example' => '{'."\n" .' "Version": "1",'."\n" .' "Statement": [{'."\n" .' "Effect": "Allow",'."\n" .' "Action": ['."\n" .' "oss:GetObject"'."\n" .' ],'."\n" .' "Principal": ['."\n" .' "237210000000000xxxx"'."\n" .' ],'."\n" .' "Resource": ['."\n" .' "acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*"'."\n" .' ]'."\n" .' }]'."\n" .' }', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n{\\n\\t \\"Version\\": \\"1\\",\\n\\t \\"Statement\\": [{\\n\\t\\t \\"Effect\\": \\"Allow\\",\\n\\t\\t \\"Action\\": [\\n\\t\\t\\t \\"oss:GetObject\\"\\n\\t\\t ],\\n\\t\\t \\"Principal\\": [\\n\\t\\t\\t \\"237210000000000xxxx\\"\\n\\t\\t ],\\n\\t\\t \\"Resource\\": [\\n\\t\\t\\t \\"acs:oss:cn-qingdao:1030700000xxxx:accesspointforobjectprocess/fc-test/object/*\\"\\n\\t\\t ]\\n\\t }]\\n }","type":"xml"}]', 'title' => '获取对象FC接入点策略', 'description' => '阿里云账号默认拥有获取对象FC接入点权限策略配置的权限。如果您希望通过RAM用户或者STS的方式获取对象FC接入点的权限策略配置，您必须拥有`oss:GetAccessPointPolicyForObjectProcess`权限。', ], 'DeleteAccessPointPolicyForObjectProcess' => [ 'summary' => '删除对象FC接入点的权限策略。', 'path' => '/?accessPointPolicyForObjectProcess', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/octet-stream', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '要删除对象FC接入点策略的Bucket。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'x-oss-access-point-for-object-process-name', 'in' => 'header', 'schema' => [ 'description' => '填写对象FC接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'fc-ap-01', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除对象FC接入点策略', 'description' => '阿里云账号默认拥有删除对象FC接入点策略的权限策略。如果您希望通过RAM用户或者STS的方式删除对象FC接入点的权限策略，您必须拥有`oss:DeleteAccessPointPolicyForObjectProcess`权限。', ], 'GetPublicAccessBlock' => [ 'summary' => '获取绑定在用户级别的阻止公共访问的配置。', 'path' => '/?publicAccessBlock', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207983', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'description' => '接口响应信息。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问信息的容器。', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取用户级别阻止公共访问配置', ], 'PutPublicAccessBlock' => [ 'summary' => '修改OSS全局阻止公共访问的配置信息。', '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' => '接口请求体。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改用户级别阻止公共访问配置', ], 'DeletePublicAccessBlock' => [ 'summary' => '删除用户级别的阻止公共访问配置。', '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' => '删除用户级别的阻止公共访问配置', ], 'GetBucketPublicAccessBlock' => [ 'summary' => '获取存储空间绑定的阻止公共访问配置。', 'path' => '/?publicAccessBlock', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207988', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '接口响应体。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问配置信息的容器。', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取存储空间阻止公共访问配置', ], 'PutBucketPublicAccessBlock' => [ 'summary' => '获取绑定在存储空间上的阻止公共访问的配置信息。', 'path' => '/?publicAccessBlock', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '207985', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'exmaplebucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '接口请求体参数。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '开启/关闭存储空间阻止公共访问配置', ], 'DeleteBucketPublicAccessBlock' => [ 'summary' => '删除绑定在存储空间上的组织公共访问配置信息。', 'path' => '/?publicAccessBlock', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间阻止公共访问配置', ], 'GetAccessPointPublicAccessBlock' => [ 'summary' => '获取指定接入点的阻止公共访问配置信息。', 'path' => '/?publicAccessBlock', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '207994', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'query', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => false, 'example' => 'ap-01', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '接口响应体。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问配置信息的容器。', '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取接入点阻止公共访问配置', ], 'PutAccessPointPublicAccessBlock' => [ 'summary' => '修改指定接入点的阻止公共访问的配置信息。', 'path' => '/?publicAccessBlock', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '207993', 'abilityTreeNodes' => [ 'FEATUREoss4PB2DT', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'query', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => true, 'example' => 'ap-01', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '接口请求体。', 'type' => 'object', 'properties' => [ 'PublicAccessBlockConfiguration' => [ 'description' => '保存阻止公共访问配置信息的容器。', 'required' => false, '$ref' => '#/components/schemas/PublicAccessBlockConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改接入点阻止公共访问配置', ], 'DeleteAccessPointPublicAccessBlock' => [ 'summary' => '删除指定接入点的阻止公共访问配置信息。', 'path' => '/?publicAccessBlock', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'Bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'examplebucket', ], ], [ 'name' => 'x-oss-access-point-name', 'in' => 'query', 'schema' => [ 'description' => '接入点名称。', 'type' => 'string', 'required' => false, 'example' => 'ap-01', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除接入点阻止公共访问配置', ], 'GetBucketArchiveDirectRead' => [ 'summary' => '查看Bucket是否开启归档直读。', 'path' => '/?bucketArchiveDirectRead', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Bucket归档直读配置。', 'type' => 'object', 'properties' => [ 'ArchiveDirectReadConfiguration' => [ 'description' => 'Bucket归档直读配置。', '$ref' => '#/components/schemas/ArchiveDirectReadConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n true\\n","type":"xml"}]', 'title' => '获取存储空间归档直读配置', 'description' => '- 要查看Bucket是否开启归档直读，您必须有`oss:GetBucketArchiveDirectRead`权限。具体操作，请参见[为RAM用户授权自定义的权限策略](~~199058~~)。'."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。', ], 'PutBucketArchiveDirectRead' => [ 'summary' => '为Bucket开启或关闭归档直读。', 'path' => '/?bucketArchiveDirectRead', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => 'A short description of struct', 'description' => '存储空间名称。', 'type' => 'string', 'required' => true, 'example' => 'example-bucket'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '接口请求体。', 'type' => 'object', 'properties' => [ 'ArchiveDirectReadConfiguration' => [ 'description' => 'Bucket归档直读配置。', 'required' => false, '$ref' => '#/components/schemas/ArchiveDirectReadConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间归档直读配置', 'description' => '- 要为Bucket开启归档直读，您必须有`oss:PutBucketArchiveDirectRead`权限。具体操作，请参见[为RAM用户授权自定义的权限策略](~~199058~~)。'."\n" ."\n" .'- 每个地域都有对应的访问域名（Endpoint）。关于地域与访问域名对应关系的更多信息，请参见[访问域名和数据中心](~~31837~~)。'."\n" ."\n" .'- 开启归档直读后，直接读取归档存储类型的文件，会产生归档直读数据取回容量（RetrievalDataArchiveDirect）费用。对于已经解冻的归档存储类型的文件，不会产生归档直读数据取回容量费用。详情请参见[数据处理费用](~~173537~~)。', ], 'PutBucketOverwriteConfig' => [ 'summary' => '设置存储空间的禁止覆盖写规则。', 'path' => '/?overwriteConfig', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '287827', 'abilityTreeNodes' => [ 'FEATUREossJ033DA', 'FEATUREossDK8IBS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体结构', 'description' => '接口请求体结构', 'type' => 'object', 'properties' => [ 'OverwriteConfiguration' => [ 'title' => '保存存储空间覆盖写配置规则的容器', 'description' => '保存存储空间覆盖写配置规则的容器', 'required' => false, '$ref' => '#/components/schemas/OverwriteConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间禁止覆盖写规则', ], 'GetBucketOverwriteConfig' => [ 'summary' => '获取存储空间的禁止覆盖写规则配置。', 'path' => '/?overwriteConfig', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '287828', 'abilityTreeNodes' => [ 'FEATUREossJ033DA', 'FEATUREossDK8IBS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应体结构', 'description' => '接口响应体结构', 'type' => 'object', 'properties' => [ 'OverwriteConfiguration' => [ 'title' => '保存存储空间覆盖写规则的容器', 'description' => '保存存储空间覆盖写规则的容器', '$ref' => '#/components/schemas/OverwriteConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n forbid-write-rule1\\n forbid\\n a/\\n .txt\\n \\n 27737962156157xxxx\\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间禁止覆盖写规则', ], 'DeleteBucketOverwriteConfig' => [ 'summary' => '删除存储空间的不覆盖写规则配置。', 'path' => '/?overwriteConfig', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '287829', 'abilityTreeNodes' => [ 'FEATUREossJ033DA', 'FEATUREossDK8IBS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的不覆盖写规则', ], 'PutObject' => [ 'summary' => '上传文件（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => [ 'description' => '指定PutObject操作时是否覆盖同名Object。 当目标Bucket处于已开启或已暂停的版本控制状态时，**x-oss-forbid-overwrite**请求Header设置无效，即允许覆盖同名Object。'."\n" .' - 不指定**x-oss-forbid-overwrite**或者指定**x-oss-forbid-overwrite**为**false**时，表示允许覆盖同名Object。'."\n" .' - 指定**x-oss-forbid-overwrite**为**true**时，表示禁止覆盖同名Object。'."\n" ."\n" .'设置**x-oss-forbid-overwrite**请求Header会导致QPS处理性能下降，如果您有大量的操作需要使用**x-oss-forbid-overwrite**请求Header（QPS>1000），请联系技术支持，避免影响您的业务。'."\n" .'默认值：**false**', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => [ 'description' => '创建Object时，指定服务器端加密方式。'."\n" ."\n" .'取值：**AES256**、**KMS****或**SM4****'."\n" ."\n" .'指定此选项后，在响应头中会返回此选项，OSS会对上传的Object进行加密编码存储。当下载该Object时，响应头中会包含**x-oss-server-side-encryption**，且该值会被设置成此Object的加密算法。', 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => [ 'description' => '创建Object时，指定服务器端加密方式。'."\n" ."\n" .'取值：**AES256**、**KMS**或**SM4**'."\n" ."\n" .'指定此选项后，在响应头中会返回此选项，OSS会对上传的Object进行加密编码存储。当下载该Object时，响应头中会包含**x-oss-server-side-encryption**，且该值会被设置成此Object的加密算法。', 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => [ 'description' => 'KMS托管的用户主密钥。'."\n" .'此选项仅在**x-oss-server-side-encryption**为KMS时有效。', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => [ 'description' => '指定OSS创建Object时的访问权限。'."\n" ."\n" .'取值：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见**[读写权限ACL](~~100676~~)**。', 'required' => false, '$ref' => '#/components/schemas/ObjectACL', ], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => [ 'description' => '指定Object的存储类型。 对于任意存储类型的Bucket，如果上传Object时指定此参数，则此次上传的Object将存储为指定的类型。例如在IA类型的Bucket中上传Object时，如果指定x-oss-storage-class为Standard，则该Object直接存储为Standard。 取值： Standard：标准存储 IA：低频访问 Archive：归档存储 ColdArchive：冷归档存储 关于存储类型的更多信息，请参见存储类型介绍。', 'required' => false, '$ref' => '#/components/schemas/StorageClass', ], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => [ 'description' => '指定Object的标签，可同时设置多个标签，例如TagA=A&TagB=B。'."\n" .'> Key和Value需要先进行URL编码，如果某项没有”=“，则看作Value为空字符串。', 'type' => 'string', 'required' => false, 'example' => 'a:1', ], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => '使用PutObject接口时，如果配置以**x-oss-meta-***为前缀的参数，则该参数视为元数据，例如`x-oss-meta-location`。一个Object可以有多个类似的参数，但所有的元数据总大小不能超过8 KB。'."\n" ."\n" .'元数据支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '使用PutObject接口时，如果配置以**x-oss-meta-***为前缀的参数，则该参数视为元数据，例如`x-oss-meta-location`。一个Object可以有多个类似的参数，但所有的元数据总大小不能超过8 KB。'."\n" ."\n" .'元数据支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', 'example' => 'x-oss-meta-location', ], 'example' => 'x-oss-meta-location', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', ], ], ], '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' => '上传文件', 'description' => '**注意事项**'."\n" ."\n" .'- 添加的Object大小不能超过5 GB。'."\n" ."\n" .'- 默认情况下，如果已存在同名Object且对该Object有访问权限，则新添加的Object将覆盖原有的Object，并返回200 OK。'."\n" ."\n" .'- OSS没有文件夹的概念，所有资源都是以文件来存储，但您可以通过创建一个以正斜线（/）结尾，大小为0的Object来创建模拟文件夹。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'- 在已开启版本控制的Bucket中，OSS会为新添加的Object自动生成唯一的版本ID，并在响应Header中通过x-oss-version-id形式返回。'."\n" .'- 在暂停了版本控制的Bucket中，新添加的Object的版本ID为null。OSS会保证同一个Object仅有一个null的版本ID。', ], 'CopyObject' => [ 'summary' => '拷贝同一地域下相同或不同存储空间（Bucket）之间的文件（Object）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'oss-example', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'x-oss-copy-source', 'in' => 'header', 'schema' => [ 'description' => '指定拷贝的源地址。'."\n" .'默认值：无', 'type' => 'string', 'required' => true, 'example' => '/oss-example/oss.jpg', ], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => [ 'description' => '指定CopyObject操作时是否覆盖同名目标Object。当目标Bucket处于已开启或已暂停版本控制状态时，**x-oss-forbid-overwrite**请求Header设置无效，即允许覆盖同名Object。'."\n" .' - 未指定**x-oss-forbid-overwrite**或者指定**x-oss-forbid-overwrite**为**false**时，表示允许覆盖同名目标Object。'."\n" .' - 指定**x-oss-forbid-overwrite**为**true**时，表示禁止覆盖同名Object。'."\n" ."\n" .'设置**x-oss-forbid-overwrite**请求Header会导致QPS处理性能下降，如果您有大量的操作需要使用x-**x-oss-forbid-overwrite**请求Header（QPS>1000），请联系技术支持，避免影响您的业务。'."\n" .'默认值：false', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'x-oss-copy-source-if-match', 'in' => 'header', 'schema' => [ 'description' => '如果源Object的ETag值和您提供的ETag相等，则执行拷贝操作，并返回200 OK。'."\n" .'默认值：无'."\n", 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', ], ], [ 'name' => 'x-oss-copy-source-if-none-match', 'in' => 'header', 'schema' => [ 'description' => '如果源Object的ETag值和您提供的ETag不相等，则执行拷贝操作，并返回200 OK。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', ], ], [ 'name' => 'x-oss-copy-source-if-unmodified-since', 'in' => 'header', 'schema' => [ 'description' => '如果指定的时间等于或者晚于文件实际修改时间，则正常拷贝文件，并返回200 OK。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '2019-04-09T07:01:56.000Z', ], ], [ 'name' => 'x-oss-copy-source-if-modified-since', 'in' => 'header', 'schema' => [ 'description' => '如果源Object在用户指定的时间以后被修改过，则执行拷贝操作。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '2019-04-09T07:01:56.000Z', ], ], [ 'name' => 'x-oss-metadata-directive', 'in' => 'header', 'schema' => [ 'description' => '指定如何设置目标Object的元信息。'."\n" .' - **COPY**（默认值）：复制源Object的元数据到目标Object。'."\n" .'OSS不会复制源Object的**x-oss-server-side-encryption**属性配置到目标Object。目标Object的服务器端加密编码方式取决于当前拷贝操作是否指定了**x-oss-server-side-encryption**。'."\n" .' - **REPLACE**：忽略源Object的元数据，直接采用请求中指定的元数据。'."\n" ."\n" .'> 如果拷贝操作的源Object地址和目标Object地址相同，且未开启版本控制时，则无论x-oss-metadata-directive为何值，都会忽略源Object的元数据，目标Object将直接采用请求中指定的元数据。', 'type' => 'string', 'required' => false, 'example' => 'COPY', ], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => [ 'description' => '指定OSS创建目标Object时，服务器端熵编码加密算法 。'."\n" .'取值：**AES256**、**KMS**'."\n" .'您只有购买了KMS套件，才能使用KMS加密算法，否则OSS会返回KmsServiceNotEnabled错误。'."\n" .' - 如果拷贝操作中未指定**x-oss-server-side-encryption**，则无论源Object是否进行过服务器端加密编码，拷贝后的目标Object均不进行服务器端加密编码。'."\n" .' - 如果拷贝操作中指定了**x-oss-server-side-encryption**，则无论源Object是否进行过服务器端加密编码，拷贝后的目标Object均会进行服务器端加密编码。并且拷贝操作的响应头中会包含**x-oss-server-side-encryption**，值为目标Object的加密算法。'."\n" .'在目标Object被下载时，响应头中也会包含**x-oss-server-side-encryption**，值为该Object的加密算法。', 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => [ 'description' => '指定Object的加密算法。如果未指定此选项，表明Object使用AES256加密算法。此选项仅当x-oss-server-side-encryption为KMS时有效。', 'type' => 'string', 'required' => false, 'example' => 'SM4', ], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => [ 'description' => '表示KMS托管的用户主密钥。'."\n" .'该参数仅在**x-oss-server-side-encryption**为KMS时有效。', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => [ 'description' => '指定OSS创建目标Object时的访问权限。'."\n" ."\n" .'取值：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见**[读写权限ACL](~~100676~~)**。', 'required' => false, '$ref' => '#/components/schemas/ObjectACL', ], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => [ 'description' => '指定Object的存储类型。'."\n" .'对于任意存储类型Bucket，如果上传Object时指定该值，则此次上传的Object将存储为指定的类型。例如在IA类型的Bucket中上传Object时，如果指定**x-oss-storage-class**为Standard，则该Object直接存储为Standard类型。'."\n" ."\n" .'取值：'."\n" .'- Standard：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'- ColdArchive：冷归档存储'."\n" ."\n" .'关于存储类型的更多信息，请参见**[存储类型介绍](~~51374~~)**。', 'required' => false, '$ref' => '#/components/schemas/StorageClass', ], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => [ 'description' => '指定Object的对象标签，可同时设置多个标签，例如TagA=A&TagB=B。'."\n" .'> Key和Value需要先进行URL编码，如果某项没有“=”，则看作Value为空字符串。', 'type' => 'string', 'required' => false, 'example' => 'a:1', ], ], [ 'name' => 'x-oss-tagging-directive', 'in' => 'header', 'schema' => [ 'description' => '指定如何设置目标Object的对象标签。取值如下：'."\n" .' - **Copy**（默认值）：复制源Object的对象标签到目标 Object。'."\n" .' - **Replace**：忽略源Object的对象标签，直接采用请求中指定的对象标签。', 'type' => 'string', 'required' => false, 'example' => 'Copy', ], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => '如果配置以x-oss-meta-*为前缀的参数，则该参数视为元数据。'."\n" .'元数据大小限制：一个Object可以包含多个元数据，但所有的元数据总大小不能超过8 KB。'."\n" .'元数据命名规则：支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '元数据命名规则：支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', 'example' => 'mx-oss-meta-owner', ], ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-copy-source-version-id' => [ 'schema' => [ 'type' => 'string', ], ], 'x-oss-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], 'schema' => [ 'description' => '保存CopyObject结果的响应体。', 'type' => 'object', 'properties' => [ 'CopyObjectResult' => [ 'description' => '保存CopyObject结果的容器。', 'type' => 'object', 'properties' => [ 'ETag' => [ 'description' => '目标Object的ETag值。', 'type' => 'string', 'example' => '5B3C1A2E053D763E1B002CC607C5****', ], 'LastModified' => [ 'description' => '目标Object最后更新时间。', 'type' => 'string', 'example' => 'Fri, 24 Feb 2012 07:18:48 GMT', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 5B3C1A2E053D763E1B002CC607C5****\\n Fri, 24 Feb 2012 07:18:48 GMT\\n","type":"xml"}]', 'title' => '拷贝文件', 'description' => '**版本控制**'."\n" ."\n" .'- `x-oss-copy-source`默认拷贝Object的当前版本，您可以在x-oss-copy-source中加入versionId来拷贝指定的Object版本。拷贝Object时，如果源Object的对应版本为删除标记，则返回404表示该Object不存在。'."\n" .'- 如果需要恢复Object的早期版本为当前版本，您只需将Object的早期版本拷贝到同一个Bucket中，OSS会将该Object对应早期版本置为当前版本。'."\n" .'- 如果目标Bucket已开启版本控制，OSS将会为新拷贝的Object自动生成唯一的版本ID，此版本ID将会在响应Header中的x-oss-version-id返回。如果目标Bucket未开启或者暂停了版本控制，OSS将会为新拷贝的Object自动生成version ID为null的版本，且会覆盖原有versionId为null的版本。'."\n" ."\n" .'**使用限制**'."\n" ."\n" .'- 使用CopyObject接口时，Object的大小限制说明如下：'."\n" ."\n" .' - 如果源Bucket和目标Bucket相同，则Object的大小无限制。'."\n" ."\n" .' - 如果源Bucket和目标Bucket不同，则建议拷贝小于1 GB的Object。当您需要拷贝大于1 GB的Object时，请使用[UploadPartCopy](~~31994~~)接口。'."\n" .' '."\n" .' 使用CopyObject或UploadPartCopy接口均要求对源Object有读权限。'."\n" ."\n" .'- 在非版本控制的Bucket中，当调用CopyObject接口拷贝文件时，如果源Object与目标Object为同一个Object，则OSS只修改源Object的元数据，不拷贝源Object的内容。'."\n" .'- 在版本控制的Bucket中，不支持拷贝通过追加上传方式生成的Object。'."\n" .'- 如果源Object为软链接，则只拷贝软链接，无法拷贝软链接指向的文件内容。'."\n" ."\n" .'**计量计费**'."\n" ."\n" .'- 调用一次CopyObject接口会对源Object和目标Object所在的Bucket各增加一次Get请求次数。'."\n" .'- 调用CopyObject接口会对目标Object所在的Bucket增加相应的存储量。'."\n" .'- 调用CopyObject接口更改Object存储类型会涉及数据覆盖。例如低频访问IA创建后10天内被覆盖为标准存储Standard，则会产生20天的低频访问不足规定时长容量费用。关于存储费用的更多信息，请参见**[存储费用](~~173534~~)**。', ], 'GetObject' => [ 'summary' => '获取某个文件（Object）。', 'path' => '/{key}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/octet-stream', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '9047', 'abilityTreeNodes' => [ 'FEATUREossM3J9J1', ], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'response-content-type', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的content-type头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'image/jpg', ], ], [ 'name' => 'response-content-language', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的content-language头。'."\n", 'type' => 'string', 'required' => false, 'example' => '中文', ], ], [ 'name' => 'response-expires', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的expires头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Fri, 24 Feb 2012 17:00:00 GMT', ], ], [ 'name' => 'response-cache-control', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的cache-control头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'no-cache', ], ], [ 'name' => 'response-content-disposition', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的content-disposition头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'attachment; filename:testing.txt', ], ], [ 'name' => 'response-content-encoding', 'in' => 'query', 'schema' => [ 'description' => '指定OSS返回请求的content-encoding头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'utf-8', ], ], [ 'name' => 'Range', 'in' => 'header', 'schema' => [ 'description' => '指定文件传输的范围。'."\n" .' - 如果指定的范围符合规范，返回消息中会包含整个Object的大小和此次返回Object的范围。例如：Content-Range: bytes 0~9/44，表示整个Object大小为44，此次返回的范围为0~9。'."\n" .' - 如果指定的范围不符合规范，则传送整个Object，并且结果中不包含Content-Range。'."\n" ."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Content-Range: bytes 100-900/344606', ], ], [ 'name' => 'If-Modified-Since', 'in' => 'header', 'schema' => [ 'description' => '如果指定的时间早于实际修改时间或指定的时间不符合规范，则直接返回Object，并返回200 OK；如果指定的时间等于或者晚于实际修改时间，则返回304 Not Modified。'."\n" .'时间格式：GMT，例如`Fri, 13 Nov 2015 14:47:53 GMT`'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', ], ], [ 'name' => 'If-Unmodified-Since', 'in' => 'header', 'schema' => [ 'description' => '如果指定的时间等于或者晚于Object实际修改时间，则正常传输Object，并返回200 OK；如果指定的时间早于实际修改时间，则返回412 Precondition'."\n" .' Failed。'."\n" .'时间格式：GMT，例如`Fri, 13 Nov 2015 14:47:53 GMT`'."\n" .'**If-Modified-Since**和**If-Unmodified-Since**可以同时使用。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', ], ], [ 'name' => 'If-Match', 'in' => 'header', 'schema' => [ 'description' => '如果传入的ETag和Object的ETag匹配，则正常传输Object，并返回200 OK；如果传入的ETag和Object的ETag不匹配，则返回412 Precondition Failed。'."\n" .'Object的ETag值用于验证数据是否发生了更改，您可以基于ETag值验证数据完整性。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'fba9dede5f27731c9771645a3986****', ], ], [ 'name' => 'If-None-Match', 'in' => 'header', 'schema' => [ 'description' => '如果传入的ETag值和Object的ETag不匹配，则正常传输Object，并返回200 OK；如果传入的ETag和Object的ETag匹配，则返回304 Not Modified。'."\n" .'**If-Match**和**If-None-Match**可以同时使用。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E0563E1B002CC607C****', ], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => [ 'description' => '指定客户端的编码类型。'."\n" .'如果要对返回内容进行Gzip压缩传输，您需要在请求头中以显示方式加入Accept-Encoding:gzip。OSS会根据Object的Content-Type和Object大小（不小于1'."\n" .' KB）判断是否返回经过Gzip压缩的数据。'."\n" .'> - 如果采用了Gzip压缩，则不会附带ETag信息。'."\n" .'> - 目前OSS支持Gzip压缩的Content-Type为text/cache-manifest、 text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、application/json和text/json。'."\n" ."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'gzip', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '目标文件的版本ID。', 'type' => 'string', 'required' => false, 'example' => 'CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-server-side-encryption' => [ 'schema' => [ 'sdkPropertyName' => 'serverSideEncryption', 'type' => 'string', ], ], 'x-oss-server-side-encryption-key-id' => [ 'schema' => [ 'sdkPropertyName' => 'sseKeyId', 'type' => 'string', ], ], 'x-oss-storage-class' => [ 'schema' => [ 'sdkPropertyName' => 'storageClass', 'type' => 'string', ], ], 'x-oss-object-type' => [ 'schema' => [ 'sdkPropertyName' => 'objectType', 'type' => 'string', ], ], 'x-oss-next-append-position' => [ 'schema' => [ 'sdkPropertyName' => 'nextAppendPosition', 'type' => 'integer', 'format' => 'int64', ], ], 'x-oss-hash-crc64ecma' => [ 'schema' => [ 'sdkPropertyName' => 'crc64ecma', 'type' => 'string', ], ], 'x-oss-expiration' => [ 'schema' => [ 'sdkPropertyName' => 'expiration', 'type' => 'string', ], ], 'x-oss-restore' => [ 'schema' => [ 'sdkPropertyName' => 'restore', 'type' => 'string', ], ], 'x-oss-process-status' => [ 'schema' => [ 'sdkPropertyName' => 'processStatus', 'type' => 'string', ], ], 'x-oss-request-charged' => [ 'schema' => [ 'sdkPropertyName' => 'requestCharged', 'type' => 'string', ], ], 'Content-Md5' => [ 'schema' => [ 'type' => 'string', ], ], 'Content-Length' => [ 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], 'Last-Modified' => [ 'schema' => [ 'type' => 'string', ], ], 'Content-Type' => [ 'schema' => [ 'type' => 'string', ], ], 'ETag' => [ 'schema' => [ 'type' => 'string', ], ], 'x-oss-meta-*' => [ 'style' => 'json', 'schema' => [ 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', ], 'parseType' => 'struct', ], ], 'x‑oss‑tagging‑count' => [ 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'schema' => [ 'description' => '对象关联的标签的个数。仅当有读取标签权限时返回。', 'type' => 'string', 'format' => 'binary', 'example' => '10', ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\"10\\"","type":"json"}]', 'title' => '获取文件', 'description' => '**注意事项**'."\n" ."\n" .'- GetObject接口默认可通过HTTP和HTTPS两种方式访问。如果要设置仅允许通过HTTPS方式访问，请使用Bucket Policy的授权访问方式。具体操作，请参见[通过Bucket Policy授权用户访问指定资源](~~85111~~)。'."\n" ."\n" .'- 如果Object类型为归档类型，需要先完成解冻文件（RestoreObject）请求，且该请求不能超时。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'默认情况下，调用GetObject接口仅返回Object的当前版本。'."\n" .'如果在查询参数中指定Object的versionId，则返回指定的Object版本。当versionId指定为null时，则返回versionId为null的Object版本。', ], 'AppendObject' => [ 'summary' => '以追加写的方式上传文件（Object）。', 'path' => '/{key}?append', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/octet-stream', ], 'produces' => [ 'application/xml', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'position', 'in' => 'query', 'schema' => [ 'description' => '用于指定从何处进行追加。 每次操作成功后，响应消息头x-oss-next-append-position会标明下一次追加的position。首次追加操作的position必须为0，后续追加操作的position是Object的当前大小。例如，第一次AppendObject请求指定position值为0，content-length是65536，则第二次AppendObject需要指定position为65536。'."\n" ."\n" .'- 当position值为0，且不存在同名Object时，则AppendObject与PutObject请求类似，即允许设置x-oss-server-side-encryption等请求头。如果加入了正确的x-oss-server-side-encryption头，那么后续的AppendObject响应头部也会包含x-oss-server-side-encryption头。后续如需更改元数据，可以使用CopyObject接口。'."\n" .'- 在position值正确的情况下，对已存在的Appendable Object追加一个大小为0的内容，该操作不会改变Object的状态。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', ], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => [ 'description' => '指定服务器端加密方式。'."\n" .'合法值：'."\n" ."\n" .'- AES256：使用OSS完全托管密钥进行加解密（SSE-OSS）。'."\n" .'- KMS：使用KMS托管密钥进行加解密。'."\n" .'- SM4：国密SM4算法。', 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => [ 'description' => '指定Object的访问权限。 取值范围如下：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见[读写权限ACL](~~100676~~)。', 'required' => false, '$ref' => '#/components/schemas/ObjectACL', ], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => [ 'description' => '指定Object的存储类型。取值范围如下：'."\n" ."\n" .'- Standard：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'对于任意存储类型的Bucket，如果上传Object时指定此参数，则此次上传的Object将存储为指定的类型。例如在IA类型的Bucket中上传Object时，如果指定x-oss-storage-class为Standard，则该Object直接存储为Standard。'."\n" .'关于存储类型的更多信息，请参见存储类型介绍。'."\n" ."\n" .'> 该值仅在首次执行AppendObject操作时有效，后续追加时不生效。', 'required' => false, '$ref' => '#/components/schemas/StorageClass', ], ], [ 'name' => 'x-oss-meta-*', 'in' => 'header', 'schema' => [ 'description' => '创建AppendObject时可以添加x-oss-meta-*，继续追加时不可以携带此参数。如果配置以x-oss-meta-*为前缀的参数，则该参数视为元数据。'."\n" .'元数据大小限制：一个Object可以包含多个元数据，但所有的元数据总大小不能超过8 KB。'."\n" .'元数据命名规则：支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => 'x-oss-meta-location', 'description' => '创建AppendObject时可以添加x-oss-meta-*，继续追加时不可以携带此参数。如果配置以x-oss-meta-*为前缀的参数，则该参数视为元数据。'."\n" .'元数据大小限制：一个Object可以包含多个元数据，但所有的元数据总大小不能超过8 KB。'."\n" .'元数据命名规则：支持短划线（-）、数字、英文字母（a~z）。英文字符的大写字母会被转成小写字母，不支持下划线（_）在内的其他字符。', ], 'example' => 'x-oss-meta-location', ], ], [ 'name' => 'Cache-Control', 'in' => 'header', 'schema' => [ 'description' => '指定该Object的网页缓存行为。更多信息，请参见**[RFC2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'no-cache', ], ], [ 'name' => 'Content-Disposition', 'in' => 'header', 'schema' => [ 'description' => '指定该Object被下载时的名称。更多信息，请参见**[RFC2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'attachment;filename=oss_download.jpg', ], ], [ 'name' => 'Content-Encoding', 'in' => 'header', 'schema' => [ 'description' => '指定该Object的内容编码格式。更多信息，请参见**[RFC2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'utf-8', ], ], [ 'name' => 'Content-MD5', 'in' => 'header', 'schema' => [ 'description' => '是一串由MD5算法生成的值，该请求头用于检查消息内容是否与发送时一致。'."\n" .'获取Content-MD5值：对消息内容（不包括头部）执行MD5算法，获得128比特位数字，然后对该数字进行base64编码。'."\n" .'默认值：无'."\n" .'限制：无', 'type' => 'string', 'required' => false, 'example' => 'ohhnqLBJFiKkPSBO1eNaUA==', ], ], [ 'name' => 'Expires', 'in' => 'header', 'schema' => [ 'description' => '过期时间。更多信息，请参见**[RFC2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Wed, 08 Jul 2015 16:57:01 GMT', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', ], ], ], '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' => '以追加写的方式上传文件', 'description' => '**版本控制**'."\n" ."\n" .'在目标Bucket处于开启或暂停版本控制状态下，对Appendable类型Object执行相关操作时，有如下注意事项：'."\n" .'- 仅允许对当前版本为Appendable类型的Object执行追加上传（AppendObject）操作，且OSS不会为该Appendable类型的Object生成历史版本。'."\n" .'- 对当前版本为Appendable类型的Object执行PutObject或DeleteObject操作时，OSS会将该Appendable类型的Object保留为历史版本，但该Object不允许继续追加。'."\n" .'- 不支持对Appendable类型Object执行拷贝操作。'."\n" .'- 不支持对非Appendable类型的Object，包括Normal Object、删除标记（Delete Marker）等执行AppendObject操作。'."\n" ."\n" .'**使用限制**'."\n" ."\n" .'- 通过AppendObject方式最后生成的Object大小不得超过5 GB。'."\n" .'- 处于[合规保留策略](~~90564~~)保护期的Object不支持AppendObject操作。'."\n" .'- AppendableObject不支持指定CMK ID进行服务端KMS加密。', ], 'SealAppendObject' => [ 'summary' => '通过AppendObject操作创建的Appendable Object，SealAppendable 操作用于Appendable Object停止继续写入。执行该操作后，允许用户通过配置生命周期来将对应的Appendable Object存储类型转为冷归档或深度冷归档存储类型。', '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' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'title' => 'Appendable Object的名称', 'description' => 'Appendable Object的名称', 'type' => 'string', 'required' => true, 'example' => 'test-appendable-object', ], ], [ 'name' => 'position', 'in' => 'query', 'schema' => [ 'title' => '指定执行SealAppendObject操作时Object的预期长度。OSS会检查此长度与Object的实际长度是否一致。如果不一致，请求将失败并返回PositionNotEqualToLength错误。', 'description' => '用于指定从用户期望Seal时该文件的长度。', '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' => '封存可追加对象', ], 'DeleteObject' => [ 'summary' => '删除文件（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' => 'Bucket信息。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => 'Object对应的版本ID。', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgIDh3ZCB0BYiIGE4YjIyMjExZDhhYjQxNzZiNGUyZTI4ZjljZDcz****', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-delete-marker' => [ 'schema' => [ 'type' => 'boolean', ], ], 'x-oss-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除文件', 'description' => '**注意事项**'."\n" ."\n" .'- 要删除文件，您必须有Object的写权限。'."\n" .'- 无论要删除的Object是否存在，删除成功后均会返回204状态码。'."\n" .'- 如果Object类型为软链接，使用DeleteObject接口只会删除该软链接。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'版本控制状态下的删除行为说明如下：'."\n" ."\n" .'- 未指定versionId（临时删除）：'."\n" .'如果在未指定versionId的情况下执行删除操作时，默认不会删除Object的当前版本，而是对当前版本插入删除标记（Delete Marker）。此时，在未指定versionId的情况下执行GetObject操作，OSS会检测到当前版本为删除标记，并返回`404 Not Found`。此外，响应中还会返回header：`x-oss-delete-marker = true`以及新生成的删除标记的版本号`x-oss-version-id`。'."\n" .'`x-oss-delete-marker`的值为true，表示与返回的`x-oss-version-id`对应的版本为删除标记。'."\n" ."\n" .'- 指定versionId（永久删除）：'."\n" .'如果在指定versionId的情况下执行删除操作时，OSS会根据`params`中指定的`versionId`参数永久删除该版本。如果要删除ID为“null”的版本，请在`params`参数中添加`params[\'versionId\'] = “null”`，OSS将“null”字符串当成“null”的versionId，从而删除versionId为“null”的Object。', ], 'HeadObject' => [ 'summary' => '获取某个文件（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '请求Object的版本号。', 'type' => 'string', 'required' => false, 'example' => 'CAEQMxiBgMCZov2D0BYiIDY4MDllOTc2YmY5MjQxMzdiOGI3OTlhNTU0ODIx****', ], ], [ 'name' => 'If-Modified-Since', 'in' => 'header', 'schema' => [ 'description' => '如果传入参数中的时间早于实际修改时间，则返回200 OK和Object Meta；否则返回304 not modified。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 9 Apr 2021 14:47:53 GMT', ], ], [ 'name' => 'If-Unmodified-Since', 'in' => 'header', 'schema' => [ 'description' => '如果传入参数中的时间等于或者晚于文件实际修改时间，则返回200 OK和Object Meta；否则返回412 precondition failed。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Oct 2021 14:47:53 GMT', ], ], [ 'name' => 'If-Match', 'in' => 'header', 'schema' => [ 'description' => '如果传入期望的ETag和Object的 ETag匹配，则返回200 OK和Object Meta；否则返回412 precondition failed。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'fba9dede5f27731c9771645a3986****', ], ], [ 'name' => 'If-None-Match', 'in' => 'header', 'schema' => [ 'description' => '如果传入期望的ETag值和Object的ETag不匹配，则返回200 OK和Object Meta；否则返回304 Not Modified。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E0563E1B002CC607C****', ], ], ], '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' => '获取文件的元信息', 'description' => '- 使用此接口不会返回文件内容。'."\n" ."\n" .'- HeadObject操作默认获取Object当前版本的元信息。如果Object的当前版本为删除标记，则返回404 Not Found。请求参数中指定versionId则返回指定版本Object的元信息。', ], 'GetObjectMeta' => [ 'summary' => '获取文件（Object）的元数据信息，包括该Object的ETag、Size、LastModified信息，并且不返回该Object的内容。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => 'Object的版本ID。只有查看Object指定版本的元数据信息时才显示该字段。', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgIDMh4mD0BYiIDUzNDA4OGNmZjBjYTQ0YmI4Y2I4ZmVlYzJlNGVk****', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => [ 'title' => 'Object的版本ID。只有查看Object指定版本的元数据信息时才显示该字段。', 'type' => 'string', ], ], 'ETag' => [ 'schema' => [ 'title' => 'Object生成时会创建ETag (entity tag)，ETag用于标识一个Object的内容。 对于通过PutObject请求创建的Object，ETag值是其内容的MD5值；对于其他方式创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。ETag值可以用于检查Object内容是否发生变化。不建议用户使用ETag作为Object内容的MD5校验来验证数据完整性。', 'type' => 'string', ], ], 'Content-Length' => [ 'schema' => [ 'title' => 'Object的文件大小，单位为字节。', 'type' => 'integer', 'format' => 'int64', ], ], 'x-oss-last-access-time' => [ 'schema' => [ 'title' => 'Object的最后一次访问时间。时间格式为HTTP 1.1协议中规定的GMT时间。开启访问追踪时，该字段的值会随着文件被访问的时间持续更新。如果开启后关闭了访问追踪，该字段的值保留为上一次最后更新的值。', 'type' => 'string', ], ], 'Last-Modifed' => [ 'schema' => [ 'title' => 'Object最后一次修改时间。时间格式为HTTP 1.1协议中规定的GMT时间。', 'type' => 'string', ], ], 'x-oss-transition-time' => [ 'schema' => [ 'title' => 'Object通过LIfecycle转为冷归档或深度冷归档的GMT时间。', 'type' => 'string', ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '获取文件的元数据信息', 'description' => '**注意事项**'."\n" .'- 文件（Object）的元数据信息包括该Object的ETag、Size、LastModified信息，且不返回该Object的内容。如果Object类型为软链接，则会返回软链接自身信息。'."\n" .'- 当Bucket未启用版本控制时，要获取文件的元数据信息，您必须有oss:GetObject权限。当Bucket已启用版本控制时，要获取文件指定版本（请求中携带了x-oss-version-id请求头）的元数据信息，您必须有oss:GetObjectVersion权限。具体操作，请参见[为RAM用户授权自定义的RAM Policy](~~199058~~)。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'GetObjectMeta操作默认获取Object当前版本的元数据信息。如果Object的当前版本为删除标记，则返回404 Not Found。请求参数中指定versionId则返回指定版本Object的元数据信息。'."\n" ."\n", ], 'RestoreObject' => [ 'summary' => '解冻归档类型（Archive）或冷归档（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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '请求解冻的Obejct的版本号。', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存解冻请求信息的请求体。', 'type' => 'object', 'properties' => [ 'RestoreRequest' => [ 'description' => '解冻请求信息的容器。', 'required' => false, '$ref' => '#/components/schemas/RestoreRequest', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-object-restore-priority' => [ 'schema' => [ 'type' => 'string', ], ], 'x-oss-version-id' => [ 'schema' => [ 'title' => '', 'type' => 'string', ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '解冻归档类型或冷归档的文件', 'description' => '**版本控制**'."\n" ."\n" .'Object的各个版本可以对应不同的存储类型。调用RestoreObject接口默认解冻Object当前版本，您可以通过指定versionId的方式来解冻Object指定版本。'."\n" ."\n" .'>- RestoreObject接口只针对归档或冷归档类型的Object，不适用于标准类型和低频访问类型的Object。'."\n" .'- 如果针对该Object第一次调用RestoreObject接口，则返回202。'."\n" .'- 如果已经成功调用过RestoreObject接口，且Object已完成解冻，再次调用时返回200 OK。'."\n" ."\n" .'**解冻过程说明**'."\n" ."\n" .'对于归档类型或者冷归档类型的Object，如果需要读取Object，请提前解冻。归档类型的Object解冻有分钟级延迟，冷归档类型的Object解冻有数小时延迟。'."\n" ."\n" .'归档类型或者冷归档类型的Object在执行解冻前后的状态变换过程如下：'."\n" ."\n" .'1、 Object初始时处于冷冻状态。'."\n" ."\n" .'2、提交一次解冻请求后，Object处于解冻中状态。'."\n" ."\n" .'3、服务端完成解冻任务后，Object进入解冻状态，此时您可以读取Object。'."\n" .'- 对于归档类型的Object，解冻状态默认持续24小时，24小时内再次调用RestoreObject接口则解冻状态会自动延长24小时，一次解冻流程内可有效调用7次RestoreObject接口达到最长7天的解冻持续时间。您也可以通过传入解冻天数，一次调用RestoreObject接口指定最长7天的解冻持续时间。'."\n" .'- 对于冷归档类型的Object，您可以指定解冻天数和解冻优先级，解冻天数最短为1天，最长为7天。不同解冻优先级的首字节取回时间如下：'."\n" ."\n" .' - 高优先级（Expedited）：表示1小时内完成解冻。'."\n" .' - 标准（Standard）：表示2~5小时内完成解冻。如果不传入JobParameters节点，则默认为Standard。'."\n" .' - 批量（Bulk）：表示5~12小时内完成解冻。'."\n" ."\n" .'4、解冻状态结束后，Object再次返回到冷冻状态。'."\n" ."\n" .'**计费说明**'."\n" ."\n" .'状态变换过程中产生的相关费用如下：'."\n" .'- 对处于冷冻状态的Object执行解冻操作，会产生数据取回费用。'."\n" .'- 解冻状态最多延长7天。在此期间不再重复收取数据取回费用。'."\n" .'- 解冻状态结束后，Object又回到冷冻状态，再次执行解冻操作会收取数据取回费用。'."\n", ], 'CleanRestoredObject' => [ 'summary' => '清理从冷归档或深度冷归档对象中解冻而来的副本', 'path' => '/{key}?cleanRestoredObject', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '247583', 'abilityTreeNodes' => [ 'FEATUREoss6C3PSM', 'FEATUREossNKCGPP', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'archive-bucket-example', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'title' => '要清理的解冻副本文件名称', 'description' => '要清理的解冻副本文件名称', 'type' => 'string', 'required' => true, 'example' => 'exampledir/restored-object', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '清理解冻副本', ], 'SelectObject' => [ 'summary' => '对目标文件执行SQL语句，返回执行结果。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'x-oss-process', 'in' => 'query', 'schema' => [ 'description' => '如果是csv文件，该值需要设置为csv/select；如果是json文件，则需要设置为json/select。', 'type' => 'string', 'required' => true, 'example' => 'csv/select', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存SelectObject请求的容器。', 'type' => 'object', 'properties' => [ 'SelectRequest' => [ 'description' => '保存Select请求的容器。', 'required' => false, '$ref' => '#/components/schemas/SelectRequest', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '- 若header x-oss-select-output-raw值为true，则表明返回结果是对象数据（而不是Frame包装的），客户端可以完全按照Get API的方式获取数据。'."\n" .'- 若x-oss-select-output-raw的值为false，请求结果以Frame形式返回。'."\n" .'Frame的格式为`Version|Frame-Type | Payload Length | Header Checksum | Payload | Payload Checksum<1 byte><--3 bytes--><---4 bytes----><-------4 bytes--><----4bytes---------->`。'."\n" ."\n\n" .'>Checksum均为CRC32。Frame里所有的整数均以大端编码（big endian），且Version目前为1。', 'type' => 'string', 'format' => 'binary', 'example' => '无', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\"无\\"","type":"json"}]', 'title' => '对文件执行SQL语句并返回结果', 'description' => '- 此操作要求您对该Object有读权限。'."\n" .'- 正确执行时，该API返回206。如果SQL语句不正确，或者和文件不匹配，则会返回400错误。'."\n" .'- 关于SelectObject的功能介绍请参见[使用SelectObject查询文件](~~106082~~)。', ], 'CreateSelectObjectMeta' => [ 'summary' => '获取目标文件总的行数，总的列数（对于CSV文件），以及Splits个数。如果该信息不存在，则会扫描整个文件，分析并记录下CSV文件的上述信息。重复调用该API则会保存上述信息而不必重新扫描整个文件。', 'path' => '/{key}', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '122930', 'abilityTreeNodes' => [ 'FEATUREossXWZUYL', ], ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.png', ], ], [ 'name' => 'x-oss-process', 'in' => 'query', 'schema' => [ 'description' => '如果是csv文件，该值需要设置为csv/meta；如果是json文件，则需要设置为json/meta。', 'type' => 'string', 'required' => true, 'example' => 'csv/meta', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存CreateSelectObjectMeta请求的容器。', 'type' => 'object', 'properties' => [ 'CsvMetaRequest' => [ 'description' => '保存SelectMetaRequest信息的容器。', 'required' => false, '$ref' => '#/components/schemas/SelectMetaRequest', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存CreateSelectObjectMeta信息的容器。', '$ref' => '#/components/schemas/SelectMetaStatus', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n","type":"xml"}]', 'title' => '获取目标文件总行数、总列数以及Splits个数', 'description' => '- `CreateSelectObjectMeta`操作要求您对该Object有写权限。'."\n" ."\n" .'- 如果该API执行正确，返回200。如果目标文件不是合法CSV或者JSON LINES文件，或者指定的CSV分隔符和目标CSV不匹配，则返回400。', ], 'InitiateMultipartUpload' => [ 'summary' => '通知OSS初始化一个Multipart Upload事件。', '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' => '初始化一个Multipart Upload事件的Bucket名称。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => '初始化一个Multipart Upload事件的Object名称。'."\n" ."\n", 'type' => 'string', 'required' => true, 'example' => 'multipart.data', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'description' => '指定对返回的Key进行编码，目前支持URL编码。Key使用UTF-8字符，但XML 1.0标准不支持解析一些控制字符，例如ASCII值从0到10的字符。对于Key中包含XML'."\n" .' 1.0标准不支持的控制字符，可以通过指定encoding-type对返回的Key进行编码。'."\n" .'默认值：无'."\n" .'可选值：**url**', 'required' => false, '$ref' => '#/components/schemas/EncodeType', ], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => [ 'description' => '指定InitiateMultipartUpload操作时是否覆盖同名Object。当目标Bucket处于已开启或已暂停的版本控制状态时，**x-oss-forbid-overwrite**请求Header设置无效，即允许覆盖同名Object。'."\n" .' - 不指定**x-oss-forbid-overwrite**或者指定**x-oss-forbid-overwrite**为**false**时，表示允许覆盖同名Object。'."\n" .' - 指定**x-oss-forbid-overwrite**为**true**时，表示禁止覆盖同名Object。'."\n" ."\n" .'设置**x-oss-forbid-overwrite**请求Header会导致QPS处理性能下降，如果您有大量的操作需要使用**x-oss-forbid-overwrite**请求Header（QPS>1000），请联系技术支持，避免影响您的业务。', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => [ 'description' => '指定Object的存储类型。'."\n" .'对于任意存储类型Bucket，如果上传Object时指定该值，则此次上传的Object将存储为指定的类型。例如在IA类型的Bucket中上传Object时，如果指定**x-oss-storage-class**为Standard，则该Object直接存储为Standard类型。'."\n" .'取值：'."\n" ."\n" .'- Standard：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" .'- ColdArchive：冷归档存储'."\n" ."\n" .'关于存储类型的更多信息，请参见**[存储类型介绍](~~51374~~)**。', 'required' => false, '$ref' => '#/components/schemas/StorageClass', ], ], [ 'name' => 'x-oss-tagging', 'in' => 'header', 'schema' => [ 'description' => '指定Object的标签，可同时设置多个标签，例如： TagA=A&TagB=B'."\n" .'> Key和Value需要先进行URL编码，如果某项没有`=`，则看作Value为空字符串。', 'type' => 'string', 'required' => false, 'example' => 'a:1', ], ], [ 'name' => 'x-oss-server-side-encryption', 'in' => 'header', 'schema' => [ 'description' => '指定上传该Object的每个part时使用的服务器端加密方式。'."\n" .'取值：**AES256**、**KMS**或**SM4**'."\n" .'> 使用KMS加密算法前，您需要先开通密钥管理服务KMS。'."\n" ."\n\n" .'指定此参数后，在响应头中会返回此参数，OSS会对上传的每个part进行加密编码存储。当下载该Object时，响应头中会包含x-oss-server-side-encryption，且该值会被设置成此Object的加密算法。', 'type' => 'string', 'required' => false, 'example' => 'AES256', ], ], [ 'name' => 'x-oss-server-side-data-encryption', 'in' => 'header', 'schema' => [ 'description' => '指定Object的加密算法。若未指定此选项，表明Object使用AES256加密算法。此选项仅当**x-oss-server-side-encryption**为KMS时有效。'."\n" .'取值：SM4', 'type' => 'string', 'required' => false, 'example' => 'SM4', ], ], [ 'name' => 'x-oss-server-side-encryption-key-id', 'in' => 'header', 'schema' => [ 'description' => '表示KMS托管的用户主密钥。'."\n" .'该参数在**x-oss-server-side-encryption**值为KMS时有效。', 'type' => 'string', 'required' => false, 'example' => '9468da86-3509-4f8d-a61e-6eab1eac****', ], ], [ 'name' => 'Cache-Control', 'in' => 'header', 'schema' => [ 'description' => '指定该Object被下载时的网页的缓存行为。更多信息，请参见**[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'private', ], ], [ 'name' => 'Content-Disposition', 'in' => 'header', 'schema' => [ 'description' => '指定该Object被下载时的名称。更多信息，请参见**[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'attachment;filename=oss_download.jpg ', ], ], [ 'name' => 'Content-Encoding', 'in' => 'header', 'schema' => [ 'description' => '指定该Object被下载时的内容编码格式。更多信息，请参见**[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'utf-8', ], ], [ 'name' => 'Expires', 'in' => 'header', 'schema' => [ 'description' => '过期时间，单位为毫秒。更多信息，请参见**[RFC 2616](https://www.ietf.org/rfc/rfc2616.txt)**。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 28 Feb 2012 05:38:42 GMT ', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存Initiate Multipart Upload请求结果的响应体。', 'type' => 'object', 'properties' => [ 'InitiateMultipartUploadResult' => [ 'description' => '保存Initiate Multipart Upload请求结果的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'description' => '初始化一个Multipart Upload事件的Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Key' => [ 'description' => '初始化一个Multipart Upload事件的Object名称。', 'type' => 'string', 'example' => 'test.txt', ], 'UploadId' => [ 'description' => '唯一标识此次Multipart Upload事件的ID，用于后续调用UploadPart和CompleteMultipartUpload接口。', 'type' => 'string', 'example' => '0004B9894A22E5B1888A1E29F823****', ], 'EncodingType' => [ 'description' => '指明返回结果中编码使用的类型。如果请求的参数中指定了encoding-type，那返回的结果会对Key进行编码。', 'type' => 'string', 'example' => 'url', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n test.txt\\n 0004B9894A22E5B1888A1E29F823****\\n url\\n","type":"xml"}]', 'title' => '通知OSS初始化分片上传事件', 'description' => '- 调用接口会返回一个OSS服务器创建的全局唯一的Upload ID，用于标识本次Multipart Upload事件。您可以根据这个ID来发起相关的操作，例如中止Multipart Upload、查询Multipart Upload等。'."\n" ."\n" .'- 初始化MultipartUpload请求，并不影响已存在的同名Object。'."\n" ."\n" .'- 该操作计算认证签名时，需要添加`?uploads`到`CanonicalizedResource`中。', ], 'UploadPart' => [ 'summary' => '根据指定的Object名和uploadId来分块（Part）上传数据。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'partNumber', 'in' => 'query', 'schema' => [ 'description' => '每一个上传的Part都有一个标识它的号码（partNumber）。'."\n" ."\n" .'取值：1~10000'."\n" ."\n" .'单个Part的大小限制为100 KB~5 GB。'."\n" .'>MultipartUpload事件中除最后一个Part以外，其他Part的大小都要大于或等于100 KB。因不确定是否为最后一个Part，UploadPart接口并不会立即校验上传Part的大小，只有当CompleteMultipartUpload时才会校验。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', ], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => [ 'description' => 'uploadId用于唯一标识上传的Part属于哪个Object。', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6EC98E36', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求体。', 'type' => 'string', 'format' => 'binary', 'required' => false, 'example' => '二进制内容', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '分块上传数据', 'description' => '- 调用UploadPart接口上传Part数据前，必须先调用InitiateMultipartUpload接口来获取OSS服务器生成的uploadId。'."\n" ."\n" .'- 如果使用同一个partNumber上传了新的数据，则OSS上已有的partNumber对应的Part数据将被覆盖。'."\n" ."\n" .'- OSS会将服务器端收到Part数据的MD5值放在ETag头返回给用户。'."\n" ."\n" .'- 如果调用InitiateMultipartUpload接口时，指定了x-oss-server-side-encryption请求头，则会对上传的Part进行加密编码，并在UploadPart响应头中返回x-oss-server-side-encryption头，其值表明该Part的服务器端加密算法。更多信息，请参见[InitiateMultipartUpload](~~31992~~)。', ], 'CompleteMultipartUpload' => [ 'summary' => '来完成整个文件的分片上传。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => [ 'description' => '此次MultipartUpload事件的唯一标识。', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6E****', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'description' => '指定对返回的Key进行编码，目前只支持URL编码。'."\n" ."\n\n" .'Key使用UTF-8字符，但XML 1.0标准不支持解析一些控制字符，例如ASCII码值从0到10的字符。当Key中包含XML 1.0标准不支持的控制字符时，您可以通过指定Encoding-type对返回的Key进行编码。'."\n" ."\n" .'默认值：无'."\n" ."\n" .'有效值：url', 'required' => false, '$ref' => '#/components/schemas/EncodeType', ], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => [ 'description' => '指定CompleteMultipartUpload操作时是否覆盖同名Object。'."\n" ."\n" .'- 不指定x-oss-forbid-overwrite或者指定x-oss-forbid-overwrite为false时，表示允许覆盖同名Object。'."\n" .'- 指定x-oss-forbid-overwrite为true时，表示禁止覆盖同名Object。'."\n" ."\n" .'> '."\n" .'- 当目标Bucket的版本控制状态为“开启”或“暂停”时，x-oss-forbid-overwrite请求Header设置无效，即允许覆盖同名Object。'."\n" .'- 设置x-oss-forbid-overwrite请求Header会导致QPS处理性能下降，如果您有大量的操作需要使用x-oss-forbid-overwrite请求Header（QPS > 1000），请工单联系我们进行确认，避免影响您的业务。', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'x-oss-complete-all', 'in' => 'header', 'schema' => [ 'description' => '指定是否列举当前UploadId已上传的所有Part。'."\n" ."\n" .'- 如果指定了x-oss-complete-all:yes，则OSS会列举当前UploadId已上传的所有Part，然后按照PartNumber的序号排序并执行CompleteMultipartUpload操作。执行CompleteMultipartUpload过程中无法检测正在上传或者漏传的Part，因此用户需要自己确保Part的完整性。'."\n" .'- 如果指定了x-oss-complete-all:yes，则不允许继续指定body，否则报错。'."\n" .'- 如果指定了x-oss-complete-all:yes，response的格式保持不变。', 'type' => 'string', 'required' => false, 'example' => 'yes', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存CompleteMultipartUpload请求内容的请求体。', 'type' => 'object', 'properties' => [ 'CompleteMultipartUpload' => [ 'description' => '保存CompleteMultipartUpload请求内容的容器。', 'required' => false, '$ref' => '#/components/schemas/CompleteMultipartUpload', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => [ 'title' => '文件版本id', 'type' => 'string', ], ], ], 'schema' => [ 'description' => '保存CompleteMultipartUpload请求结果的响应体。', 'type' => 'object', 'properties' => [ 'CompleteMultipartUploadResult' => [ 'description' => '保存CompleteMultipartUpload请求响应内容的容器。', 'type' => 'object', 'properties' => [ 'EncodingType' => [ 'description' => '是否对返回的key进行编码。', 'type' => 'string', 'example' => 'url', ], 'Location' => [ 'description' => '新创建Object的URL。', 'type' => 'string', 'example' => 'http://oss-example.oss-cn-hangzhou.aliyuncs.com/multipart.data', ], 'Bucket' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Key' => [ 'description' => '新创建Object的名字。', 'type' => 'string', 'example' => 'multipart.data', ], 'ETag' => [ 'description' => 'Object生成时会创建相应的ETag ，ETag用于标识一个Object的内容。'."\n" ."\n" .'通过CompleteMultipartUpload请求创建的Object，ETag值是基于一定计算规则生成的唯一值，但不是其内容的MD5值。'."\n" ."\n" .'>ETag值可以用于检查Object内容是否发生变化。不建议使用ETag作为Object内容的MD5来校验数据完整性。', 'type' => 'string', 'example' => '"B864DB6A936D376F9F8D3ED3BBE540****"', ], ], ], ], ], ], '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' => '完成整个文件的分片上传', 'description' => '**注意事项**'."\n" ."\n\n" .'调用CompleteMultipartUpload操作时，用户必须提供所有有效的Part列表（包括PartNumber和ETag）。OSS收到用户提交的Part列表后，会逐一验证每个Part的有效性。当所有的Part验证通过后，OSS将把这些Part组合成一个完整的Object。'."\n" .'- 确认Part的大小：CompleteMultipartUpload时会确认除最后一个Part以外所有Part的大小是否都大于或等于100 KB，并检查用户提交的Part列表中的每一个PartNumber和ETag。所以在上传Part时，客户端除了需要记录Part号码外，还需要记录每次上传Part成功后服务器返回的ETag值。'."\n" ."\n" .'- 处理请求：由于OSS处理CompleteMultipartUpload请求时会持续一定的时间。在这段时间内，如果客户端与OSS之间连接中断，OSS仍会继续该请求。'."\n" ."\n" .'- PartNumber：服务端在调用CompleteMultipartUpload接口时会对PartNumber做校验。'."\n" .'PartNumber取值为1~10000。PartNumber可以不连续，但必须升序排列。例如第一个Part的PartNumber是1，第二个Part的PartNumber可以是5。'."\n" ."\n" .'- UploadId：同一个Object可以同时拥有不同的UploadId，当Complete一个UploadId后，此UploadId将无效，但该Object的其他UploadId不受影响。'."\n" ."\n" .'- x-oss-server-side-encryption请求头：如果调用InitiateMultipartUpload接口时，指定了x-oss-server-side-encryption请求头，则在CompleteMultipartUpload的响应头中返回x-oss-server-side-encryption，其值表示该Object的服务器端加密算法。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'在开启版本控制的情况下，调用CompleteMultipartUpload接口来完成整个文件的MultipartUpload，OSS会为整个文件生成唯一的版本ID，并在响应header中以x-oss-version-id的形式返回。', ], 'UploadPartCopy' => [ 'summary' => '从一个已存在的Object中拷贝数据来上传一个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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'x-oss-copy-source', 'in' => 'header', 'schema' => [ 'description' => '拷贝源地址（必须有可读权限）。', 'type' => 'string', 'required' => true, 'example' => '/oss-example/ src-object', ], ], [ 'name' => 'partNumber', 'in' => 'query', 'schema' => [ 'description' => '每一个上传的Part都有一个标识它的号码（partNumber）。'."\n" ."\n" .'取值：1~10000'."\n" ."\n" .'单个Part的大小限制为100 KB~5 GB。'."\n" .'> MultipartUpload事件中除最后一个Part以外，其他Part的大小都要大于或等于100 KB。因不确定是否为最后一个Part，UploadPart接口并不会立即校验上传Part的大小，只有当CompleteMultipartUpload时才会校验。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', ], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => [ 'description' => 'uploadId用于唯一标识上传的Part属于哪个Object。', 'type' => 'string', 'required' => true, 'example' => '0004B999EF5A239BB9138C6227D69F95', ], ], [ 'name' => 'x-oss-copy-source-range', 'in' => 'header', 'schema' => [ 'description' => '源Object的拷贝范围。例如设置bytes=0~9，表示拷贝0到9这10个字符。'."\n" .'默认值：无'."\n" .' - 不指定该请求头时，表示拷贝整个源Object。'."\n" .' - 当指定该请求头时，则返回消息中会包含整个文件的长度和此次拷贝的范围，例如：Content-Range: bytes 0~9/44，表示整个文件长度为44，此次拷贝的范围为0~9。'."\n" .' - 当指定的范围不符合规范时，则拷贝整个源Object，并且不在结果中提及Content-Range。', 'type' => 'string', 'required' => false, 'example' => 'bytes=100-6291756', ], ], [ 'name' => 'x-oss-copy-source-if-match', 'in' => 'header', 'schema' => [ 'description' => '如果源Object的ETAG值和用户提供的ETAG相等，则执行拷贝操作；否则返回412 HTTP错误码（预处理失败）。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', ], ], [ 'name' => 'x-oss-copy-source-if-none-match', 'in' => 'header', 'schema' => [ 'description' => '如果传入的ETag值和Object的ETag不匹配，则正常传输文件，并返回200 OK；否则返回304 Not Modified。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => '5B3C1A2E053D763E1B002CC607C5****', ], ], [ 'name' => 'x-oss-copy-source-if-unmodified-since', 'in' => 'header', 'schema' => [ 'description' => '如果传入参数中的时间等于或者晚于文件实际修改时间，则正常传输文件，并返回200 OK；否则返回412 precondition failed错误。'."\n" .'默认值：无', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Oct 2015 14:47:53 GMT', ], ], [ 'name' => 'x-oss-copy-source-if-modified-since', 'in' => 'header', 'schema' => [ 'description' => '如果指定的时间早于实际修改时间，则正常传送文件，并返回200 OK；否则返回304 not modified。'."\n" .'默认值：无'."\n" .'时间格式：GMT时间，例如Fri, 13 Nov 2015 14:47:53 GMT', 'type' => 'string', 'required' => false, 'example' => 'Fri, 13 Nov 2015 14:47:53 GMT', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-copy-source-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], 'schema' => [ 'description' => 'UploadPartCopy请求的响应体。', 'type' => 'object', 'properties' => [ 'CopyPartResult' => [ 'description' => '保存UploadPartCopy结果的容器。', 'type' => 'object', 'properties' => [ 'LastModified' => [ 'description' => '最近一次修改时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2014-07-17T06:27:54.000Z', ], 'ETag' => [ 'description' => '被拷贝Object的ETag值。', 'type' => 'string', 'example' => '"5B3C1A2E053D763E1B002CC607C5****"', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n 2014-07-17T06:27:54.000Z\\n \\"5B3C1A2E053D763E1B002CC607C5****\\"\\n","type":"xml"}]', 'title' => '拷贝数据上传一个数据块', 'description' => '该接口为通过在UploadPart请求的基础上增加一个请求头x-oss-copy-source来调用UploadPartCopy接口，实现从一个已存在的Object中拷贝数据来上传一个Part。'."\n" ."\n" .'**注意事项**'."\n" .'
当拷贝一个大于1 GB的文件时，必须使用UploadPartCopy的方式进行拷贝。如果想通过单个操作拷贝小于1 GB的文件，请参见[CopyObject](https://help.aliyun.com/document_detail/31979.htm?spm=a2c4g.11186623.0.0.49aa29d6oRCP8o#t4696.html)。'."\n" .'
使用UploadPartCopy接口时，有如下注意事项：'."\n" ."\n" .'- 不允许拷贝以AppendObject方式上传的Object。'."\n" ."\n" .'- 执行UploadPartCopy的源Bucket地址和目标Bucket地址必须是同一个Region。'."\n" ."\n" .'- 调用该接口上传Part数据前，必须先调用InitiateMultipartUpload接口来获取一个OSS服务器颁发的Upload ID。'."\n" ."\n" .'- 若调用InitiateMultipartUpload接口时，指定了x-oss-server-side-encryption请求头，则会对上传的Part进行加密编码，并在UploadPart响应头中返回x-oss-server-side-encryption头，其值表明该Part的服务器端加密算法，详情请参见[InitiateMultipartUpload](~~31992~~)。'."\n" ."\n" .'- MultipartUpload要求除最后一个Part以外，其他的Part大小都要大于100 KB。因不确定是否为最后一个Part，UploadPart接口并不会立即校验上传Part的大小，只有当CompleteMultipartUpload的时候才会校验。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'UploadPartCopy默认从一个已存在的Object的当前版本中拷贝数据来上传一个Part。允许通过在请求头x-oss-copy-source中附带versionId的子条件，实现从Object的指定版本进行拷贝，例如x-oss-copy-source : /SourceBucketName/SourceObjectName?versionId=111111。'."\n" .'>SourceObjectName要进行URL编码。响应中将会返回被拷贝Object的versionId：x-oss-copy-source-version-id。'."\n" ."\n" .'如果未指定versionId且拷贝Object的当前版本为删除标记（Delete Marker），OSS将返回404 Not Found。通过指定versionId来拷贝删除标记时，OSS将返回400 Bad Request。'."\n" ."\n", ], 'AbortMultipartUpload' => [ 'summary' => '用于取消MultipartUpload事件并删除对应的Part数据。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'oss-example', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => [ 'description' => '此次MultipartUpload事件的唯一标识。', 'type' => 'string', 'required' => true, 'example' => '0004B9895DBBB6E****', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '取消分片上传事件并删除数据块数据', 'description' => '**注意事项**'."\n" ."\n" .'- 您需要提供MultipartUpload事件相应的uploadId。'."\n" .'- 取消一个MultipartUpload事件过程中，如果所属的某些Part仍然在上传，那么此次取消操作将无法删除这些Part。'."\n" .'- 取消一个MultipartUpload事件后，您无法再使用此uploadId做任何操作，已经上传的Part数据也会被删除。'."\n" .'- 建议您及时完成分片上传或者取消分片上传，因为已上传但是未完成或未取消的分片会占用存储空间进而产生存储费用。', ], 'ListMultipartUploads' => [ 'summary' => '列举所有执行中的Multipart Upload事件。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'delimiter', 'in' => 'query', 'schema' => [ 'description' => '用于对Object名称进行分组的字符。所有名称包含指定的前缀且首次出现delimiter字符之间的Object作为一组元素CommonPrefixes。', 'type' => 'string', 'required' => false, 'example' => '/', ], ], [ 'name' => 'max-uploads', 'in' => 'query', 'schema' => [ 'description' => '限定此次返回Multipart Upload事件的最大个数，默认值为1000。最大值为1000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'key-marker', 'in' => 'query', 'schema' => [ 'description' => '与upload-id-marker参数配合使用，用于指定返回结果的起始位置。'."\n" .' - 如果未设置upload-id-marker参数，查询结果中包含所有Object名称的字典序大于key-marker参数值的Multipart Upload事件。'."\n" .' - 如果设置了upload-id-marker参数，查询结果中包含：'."\n" .' - 所有Object名称的字典序大于key-marker参数值的Multipart Upload事件。'."\n" .' - Object名称等于key-marker参数值，但是UploadId比upload-id-marker参数值大的Multipart Upload事件。', 'type' => 'string', 'required' => false, 'example' => 'test1.avi', ], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'description' => '限定返回的Object Key必须以prefix作为前缀。注意使用prefix查询时，返回的Key中仍会包含prefix。'."\n" .'> 您可以灵活地使用prefix参数对Bucket内的Object进行分组管理（类似文件夹功能）。', 'type' => 'string', 'required' => false, 'example' => 'fun/', ], ], [ 'name' => 'upload-id-marker', 'in' => 'query', 'schema' => [ 'description' => '与key-marker参数配合使用，用于指定返回结果的起始位置。'."\n" .' - 如果未设置key-marker参数，则OSS会忽略upload-id-marker参数。'."\n" .' - 如果设置了key-marker参数，查询结果中包含：'."\n" .' - 所有Object名称的字典序大于key-marker参数值的Multipart Upload事件。'."\n" .' - Object名称等于key-marker参数值，但是UploadId比upload-id-marker参数值大的Multipart Upload事件。', 'type' => 'string', 'required' => false, 'example' => '0004B99B8E707874FC2D692FA5D7****', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'schema' => [ 'description' => '指定对返回的内容进行编码，指定编码的类型。Delimiter、KeyMarker、Prefix、NextKeyMarker和Key使用UTF-8字符，但xml 1.0标准不支持解析一些控制字符，例如ASCII值从0到10的字符。对于包含xml'."\n" .' 1.0标准不支持的控制字符，可以通过指定encoding-type对返回的Delimiter、KeyMarker、Prefix、NextKeyMarker和Key进行编码。'."\n" ."\n" .'默认值：无', 'required' => false, '$ref' => '#/components/schemas/EncodeType', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存ListMultipartUpload请求结果的响应体。', 'type' => 'object', 'properties' => [ 'ListMultipartUploadsResult' => [ 'description' => '保存ListMultipartUpload请求结果的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'EncodingType' => [ 'description' => '指明返回结果中编码使用的类型。如果请求参数中指定了encoding-type，那返回的结果会对Delimiter、KeyMarker、Prefix、NextKeyMarker和Key这些元素进行编码。', 'type' => 'string', 'example' => 'url', ], 'KeyMarker' => [ 'description' => '列表的起始Object位置。', 'type' => 'string', 'example' => 'abc', ], 'UploadIdMarker' => [ 'description' => '列表的起始UploadId位置。', 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D6****', ], 'NextKeyMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextKeyMarker元素，用于表示接下来请求的KeyMarker值。', 'type' => 'string', 'example' => 'oss.avi', ], 'NextUploadIdMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextUploadMarker元素，用于表示接下来请求的UploadMarker值。', 'type' => 'string', 'example' => '0004B99B8E707874FC2D692FA5D77D3F', ], 'MaxUploads' => [ 'description' => '返回的最大Upload个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'IsTruncated' => [ 'description' => '表示本次返回的MultipartUpload结果列表是否被截断。取值范围如下：'."\n" ."\n" .'true：表示本次没有返回全部结果。'."\n" ."\n" .'false（默认）：表示本次已经返回了全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'Prefix' => [ 'description' => '本次查询所用的前缀。', 'type' => 'string', 'example' => 'logs/', ], 'Delimiter' => [ 'description' => '本次查询所用的Object名称分组字符。', 'type' => 'string', 'example' => '/', ], 'Upload' => [ 'description' => '保存Multipart Upload事件信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存Multipart Upload事件信息的容器。', '$ref' => '#/components/schemas/Upload', ], ], 'CommonPrefixes' => [ 'description' => '保存列举结果中Object名称公共前缀的列表。', 'type' => 'array', 'items' => [ 'description' => '保存列举结果中Object名称公共前缀的容器。', '$ref' => '#/components/schemas/CommonPrefix', ], ], ], ], ], ], ], '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 \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '列举执行中的分片上传事件', 'description' => '调用ListMultipartUploads接口列举所有执行中的Multipart Upload事件，即已经初始化但还未完成（Complete）或者还未中止（Abort）的Multipart Upload事件。', ], 'ListParts' => [ 'summary' => '列举指定Upload ID所属的所有已经上传成功Part。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'uploadId', 'in' => 'query', 'schema' => [ 'description' => 'MultipartUpload事件的ID。'."\n", 'type' => 'string', 'required' => true, 'example' => '0004B999EF5A239BB9138C6227D69F95', ], ], [ 'name' => 'max-parts', 'in' => 'query', 'schema' => [ 'description' => '规定在OSS响应中的最大Part数目。'."\n" ."\n" .'默认值：**1,000**'."\n" ."\n" .'最大值：**1,000**', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'part-number-marker', 'in' => 'query', 'schema' => [ 'description' => '指定List的起始位置，只有Part Number数目大于该参数的Part会被列出。'."\n" .'默认值：无', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'encoding-type', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '指定对返回的内容进行编码，指定编码的类型。Key使用UTF-8字符，但xml 1.0标准不支持解析一些控制字符，比如ascii值从0到10的字符。对于Key中包含xml 1.0标准不支持的控制字符，可以通过指定Encoding-type对返回的Key进行编码。'."\n" ."\n" .'默认值：无'."\n" ."\n" .'可选值：**url**', 'required' => false, '$ref' => '#/components/schemas/EncodeType', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存List Part请求结果的响应体。', 'type' => 'object', 'properties' => [ 'ListPartResult' => [ 'description' => '保存List Part请求结果的容器。', 'type' => 'object', 'properties' => [ 'Bucket' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'example' => 'example-bucket', ], 'Key' => [ 'description' => 'Object名称。', 'type' => 'string', 'example' => 'multipart.data', ], 'UploadId' => [ 'description' => 'Upload事件ID。', 'type' => 'string', 'example' => '0004B999EF5A239BB9138C6227D69F95', ], 'PartNumberMarker' => [ 'description' => '本次List结果的Part Number起始位置。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'NextPartNumberMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextPartNumberMarker元素，用于标明接下来请求的PartNumberMarker值。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'MaxParts' => [ 'description' => '返回请求中最大的Part数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'IsTruncated' => [ 'description' => '标明本次返回的ListParts结果列表是否被截断。“true”表示本次没有返回全部结果；“false”表示本次已经返回了全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'Part' => [ 'description' => '保存Part信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存Part信息的容器。', '$ref' => '#/components/schemas/Part', ], ], ], ], ], ], ], '5xx' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n example-bucket\\n multipart.data\\n 0004B999EF5A239BB9138C6227D69F95\\n 10\\n 5\\n 20\\n true\\n \\n \\n 0\\n 0\\n \\n \\n","type":"xml"}]', 'title' => '列举所有成功上传的数据块', 'description' => '- OSS的返回结果按照Part号码升序排列。'."\n" ."\n" .'- 由于网络传输可能出错，所以不推荐使用ListParts返回结果中的Part Number和ETag值来生成已经上传成功的Part列表。'."\n", ], 'PutObjectAcl' => [ 'summary' => '修改文件（Object）的访问权限（ACL）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => [ 'description' => '指定OSS创建Object时的访问权限。'."\n" .'取值：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见**[读写权限ACL](~~100676~~)**。', 'required' => true, '$ref' => '#/components/schemas/ObjectACL', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => 'Object对应的版本', 'type' => 'string', 'required' => false, 'example' => 'CAEQMhiBgIC3rpSD0BYiIDBjYTk5MmIzN2JlNjQxZTFiNGIzM2E3OTliODA0****', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => [ 'title' => 'The version of a object', 'type' => 'string', ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改文件的访问权限', 'description' => '**注意事项**'."\n" ."\n" .'此操作只有Bucket Owner有权限执行，且需对Object有读写权限。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'调用PutObjectACL接口时，默认只能设置Object当前版本的ACL。您可以通过指定versionId参数来设置指定Object版本的ACL。如果Object的对应版本为删除标记（Delete Marker），则OSS将返回404 Not Found。'."\n" ."\n" .'**ACL说明**'."\n" ."\n" .'PutObjectACL接口通过Put请求中的`x-oss-object-acl`头来设置Object ACL。目前Object包括如下四种访问权限。'."\n" ."\n" .'- private：Object是私有资源。只有该Object的Owner拥有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。Object Owner拥有该Object的读写权限。非Object Owner只有该Object的读权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户拥有对该Object的读写权限。'."\n" .'- default：Object遵循其所在Bucket的读写权限，即Bucket是什么权限，Object就是什么权限。'."\n" ."\n" .'>**注意**'."\n" .'- Object ACL优先级高于Bucket ACL。例如Bucket ACL是private的，而Object ACL是public-read-write的，则所有用户都拥有该Object的访问权限，即使该Bucket是私有Bucket。如果某个Object未设置过ACL，则访问权限遵循Bucket ACL。'."\n" .'- Object的读操作包括GetObject、HeadObject、CopyObject和UploadPartCopy中的对原Object的读；Object的写操作包括PutObject、PostObject、AppendObject、DeleteObject、DeleteMultipleObjects、CompleteMultipartUpload以及CopyObject对新Object的写。'."\n" .'- 您还可以在进行Object的写操作时，在请求头中带上x-oss-object-acl来设置Object'."\n" .' ACL，效果与PutObjectACL等同。例如PutObject时在请求头中带上x-oss-object-acl可以在上传一个Object的同时设置此Object的ACL。'."\n", ], 'GetObjectAcl' => [ 'summary' => '获取存储空间（Bucket）下某个文件（Object）的访问权限（ACL）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'title' => 'The version of a object', 'description' => 'Object对应的版本。', 'type' => 'string', 'required' => false, 'example' => 'list1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '存储ACL信息的响应体。', 'type' => 'object', 'properties' => [ 'AccessControlPolicy' => [ 'description' => '存储ACL信息的容器。', 'type' => 'object', 'properties' => [ 'Owner' => [ 'description' => '保存Bucket拥有者信息的容器。', '$ref' => '#/components/schemas/Owner', ], 'AccessControlList' => [ 'description' => '存储ACL信息的容器。', 'type' => 'object', 'properties' => [ 'Grant' => [ 'description' => 'Object的ACL权限。', '$ref' => '#/components/schemas/ObjectACL', ], ], ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取文件的访问权限', 'description' => '**版本控制**'."\n" ."\n" .'调用GetObjectACL接口时，默认只能获取Object当前版本的ACL。您可以通过指定versionId参数来获取指定Object版本的ACL。如果Object的对应版本为删除标记（Delete Marker），则OSS将返回404 Not Found。'."\n" ."\n" .'>如果一个Object从未设置过ACL，则调用GetObjectACL时，返回的ObjectACL为default，表示该Object的ACL遵循Bucket ACL。即如果Bucket的访问权限是private，则该Object的访问权限也是private。', ], 'PutSymlink' => [ 'summary' => '为OSS的目标文件（TargetObject）创建软链接（Symlink）。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'x-oss-symlink-target', 'in' => 'header', 'schema' => [ 'description' => '软链接指向的目标文件。'."\n" .'合法值：命名规范同Object'."\n" .' - TargetObjectName同ObjectName一样，需要对其进行URL编码。'."\n" .' - 软链接的目标文件类型不能为软链接。', 'type' => 'string', 'required' => true, 'example' => 'oss.jpg', ], ], [ 'name' => 'x-oss-object-acl', 'in' => 'header', 'schema' => [ 'description' => '指定OSS创建Object时的访问权限。'."\n" ."\n" .'取值：'."\n" ."\n" .'- default（默认）：Object遵循所在存储空间的访问权限。'."\n" .'- private：Object是私有资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户没有权限操作该Object。'."\n" .'- public-read：Object是公共读资源。只有Object的拥有者和授权用户有该Object的读写权限，其他用户只有该Object的读权限。请谨慎使用该权限。'."\n" .'- public-read-write：Object是公共读写资源。所有用户都有该Object的读写权限。请谨慎使用该权限。'."\n" ."\n" .'关于访问权限的更多信息，请参见**[读写权限ACL](~~100676~~)**。', 'required' => false, '$ref' => '#/components/schemas/ObjectACL', ], ], [ 'name' => 'x-oss-storage-class', 'in' => 'header', 'schema' => [ 'description' => '指定Object的存储类型。'."\n" .'对于任意存储类型的Bucket，如果上传Object时指定此参数，则此次上传的Object将存储为指定的类型。例如在IA类型的Bucket中上传Object时，如果指定**x-oss-storage-class**为Standard，则该Object直接存储为Standard。'."\n" ."\n" .'取值：'."\n" .'- Standard：标准存储'."\n" .'- IA：低频访问'."\n" .'- Archive：归档存储'."\n" ."\n" .'IA与Archive类型的单个Object大小如果不足64 KB，则会按64 KB计量计费。建议在使用PutSymlink接口时不要将Object的存储类型指定为IA或Archive。'."\n" .'关于存储类型的更多信息，请参见**[存储类型介绍](~~51374~~)**。', 'required' => false, '$ref' => '#/components/schemas/StorageClass', ], ], [ 'name' => 'x-oss-forbid-overwrite', 'in' => 'header', 'schema' => [ 'description' => '指定PutSymlink操作时是否覆盖同名Object。'."\n" .' - 不指定**x-oss-forbid-overwrite**或者指定**x-oss-forbid-overwrite**为**false**时，表示允许覆盖同名Object。'."\n" .' - 指定**x-oss-forbid-overwrite**为**true**时，表示禁止覆盖同名Object。'."\n" ."\n" .'设置**x-oss-forbid-overwrite**请求Header会导致QPS处理性能下降，如果您有大量的操作需要使用**x-oss-forbid-overwrite**请求Header（QPS>1000），请联系技术支持，避免影响您的业务。'."\n" .'> 当目标Bucket处于已开启或已暂停版本控制状态时，**x-oss-forbid-overwrite**请求Header设置无效，即允许覆盖同名Object。', 'type' => 'string', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '创建OSS目标文件的软链接', 'description' => '**注意事项**'."\n" ."\n" .'- 使用PutSymlink接口创建软链接时不会检查目标文件是否存在、目标文件类型是否合法以及目标文件是否有访问权限。'."\n" .'- Symlink自身的访问权限（ACL）以及目标文件的ACL检查仅会在GetObject等需要访问目标文件的API中进行。'."\n" .'- 使用PutSymlink接口时，携带以x-oss-meta-为前缀的参数，则被视为user meta，例如x-oss-meta-location。一个Object可以有多个类似的参数，但所有的user meta总大小不能超过8 KB。'."\n" .'- 默认情况下，如果试图添加的文件已经存在，并且有访问权限，则新添加的文件将覆盖原来的文件，成功添加后将返回200 OK。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'您可以通过TargetObject创建的软链接指向TargetObject的当前版本。'."\n" .'软链接本身也可以有多个版本，每个不同的版本可以指向不同的TargetObject，版本ID由OSS自动生成，在响应Header中返回x-oss-version-id。'."\n" ."\n", ], 'GetSymlink' => [ 'summary' => '获取OSS目标文件（TargetObject）的软链接。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '获取软链接的当前Object版本。', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-symlink-target' => [ 'schema' => [ 'sdkPropertyName' => 'symlinkTargetKey', 'type' => 'string', ], ], 'x-oss-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '获取软链接', 'description' => '**版本控制**'."\n" ."\n" .'GetSymlink接口默认获取软链接的当前版本。允许通过指定versionId来获取指定版本。如果软链接的当前版本为删除标记，OSS会返回404 Not Found，在响应header中返回x-oss-delete-marker = true以及版本ID : x-oss-version-id。删除标记没有关联数据，因此也没有软链接指向的TargetObject。'."\n" ."\n", ], 'PutObjectTagging' => [ 'summary' => '设置或更新对象（Object）的标签（Tagging）信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject.txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '版本对应的ID。', 'type' => 'string', 'required' => false, 'example' => 'CAEQNRiBgMClj7qD0BYiIDQ5Y2QyMjc3NGZkODRlMTU5M2VkY2U3MWRiNGRh****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存标签集合的请求体。', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => '标签集合。', 'required' => false, '$ref' => '#/components/schemas/Tagging', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-oss-version-id' => [ 'schema' => [ 'type' => 'string', ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置或更新文件的标签信息', 'description' => '**注意事项**'."\n" ."\n" .'- 对象标签使用一组键值对（Key-Value）标记对象。'."\n" .'- 单个Object最多能设置10个标签，Key不能重复。'."\n" .'- 每个Key长度不能超过128字符，每个Value长度不能超过256字符。'."\n" .'- Key和Value区分大小写。'."\n" .'- 标签的合法字符集包括大小写字母、数字、空格和以下符号：'."\n" .'+‑=._:/'."\n" .'通过HTTP Header的方式设置标签且标签中包含任意字符时，您需要对标签的Key和Value进行URL编码。'."\n" .'- 更改标签信息不会更新Object的Last‑Modified时间。'."\n" ."\n" .'关于对象标签的更多信息，请参见[对象标签](~~106678~~)。'."\n" ."\n" .'**版本控制**'."\n" ."\n" .'调用PutObjectTagging接口时，默认设置Object当前版本的标签信息。您可以通过指定versionId参数来设置指定Object版本的标签信息。如果Object的对应版本为删除标记（Delete Marker），则OSS将返回404 Not Found。', ], 'GetObjectTagging' => [ 'summary' => '获取对象（Object）的标签（Tagging）信息。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object的完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '获取的目标Object的版本号。', 'type' => 'string', 'required' => false, 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存标签集合的响应体。', 'type' => 'object', 'properties' => [ 'Tagging' => [ 'description' => '保存标签集合的容器。', 'type' => 'object', 'properties' => [ 'TagSet' => [ 'description' => '标签集合。', '$ref' => '#/components/schemas/TagSet', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取文件的标签信息', 'description' => '**版本控制**'."\n" ."\n" .'调用GetObjectTagging接口时，默认只能获取Object当前版本的标签信息。您可以通过指定versionId参数来获取指定Object版本的标签信息。如果Object的对应版本为删除标记（Delete Marker），则OSS将返回404 Not Found。'."\n" ."\n", ], 'DeleteObjectTagging' => [ 'summary' => '删除指定对象（Object）的标签（Tagging）信息。', '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' => 'bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'key', 'in' => 'path', 'schema' => [ 'description' => 'Object完整路径。', 'type' => 'string', 'required' => true, 'example' => 'exampledir/exampleobject/txt', ], ], [ 'name' => 'versionId', 'in' => 'query', 'schema' => [ 'description' => '删除的Object的版本号。', 'type' => 'string', 'required' => false, 'example' => 'CAEQExiBgID.jImWlxciIDQ2ZjgwODIyNDk5MTRhNzBiYmQwYTZkMTYzZjM0****', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除对象的标签信息', 'description' => '**版本控制**'."\n" ."\n" .'调用DeleteObjectTagging接口时，默认只能删除Object当前版本的标签信息。您可以通过指定versionId参数来删除指定Object版本的标签信息。如果Object的对应版本为删除标记（Delete Marker），则OSS将返回404 Not Found。'."\n" ."\n", ], 'PutLiveChannel' => [ 'summary' => '通过RTMP协议上传音视频数据前，必须先创建一个LiveChannel。', 'path' => '/{channel}?live', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '频道名称。不能包含斜杠（/）。', 'type' => 'string', 'required' => true, 'example' => 'ChannelName', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '保存LiveChannel配置的请求体。', 'type' => 'object', 'properties' => [ 'LiveChannelConfiguration' => [ 'description' => '保存LiveChannel配置的容器。', 'required' => false, '$ref' => '#/components/schemas/LiveChannelConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存CreateLiveChannel请求结果的响应体。', 'type' => 'object', 'properties' => [ 'CreateLiveChannelResult' => [ 'description' => '保存CreateLiveChannel请求结果的容器。', 'type' => 'object', 'properties' => [ 'PublishUrls' => [ 'description' => '保存推流地址的容器。', '$ref' => '#/components/schemas/LiveChannelPublishUrls', ], 'PlayUrls' => [ 'description' => '保存播放地址的容器。', '$ref' => '#/components/schemas/LiveChannelPlayUrls', ], ], ], ], ], ], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '创建直播推流', 'description' => '通过RTMP协议上传音视频数据前，必须先调用该接口创建一个LiveChannel。调用该接口会返回RTMP推流地址，以及对应的播放地址。'."\n" .'
您可以使用返回的地址进行推流、播放，您还可以根据该LiveChannel的名称来发起相关的操作，如查询推流状态、查询推流记录、禁止推流等。'."\n", ], 'ListLiveChannel' => [ 'summary' => '列举指定的LiveChannel。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'marker', 'in' => 'query', 'schema' => [ 'description' => '设定结果从marker之后按字母排序的第一个开始返回。', 'type' => 'string', 'required' => false, 'example' => 'channel-1', ], ], [ 'name' => 'max-keys', 'in' => 'query', 'schema' => [ 'description' => '限定此次返回LiveChannel的最大数。max-keys取值不能大于1000。'."\n" .'默认值：100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], ], [ 'name' => 'prefix', 'in' => 'query', 'schema' => [ 'description' => '限定返回的LiveChannel必须以prefix作为前缀。注意使用prefix查询时，返回的key中仍会包含prefix。', 'type' => 'string', 'required' => false, 'example' => 'fun/', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存ListLiveChannel请求结果的响应体。', 'type' => 'object', 'properties' => [ 'ListLiveChannelResult' => [ 'description' => '保存ListLiveChannel请求结果的容器。', 'type' => 'object', 'properties' => [ 'Prefix' => [ 'description' => '本次查询结果的开始前缀。', 'type' => 'string', 'example' => 'Channel', ], 'Marker' => [ 'description' => '本次ListLiveChannel的起点。', 'type' => 'string', 'example' => 'new', ], 'MaxKeys' => [ 'description' => '响应请求内返回结果的最大数目。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'IsTruncated' => [ 'description' => '是否已返回所有的结果。'."\n" ."\n" .'true：表示本次请求已返回全部结果。'."\n" ."\n" .'false：表示本次请求未返回全部结果。', 'type' => 'boolean', 'example' => 'true', ], 'NextMarker' => [ 'description' => '如果本次没有返回全部结果，响应请求中将包含NextMarker元素，用于标明接下来请求的Marker值。', 'type' => 'string', 'example' => 'channel-0', ], 'LiveChannel' => [ 'description' => '保存返回的LiveChannel信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存LiveChannel信息的容器。', '$ref' => '#/components/schemas/LiveChannel', ], ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n Channel\\n new\\n 20\\n true\\n channel-0\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '列举指定的直播推流', ], 'DeleteLiveChannel' => [ 'summary' => '删除指定的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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '指定LiveChannel名称，该LiveChannel必须存在。', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除指定的直播推流', 'description' => '>- 当有客户端正在向LiveChannel推流时，删除请求会失败。'."\n" .'- 本接口只会删除LiveChannel本身，不会删除推流生成的文件。', ], 'PutLiveChannelStatus' => [ 'summary' => '切换LiveChannel启用（enabled）和禁用（disabled）两种状态。', 'path' => '/{channel}?live', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'description' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '指定LiveChannel名称，该LiveChannel必须存在。', 'type' => 'string', 'required' => true, 'example' => 'exmplechannel', ], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ 'description' => '设置LiveChannel的Status。'."\n" .'有效值：'."\n" .'- enabled：启用LiveChannel'."\n" .'- disabled：禁用LiveChannel', 'type' => 'string', 'required' => true, 'example' => 'enabled', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '切换直播推流状态', 'description' => '- LiveChannel处于disabled状态时，OSS会禁止您向该LiveChannel进行推流操作。如果您正在向该LiveChannel推流，那么推流的客户端会被强制断开（会有10s左右的延迟）。'."\n" .'- 当没有客户端向该LiveChannel推流时，调用PutLiveChannelStatus重新创建LiveChannel也可以达到修改Status的目的。'."\n" .'- 当有客户端向该LiveChannel推流时，只能将LiveChannel的状态修改为disabled，无法调用PutLiveChannelStatus重新创建LiveChannel。', ], 'GetLiveChannelInfo' => [ 'summary' => '获取指定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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'exsmplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '频道名称。不能包含斜杠（/）。', 'type' => 'string', 'required' => true, 'example' => 'channel_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存GetLiveChannelInfo返回结果的响应体。', 'type' => 'object', 'properties' => [ 'LiveChannelConfiguration' => [ 'description' => '保存GetLiveChannelInfo返回结果的容器。', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => 'LiveChannel的描述信息。', 'type' => 'string', 'example' => 'test', ], 'Status' => [ 'description' => 'LiveChannel的状态信息。有效值：'."\n" ."\n" .'enabled：启用状态'."\n" ."\n" .'disabled：禁用状态', 'type' => 'string', 'example' => 'enabled', ], 'Target' => [ 'description' => '保存LiveChannel转储配置的容器。', '$ref' => '#/components/schemas/LiveChannelTarget', ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n test\\n enabled\\n \\n \\n 0\\n 0\\n \\n \\n","type":"xml"}]', 'title' => '获取直播推流的配置信息', ], 'GetLiveChannelHistory' => [ 'summary' => '获取指定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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => 'LiveChannel名称。', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存GetLiveChannelHistory返回结果的响应体。', 'type' => 'object', 'properties' => [ 'LiveChannelHistory' => [ 'description' => '保存GetLiveChannelHistory返回结果的容器。', 'type' => 'object', 'properties' => [ 'LiveRecord' => [ 'description' => '保存推流记录信息的列表。', 'type' => 'array', 'items' => [ 'description' => '保存一次推流记录信息的容器。', '$ref' => '#/components/schemas/LiveRecord', ], ], ], ], ], ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取直播推流的推流记录', 'description' => '使用GetLiveChannelHistory接口最多会返回指定LiveChannel最近的10次推流记录。', ], 'GetLiveChannelStat' => [ 'summary' => '获取指定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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => 'Livechannel名称。', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '保存GetLiveChannelStat返回结果的响应体。', 'type' => 'object', 'properties' => [ 'LiveChannelStat' => [ 'description' => '保存GetLiveChannelStat返回结果的容器。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'LiveChannel当前的推流状态描述。有效值：Disabled、Live、Idle。', 'type' => 'string', 'example' => 'Live', ], 'ConnectedTime' => [ 'description' => '当Status为Live时，表示当前客户端开始推流的时间。此元素使用ISO8601格式表示。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2016-08-25T06:25:15.000Z', ], 'RemoteAddr' => [ 'description' => '当Status为Live时，表示当前推流客户端的IP地址。', 'type' => 'string', 'example' => '10.1.2.3:47745', ], 'Video' => [ 'description' => '当Status为Live时，保存视频流信息的容器。'."\n" ."\n" .'>Video、Audio容器只有在Status为Live时才会返回，但Status为Live时不一定返回这两个容器。例如，客户端已经连接到LiveChannel，但尚未发送音视频数据，这种情况不会返回这两个容器。', '$ref' => '#/components/schemas/LiveChannelVideo', ], 'Audio' => [ 'description' => '当Status为Live时，保存音频流信息的容器。'."\n" ."\n" .'>Video、Audio容器只有在Status为Live时才会返回，但Status为Live时不一定返回这两个容器。例如，客户端已经连接到LiveChannel，但尚未发送音视频数据，这种情况不会返回这两个容器。', '$ref' => '#/components/schemas/LiveChannelAudio', ], ], ], ], ], ], '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' => '获取直播推流的推流状态信息', ], 'GetVodPlaylist' => [ 'summary' => '查看指定LiveChannel在指定时间段内推流生成的播放列表。', '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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '指定LiveChannel名称。该LiveChannel必须存在。', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', ], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => [ 'description' => '指定查询ts文件的终止时间，格式为Unix timestamp。'."\n" .'> EndTime必须大于 StartTime，且时间跨度不能大于1天。', 'type' => 'string', 'required' => true, 'example' => '1636618271', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => '指定查询ts文件的起始时间，格式为Unix timestamp。', 'type' => 'string', 'required' => true, 'example' => '1636600271', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '推流生成的播放列表。', 'type' => 'string', 'format' => 'binary', 'example' => '#EXTM3U'."\n" .'#EXT-X-VERSION:3'."\n" .'#EXT-X-MEDIA-SEQUENCE:0'."\n" .'#EXT-X-TARGETDURATION:13'."\n" .'#EXTINF:7.120,'."\n" .'1543895706266.ts'."\n" .'#EXTINF:5.840,'."\n" .'1543895706323.ts'."\n" .'#EXTINF:6.400,'."\n" .'1543895706356.ts'."\n" .'#EXTINF:5.520,'."\n" .'1543895706389.ts'."\n" .'#EXTINF:5.240,'."\n" .'1543895706428.ts'."\n" .'#EXTINF:13.320,'."\n" .'1543895706468.ts'."\n" .'#EXTINF:5.960,'."\n" .'1543895706538.ts'."\n" .'#EXTINF:6.520,'."\n" .'1543895706561.ts'."\n" .'#EXT-X-ENDLIST', ], ], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\"#EXTM3U\\\\n#EXT-X-VERSION:3\\\\n#EXT-X-MEDIA-SEQUENCE:0\\\\n#EXT-X-TARGETDURATION:13\\\\n#EXTINF:7.120,\\\\n1543895706266.ts\\\\n#EXTINF:5.840,\\\\n1543895706323.ts\\\\n#EXTINF:6.400,\\\\n1543895706356.ts\\\\n#EXTINF:5.520,\\\\n1543895706389.ts\\\\n#EXTINF:5.240,\\\\n1543895706428.ts\\\\n#EXTINF:13.320,\\\\n1543895706468.ts\\\\n#EXTINF:5.960,\\\\n1543895706538.ts\\\\n#EXTINF:6.520,\\\\n1543895706561.ts\\\\n#EXT-X-ENDLIST\\"","type":"json"}]', 'title' => '查看直播推流的播放列表', ], 'PostVodPlaylist' => [ 'summary' => '为指定的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' => 'Bucket名称。', 'type' => 'string', 'required' => true, 'example' => 'examplebucket', ], ], [ 'name' => 'channel', 'in' => 'path', 'schema' => [ 'description' => '指定LiveChannel名称，该LiveChannel必须存在。', 'type' => 'string', 'required' => true, 'example' => 'examplechannel', ], ], [ 'name' => 'playlist', 'in' => 'path', 'schema' => [ 'description' => '指定生成的点播播放列表的名称，必须以“.m3u8”结尾。', 'type' => 'string', 'required' => true, 'example' => 'playlist.m3u8', ], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => [ 'description' => '指定查询ts文件的终止时间。'."\n" .'格式：Unix timestamp'."\n" .'>EndTime必须大于StartTime，且时间跨度不能大于1天。', 'type' => 'string', 'required' => true, 'example' => '1636618271', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => '指定查询ts文件的起始时间，格式为Unix timestamp。', 'type' => 'string', 'required' => true, 'example' => '1636600271', ], ], ], 'responses' => [ 200 => [], '5XX' => [], ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '为直播推流生成点播的播放列表', 'description' => 'OSS会查询指定时间范围内由该LiveChannel推流生成的ts文件，并将其拼装为一个m3u8播放列表。', ], 'PutChannel' => [ 'summary' => '创建图片处理通道', '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' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '接口请求体', 'type' => 'object', 'properties' => [ 'Channel' => [ 'title' => '保存图片处理频道配置的容器', 'description' => '保存图片处理频道配置的容器', 'required' => false, '$ref' => '#/components/schemas/Channel', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '创建图片处理通道', ], 'PutBucketHash' => [ 'summary' => '修改存储空间哈希算法配置', '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' => '存储空间名称', 'type' => 'string', 'required' => true, ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体', 'description' => '接口请求体', 'type' => 'object', 'properties' => [ 'ObjectHashConfiguration' => [ 'title' => '对象哈希算法配置', 'description' => '对象哈希算法配置', 'required' => false, '$ref' => '#/components/schemas/ObjectHashConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间哈希算法配置', ], 'PutBucketCommonHeader' => [ 'summary' => '设置存储空间的用户自定义响应头配置', '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' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体', 'description' => '接口请求体', 'type' => 'object', 'properties' => [ 'CommonHeaders' => [ 'title' => '用户自定义响应头配置', 'description' => '用户自定义响应头配置', 'required' => false, '$ref' => '#/components/schemas/CommonHeaders', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '设置存储空间的用户自定义响应头配置', ], 'DeleteBucketCommonHeader' => [ 'summary' => '删除存储空间的用户自定义响应头配置', 'path' => '/?x-oss-common-header', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245751', 'abilityTreeNodes' => [ 'FEATUREossAI8VDR', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'description' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '删除存储空间的用户自定义响应头配置', ], 'PutProcessConfiguration' => [ 'summary' => '修改存储空间媒体处理配置', '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' => '存储空间名称', 'type' => 'string', 'required' => true, 'example' => 'test-bucket', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'description' => '请求结构体', 'type' => 'object', 'properties' => [ 'BucketProcessConfiguration' => [ 'title' => '存储空间图片处理配置', 'description' => '存储空间图片处理配置', 'required' => true, '$ref' => '#/components/schemas/BucketProcessConfiguration', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n","type":"xml"}]', 'title' => '修改存储空间媒体处理配置', ], 'GetBucketEventNotification' => [ 'summary' => '获取存储空间事件通知配置', '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' => '存储空间名称', 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NotificationConfiguration' => [ 'title' => '存储空间函数计算服务配置', 'description' => '存储空间函数计算服务配置', '$ref' => '#/components/schemas/EventNotificationConfiguration', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"\\n\\n \\n 1\\n ObjectCreated:PutObject\\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n","type":"xml"}]', 'title' => '获取存储空间事件通知配置', ], 'PutDataLakeCachePrefetchJob' => [ 'summary' => '配置OSS加速器异步预热规则', 'path' => '/?x-oss-datalake-cache-prefetch-job', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '246257', 'abilityTreeNodes' => [ 'FEATUREossRGUKNQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称'."\n", 'type' => 'string', 'required' => true, ], ], [ 'name' => 'x-oss-datalake-job-id', 'in' => 'query', 'schema' => [ 'title' => '加速器预热任务ID', 'type' => 'string', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'xml', 'schema' => [ 'title' => '接口请求体', 'type' => 'object', 'properties' => [ 'CreateDataLakeCachePrefetchJob' => [ 'title' => '加速器预热任务配置信息', '$ref' => '#/components/schemas/CreateDataLakeCachePrefetchJob', ], ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'DataLakeCachePrefetchJobID' => [ 'type' => 'object', 'properties' => [ 'ID' => [ 'title' => '加速器异步预热任务ID', 'type' => 'string', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], ], 'StartDataLakeCachePrefetchJob' => [ 'summary' => '启动OSS加速器异步预热任务', 'path' => '/?x-oss-datalake-cache-prefetch-job&x-oss-datalake-job-start', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '246318', 'abilityTreeNodes' => [ 'FEATUREossRGUKNQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'type' => 'string', 'required' => true, ], ], [ 'name' => 'x-oss-datalake-job-id', 'in' => 'query', 'schema' => [ 'title' => '加速器异步预热配置ID', 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'ListDataLakeStorageTransferJob' => [ 'summary' => '列举数据湖元数据转换任务', 'path' => '/?x-oss-datalake-storage-transfer-job', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/xml', ], 'produces' => [ 'application/xml', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '253259', 'abilityTreeNodes' => [ 'FEATUREoss05MSD2', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'bucket', 'in' => 'host', 'schema' => [ 'title' => '存储空间名称', 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口响应内容', 'type' => 'object', 'properties' => [ 'DataLakeStorageTransferJobs' => [ '$ref' => '#/components/schemas/DataLakeStorageTransferJobs', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], ], ], 'endpoints' => [ [ 'regionId' => 'cn-wuhan-lr', 'endpoint' => 'oss-cn-wuhan-lr.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao', 'endpoint' => 'oss-cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'oss-cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'oss-cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'oss-cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'oss-cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'oss-cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'oss-cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-nanjing', 'endpoint' => 'oss-cn-nanjing.aliyuncs.com', ], [ 'regionId' => 'cn-fuzhou', 'endpoint' => 'oss-cn-fuzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'oss-cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan', 'endpoint' => 'oss-cn-heyuan.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'oss-cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'oss-cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'oss-cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'oss-ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2', 'endpoint' => 'oss-ap-northeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'oss-ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'oss-ap-southeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'oss-ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'oss-ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-6', 'endpoint' => 'oss-ap-southeast-6.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'oss-us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'oss-us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'oss-eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'oss-eu-central-1.aliyuncs.com', ], [ 'regionId' => 'ap-south-1', 'endpoint' => 'oss-ap-south-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'oss-me-east-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'oss-cn-hzjbp-b-console.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'oss-cn-shanghai-finance-1-internal.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'oss-cn-shenzhen-finance-1-internal.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-7', 'endpoint' => 'oss-ap-southeast-7.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'oss-cn-beijing-finance-1-internal.aliyuncs.com', ], ], ];