Alibaba Cloud Object Storage Service

https://help.aliyun.com/zh/oss/developer-reference
Admin
Alibaba Cloud OSS is a scalable, secure, and cost-effective cloud object storage service that...
Tokens:44,263
Snippets:293
Trust Score:10
Update:5 days ago
Show doc for...
Tokens:
Raw
### AbortMultipartUpload Response Example

Source: https://help.aliyun.com/zh/oss/developer-reference/abortmultipartupload

An example of the HTTP response received after successfully aborting a multipart upload task.

```HTTP
HTTP/1.1 204 
Server: AliyunOSS
Content-length: 0
Connection: keep-alive
x-oss-request-id: 059a22ba-6ba9-daed-5f3a-e48027df****
Date: Wed, 22 Feb 2012 08:32:21 GMT
x-oss-server-time: 86
```

--------------------------------

### GetLiveChannelInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the configuration information of a LiveChannel.

```APIDOC
## GetLiveChannelInfo

### Description
Gets the configuration information of a LiveChannel.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetVodPlaylist

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the playback list.

```APIDOC
## GetVodPlaylist

### Description
Gets the playback list.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### AbortMultipartUpload Request Example

Source: https://help.aliyun.com/zh/oss/developer-reference/abortmultipartupload

An example of the HTTP request to abort a multipart upload task.

```HTTP
Delete /multipart.data?&uploadId=0004B9895DBBB6E****  HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Wed, 22 Feb 2012 08:32:21 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
```

--------------------------------

### GetBucketLifecycle

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets lifecycle rules for objects in a bucket.

```APIDOC
## GetBucketLifecycle

### Description
Gets lifecycle rules for objects in a bucket.

### Method
GET

### Endpoint
/{bucket}?lifecycle

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **lifecycle** (string) - Required - Indicates this operation gets lifecycle rules.

### Response
#### Success Response (200)
- **LifecycleConfiguration** (object) - Contains lifecycle rules.

#### Response Example
{
  "LifecycleConfiguration": {
    "Rule": [
      {
        "ID": "rule-id",
        "Prefix": "logs/",
        "Status": "Enabled",
        "Expiration": {
          "Days": 30
        }
      }
    ]
  }
}
```

--------------------------------

### InitBucketAntiDDosInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Initializes Bucket protection.

```APIDOC
## InitBucketAntiDDosInfo

### Description
Initializes Bucket protection.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### InitUserAntiDDosInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a high-defense OSS instance.

```APIDOC
## InitUserAntiDDosInfo

### Description
Creates a high-defense OSS instance.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### PutBucket 请求示例

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

构造并发送创建存储空间（PutBucket）的 HTTP 请求，包含请求头（Host、Date、x-oss-acl、Authorization）和请求体（CreateBucketConfiguration）。

```bash
PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
    <StorageClass>Standard</StorageClass>
    <DataRedundancyType>LRS</DataRedundancyType>    
</CreateBucketConfiguration>
```

--------------------------------

### PutBucket

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a bucket.

```APIDOC
## PutBucket

### Description
Creates a bucket.

### Method
PUT

### Endpoint
/{bucket}

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket to create.

#### Request Body
- **CreateBucketConfiguration** (object) - Optional - Contains bucket configuration, such as storage class.

### Request Example
{
  "CreateBucketConfiguration": {
    "StorageClass": "Standard"
  }
}

### Response
#### Success Response (200)
- **Location** (string) - The endpoint of the created bucket.

#### Response Example
{
  "Location": "/bucket-name"
}
```

--------------------------------

### GetBucketInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets bucket information.

```APIDOC
## GetBucketInfo

### Description
Gets bucket information.

### Method
GET

### Endpoint
/{bucket}?bucketInfo

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **bucketInfo** (string) - Required - Indicates this operation gets bucket info.

### Response
#### Success Response (200)
- **BucketInfo** (object) - Contains bucket details.

#### Response Example
{
  "BucketInfo": {
    "Bucket": {
      "Name": "bucket-name",
      "Location": "oss-cn-hangzhou",
      "CreationDate": "2023-01-01T00:00:00.000Z",
      "StorageClass": "Standard"
    }
  }
}
```

--------------------------------

### PutBucket 成功响应示例

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

请求成功时服务器返回的 HTTP 响应，包含状态码 200 OK 和响应头（x-oss-request-id、Date、Content-Length、Connection、Server、Location）。

```xml
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Fri, 24 Feb 2017 03:15:40 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
Location: /oss-example
```

--------------------------------

### PutBucketDataAccelerator

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates an OSS Accelerator or modifies its configuration.

```APIDOC
## [PUT] PutBucketDataAccelerator

### Description
Creates an OSS Accelerator or modifies its configuration.

### Method
PUT

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### GetBucketVersioning

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the versioning state of a bucket.

```APIDOC
## GetBucketVersioning

### Description
Gets the versioning state of a bucket.

### Method
GET

### Endpoint
/{bucket}?versioning

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **versioning** (string) - Required - Indicates this operation gets versioning.

### Response
#### Success Response (200)
- **VersioningConfiguration** (object) - Contains the status.

#### Response Example
{
  "VersioningConfiguration": {
    "Status": "Enabled"
  }
}
```

--------------------------------

### PutLiveChannel

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a LiveChannel.

```APIDOC
## PutLiveChannel

### Description
Creates a LiveChannel.

### Method
PUT

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetBucketLocation

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the location information of a bucket.

```APIDOC
## GetBucketLocation

### Description
Gets the location information of a bucket.

### Method
GET

### Endpoint
/{bucket}?location

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **location** (string) - Required - Indicates this operation gets bucket location.

### Response
#### Success Response (200)
- **LocationConstraint** (string) - The region where the bucket resides.

#### Response Example
{
  "LocationConstraint": "oss-cn-hangzhou"
}
```

--------------------------------

### CreateAccessPoint

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates an access point.

```APIDOC
## CreateAccessPoint

### Description
Creates an access point.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetLiveChannelHistory

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the push stream records of a LiveChannel.

```APIDOC
## GetLiveChannelHistory

### Description
Gets the push stream records of a LiveChannel.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetBucketTransferAcceleration

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the transfer acceleration configuration of a bucket.

```APIDOC
## GetBucketTransferAcceleration

### Description
Gets the transfer acceleration configuration of a bucket.

### Method
GET

### Endpoint
/{bucket}?transferAcceleration

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **transferAcceleration** (string) - Required - Indicates this operation gets transfer acceleration.

### Response
#### Success Response (200)
- **TransferAccelerationConfiguration** (object) - Contains the enabled status.

#### Response Example
{
  "TransferAccelerationConfiguration": {
    "Enabled": true
  }
}
```

--------------------------------

### CreateAccessPointForObjectProcess

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates an Object FC access point.

```APIDOC
## CreateAccessPointForObjectProcess

### Description
Creates an Object FC access point.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### ListObjects (GetBucket)

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists all objects (files) in a bucket.

```APIDOC
## ListObjects (GetBucket)

### Description
Lists all objects (files) in a bucket.

### Method
GET

### Endpoint
/{bucket}

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **prefix** (string) - Optional - Limits the response to keys that begin with the specified prefix.
- **marker** (string) - Optional - Specifies the key to start with when listing objects.
- **max-keys** (integer) - Optional - Sets the maximum number of keys returned in the response.
- **delimiter** (string) - Optional - Groups keys by a delimiter.

### Response
#### Success Response (200)
- **ListBucketResult** (object) - Contains the list of objects.

#### Response Example
{
  "ListBucketResult": {
    "Name": "bucket-name",
    "Prefix": "",
    "Marker": "",
    "MaxKeys": 1000,
    "IsTruncated": false,
    "Contents": [
      {
        "Key": "object-key",
        "LastModified": "2023-01-01T00:00:00.000Z",
        "ETag": "etag-value",
        "Size": 1024,
        "StorageClass": "Standard"
      }
    ]
  }
}
```

--------------------------------

### PutBucketWebsite

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Sets the bucket to static website hosting mode.

```APIDOC
## PutBucketWebsite

### Description
Sets the bucket to static website hosting mode.

### Method
PUT

### Endpoint
/Bucket?website

### Parameters
#### Request Body
- **WebsiteConfiguration** (object) - Required - The static website configuration.

### Response
#### Success Response (200)
- **ETag** (string) - The ETag of the response.

#### Response Example
```
HTTP/1.1 200 OK
x-oss-request-id: 559CC9BDC755F95A64485981
ETag: "B0E8D1D4B5F8C7A3"
```
```

--------------------------------

### GetLiveChannelStat

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the push stream status information of a LiveChannel.

```APIDOC
## GetLiveChannelStat

### Description
Gets the push stream status information of a LiveChannel.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### Options

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Handles preflight requests from browsers before cross-origin requests.

```APIDOC
## Options

### Description
Handles preflight requests from browsers before cross-origin requests.

### Method
OPTIONS

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetBucketAcl

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the access control list (ACL) of a bucket.

```APIDOC
## GetBucketAcl

### Description
Gets the access control list (ACL) of a bucket.

### Method
GET

### Endpoint
/{bucket}?acl

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **acl** (string) - Required - Indicates this operation gets ACL.

### Response
#### Success Response (200)
- **AccessControlPolicy** (object) - Contains ACL information.

#### Response Example
{
  "AccessControlPolicy": {
    "Owner": {
      "ID": "owner-id",
      "DisplayName": "owner-name"
    },
    "AccessControlList": {
      "Grant": "private"
    }
  }
}
```

--------------------------------

### GetBucketWorm

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the compliance retention policy information of a bucket.

```APIDOC
## GetBucketWorm

### Description
Gets the compliance retention policy information of a bucket.

### Method
GET

### Endpoint
/{bucket}?worm

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **worm** (string) - Required - Indicates this operation gets WORM policy.

### Response
#### Success Response (200)
- **WormConfiguration** (object) - Contains WORM policy details.

#### Response Example
{
  "WormConfiguration": {
    "WormId": "worm-id",
    "State": "Locked",
    "RetentionPeriodInDays": 365,
    "CreationDate": "2023-01-01T00:00:00.000Z"
  }
}
```

--------------------------------

### GetBucketQoSInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

获取资源池内某个Bucket的流控配置。

```APIDOC
## GetBucketQoSInfo

### Description
获取资源池内某个Bucket的流控配置。

### Method
GET

### Endpoint
/getBucketQoSInfo

### Parameters
#### Query Parameters
- **Bucket** (string) - Required - 目标Bucket名称。

### Request Example
GET /getBucketQoSInfo?Bucket=example-bucket

### Response
#### Success Response (200)
- **Bucket** (string) - Bucket名称。
- **QoSInfo** (object) - 流控配置信息。

#### Response Example
{
  "Bucket": "example-bucket",
  "QoSInfo": {
    "TotalUploadBandwidth": 100,
    "TotalDownloadBandwidth": 200
  }
}
```

--------------------------------

### GetBucketStat

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the storage capacity and object count of a bucket.

```APIDOC
## GetBucketStat

### Description
Gets the storage capacity and object count of a bucket.

### Method
GET

### Endpoint
/{bucket}?stat

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **stat** (string) - Required - Indicates this operation gets bucket statistics.

### Response
#### Success Response (200)
- **BucketStat** (object) - Contains storage statistics.

#### Response Example
{
  "BucketStat": {
    "Storage": 1024,
    "ObjectCount": 10
  }
}
```

--------------------------------

### ListBucketInventory

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists all inventory tasks in a bucket.

```APIDOC
## ListBucketInventory

### Description
Lists all inventory tasks in a bucket.

### Method
GET

### Endpoint
/Bucket?inventory

### Parameters
#### Path Parameters
- **Bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **continuation-token** (string) - Optional - The continuation token for pagination.

### Response
#### Success Response (200)
- **InventoryConfigurations** (list) - The list of inventory configurations.

#### Response Example
```
HTTP/1.1 200 OK
x-oss-request-id: 559CC9BDC755F95A64485981
<?xml version="1.0" encoding="UTF-8"?>
<ListInventoryConfigurationsResult>
  <InventoryConfiguration>
    <Id>report1</Id>
    <IsEnabled>true</IsEnabled>
  </InventoryConfiguration>
  <IsTruncated>false</IsTruncated>
</ListInventoryConfigurationsResult>
```
```

--------------------------------

### CreateSelectObjectMeta

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Gets the total number of rows, columns (for CSV files), and splits of a target file.

```APIDOC
## [POST] CreateSelectObjectMeta

### Description
Gets the total number of rows, columns (for CSV files), and splits of a target file.

### Method
POST

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### ListStyle

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists all image styles created under a Bucket.

```APIDOC
## ListStyle

### Description
Lists all image styles created under a Bucket.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### AbortBucketWorm Request and Response

Source: https://help.aliyun.com/zh/oss/developer-reference/abortbucketworm

Example of an HTTP DELETE request to remove a compliance retention policy and the corresponding 204 No Content response.

```HTTP
DELETE /?worm HTTP/1.1
Date: Mon, 3 Aug 2020 03:15:40 GMT
Host: BucketName.oss.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
```

```HTTP
HTTP/1.1 204 NoContent
Server: AliyunOSS
Date: Tue, 22 Aug 2023 09:10:20 GMT
Content-Length: 0
Connection: keep-alive
x-oss-request-id: 5C06A3B67B8B5A3DA422299D
x-oss-server-time: 130
```

--------------------------------

### InitiateMultipartUpload

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Initializes a multipart upload event.

```APIDOC
## [POST] InitiateMultipartUpload

### Description
Initializes a multipart upload event.

### Method
POST

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### CreateBucketDataRedundancyTransition

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a storage redundancy transition task.

```APIDOC
## CreateBucketDataRedundancyTransition

### Description
Creates a storage redundancy transition task.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetBucketDataAccelerator

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Queries information about an OSS Accelerator.

```APIDOC
## [GET] GetBucketDataAccelerator

### Description
Queries information about an OSS Accelerator.

### Method
GET

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### PutBucketQoSInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

为资源池内的Bucket设置流控。

```APIDOC
## PutBucketQoSInfo

### Description
为资源池内的Bucket设置流控。

### Method
PUT

### Endpoint
/putBucketQoSInfo

### Parameters
#### Request Body
- **Bucket** (string) - Required - 目标Bucket名称。
- **QoSInfo** (object) - Required - 流控配置信息。

### Request Example
{
  "Bucket": "example-bucket",
  "QoSInfo": {
    "TotalUploadBandwidth": 100,
    "TotalDownloadBandwidth": 200
  }
}

### Response
#### Success Response (200)
- **RequestId** (string) - 请求ID。

#### Response Example
{
  "RequestId": "5C1C1A7B-7D6A-4E5F-9C3A-2B2C2D2E2F2G"
}
```

--------------------------------

### DELETE /?qosInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/api-delete-bucket-qos-info

删除资源池内指定Bucket的流控配置。该接口仅涉及公共请求头和公共响应头。

```APIDOC
## DELETE /?qosInfo

### Description
删除资源池内指定Bucket的流控配置。

### Method
DELETE

### Endpoint
/?qosInfo

### Parameters
#### Path Parameters
- 无

#### Query Parameters
- 无

#### Request Body
- 无

### Request Example
```
DELETE /?qosInfo HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com  
Date: Fri, 27 Dec 2024 03:21:12 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
```

### Response
#### Success Response (200)
- 无响应体

#### Response Example
```
HTTP/1.1 200 OK
Date: Fri, 27 Dec 2024 03:21:12 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 534****
```

```

--------------------------------

### ListObjectVersions (GetBucketVersions)

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists version information for all objects in a bucket.

```APIDOC
## ListObjectVersions (GetBucketVersions)

### Description
Lists version information for all objects in a bucket.

### Method
GET

### Endpoint
/{bucket}?versions

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **versions** (string) - Required - Indicates this operation lists object versions.
- **prefix** (string) - Optional - Limits the response to keys that begin with the specified prefix.
- **key-marker** (string) - Optional - Specifies the key to start with when listing versions.
- **max-keys** (integer) - Optional - Sets the maximum number of keys returned.
- **delimiter** (string) - Optional - Groups keys by a delimiter.

### Response
#### Success Response (200)
- **ListVersionsResult** (object) - Contains the list of object versions.

#### Response Example
{
  "ListVersionsResult": {
    "Name": "bucket-name",
    "Prefix": "",
    "KeyMarker": "",
    "MaxKeys": 1000,
    "IsTruncated": false,
    "Version": [
      {
        "Key": "object-key",
        "VersionId": "version-id",
        "IsLatest": true,
        "LastModified": "2023-01-01T00:00:00.000Z",
        "ETag": "etag-value",
        "Size": 1024,
        "StorageClass": "Standard"
      }
    ]
  }
}
```

--------------------------------

### PostVodPlaylist

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Generates a playback list.

```APIDOC
## PostVodPlaylist

### Description
Generates a playback list.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### ListBuckets (GetService)

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Returns all storage buckets (Bucket) owned by the requester.

```APIDOC
## ListBuckets (GetService)

### Description
Returns all storage buckets (Bucket) owned by the requester.

### Method
GET

### Endpoint
/ (with query parameter?service)

### Parameters
#### Query Parameters
- **service** (string) - Required - Indicates this is a ListBuckets operation.

### Response
#### Success Response (200)
- **ListAllMyBucketsResult** (object) - Contains the list of buckets.

#### Response Example
{
  "ListAllMyBucketsResult": {
    "Owner": {
      "ID": "owner-id",
      "DisplayName": "owner-name"
    },
    "Buckets": {
      "Bucket": [
        {
          "Name": "bucket-name",
          "Location": "oss-cn-hangzhou",
          "CreationDate": "2023-01-01T00:00:00.000Z"
        }
      ]
    }
  }
}
```

--------------------------------

### ListObjectsV2 (GetBucketV2)

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists objects in a bucket using the V2 API.

```APIDOC
## ListObjectsV2 (GetBucketV2)

### Description
Lists objects in a bucket using the V2 API.

### Method
GET

### Endpoint
/{bucket}?list-type=2

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **list-type** (integer) - Required - Must be 2 to indicate V2 listing.
- **continuation-token** (string) - Optional - Specifies the continuation token for pagination.
- **prefix** (string) - Optional - Limits the response to keys that begin with the specified prefix.
- **max-keys** (integer) - Optional - Sets the maximum number of keys returned.
- **delimiter** (string) - Optional - Groups keys by a delimiter.

### Response
#### Success Response (200)
- **ListBucketResult** (object) - Contains the list of objects.

#### Response Example
{
  "ListBucketResult": {
    "Name": "bucket-name",
    "Prefix": "",
    "MaxKeys": 1000,
    "IsTruncated": false,
    "Contents": [
      {
        "Key": "object-key",
        "LastModified": "2023-01-01T00:00:00.000Z",
        "ETag": "etag-value",
        "Size": 1024,
        "StorageClass": "Standard"
      }
    ]
  }
}
```

--------------------------------

### InitiateBucketWorm

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a new compliance retention policy (WORM).

```APIDOC
## InitiateBucketWorm

### Description
Creates a new compliance retention policy (WORM).

### Method
POST

### Endpoint
/{bucket}?worm

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **worm** (string) - Required - Indicates this operation initiates a WORM policy.

#### Request Body
- **InitiateBucketWormConfiguration** (object) - Required - Contains the retention period in days.

### Request Example
{
  "InitiateBucketWormConfiguration": {
    "RetentionPeriodInDays": 365
  }
}

### Response
#### Success Response (200)
- **WormId** (string) - The ID of the created WORM policy.

#### Response Example
{
  "WormId": "worm-id"
}
```

--------------------------------

### PutCname

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Binds a CNAME to a Bucket.

```APIDOC
## PutCname

### Description
Binds a CNAME to a Bucket.

### Method
PUT

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### PutBucketRequesterQoSInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

设置请求者在Bucket级别的流控。

```APIDOC
## PutBucketRequesterQoSInfo

### Description
设置请求者在Bucket级别的流控。

### Method
PUT

### Endpoint
/putBucketRequesterQoSInfo

### Parameters
#### Request Body
- **Bucket** (string) - Required - 目标Bucket名称。
- **Requester** (string) - Required - 请求者标识。
- **QoSInfo** (object) - Required - 流控配置信息。

### Request Example
{
  "Bucket": "example-bucket",
  "Requester": "user1",
  "QoSInfo": {
    "TotalUploadBandwidth": 50,
    "TotalDownloadBandwidth": 100
  }
}

### Response
#### Success Response (200)
- **RequestId** (string) - 请求ID。

#### Response Example
{
  "RequestId": "5C1C1A7B-7D6A-4E5F-9C3A-2B2C2D2E2F2G"
}
```

--------------------------------

### GetAccessPointConfigForObjectProcess

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Retrieves the configuration information of an Object FC access point.

```APIDOC
## GetAccessPointConfigForObjectProcess

### Description
Retrieves the configuration information of an Object FC access point.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### PUT /

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

创建存储空间（PutBucket）的 API 调用示例，展示请求构造、签名认证和响应处理。

```APIDOC
## [PUT] /

### Description
创建存储空间（PutBucket）的 API 调用示例，展示请求构造、签名认证和响应处理。

### Method
PUT

### Endpoint
/

### Parameters
#### Request Body
- **StorageClass** (string) - Required - 存储空间存储类型，示例为 Standard。
- **DataRedundancyType** (string) - Required - 数据冗余类型，示例为 LRS。

### Request Example
```
PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
    <StorageClass>Standard</StorageClass>
    <DataRedundancyType>LRS</DataRedundancyType>    
</CreateBucketConfiguration>
```

### Response
#### Success Response (200)
- **x-oss-request-id** (string) - 请求唯一标识。
- **Date** (string) - 响应时间。
- **Content-Length** (integer) - 响应体长度。
- **Connection** (string) - 连接状态。
- **Server** (string) - 服务器标识。
- **Location** (string) - 存储空间位置。

#### Response Example
```
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Fri, 24 Feb 2017 03:15:40 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
Location: /oss-example
```

### Error Handling
请求失败时，服务器会返回 4xx 或 5xx 状态码。响应体为 XML 格式，包含错误码（Code）和错误信息（Message）。
```

--------------------------------

### DeleteBucketQosInfo 请求语法

Source: https://help.aliyun.com/zh/oss/developer-reference/api-delete-bucket-qos-info

使用DELETE请求删除指定Bucket的流控配置。请求语法中Host需替换为实际的Bucket名称和地域。

```http
DELETE /?qosInfo HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
```

--------------------------------

### ListBucketRequesterQoSInfos

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

获取所有请求者在Bucket级别的流控配置。

```APIDOC
## ListBucketRequesterQoSInfos

### Description
获取所有请求者在Bucket级别的流控配置。

### Method
GET

### Endpoint
/listBucketRequesterQoSInfos

### Parameters
#### Query Parameters
- **Bucket** (string) - Required - 目标Bucket名称。

### Request Example
GET /listBucketRequesterQoSInfos?Bucket=example-bucket

### Response
#### Success Response (200)
- **RequesterQoSInfos** (array) - 请求者流控配置列表。
  - **Requester** (string) - 请求者标识。
  - **QoSInfo** (object) - 流控配置信息。

#### Response Example
{
  "RequesterQoSInfos": [
    {
      "Requester": "user1",
      "QoSInfo": {
        "TotalUploadBandwidth": 50,
        "TotalDownloadBandwidth": 100
      }
    },
    {
      "Requester": "user2",
      "QoSInfo": {
        "TotalUploadBandwidth": 30,
        "TotalDownloadBandwidth": 60
      }
    }
  ]
}
```

--------------------------------

### ListBucketDataRedundancyTransition

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists all storage redundancy transition tasks under a specific Bucket.

```APIDOC
## ListBucketDataRedundancyTransition

### Description
Lists all storage redundancy transition tasks under a specific Bucket.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### ListResourcePoolBucketGroupQoSInfos

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

列举资源池中BucketGroup的流控配置。

```APIDOC
## ListResourcePoolBucketGroupQoSInfos

### Description
列举资源池中BucketGroup的流控配置。

### Method
GET

### Endpoint
/listResourcePoolBucketGroupQoSInfos

### Parameters
#### Query Parameters
- **ResourcePoolId** (string) - Required - 资源池ID。

### Request Example
GET /listResourcePoolBucketGroupQoSInfos?ResourcePoolId=rp-12345

### Response
#### Success Response (200)
- **BucketGroupQoSInfos** (array) - BucketGroup流控配置列表。
  - **BucketGroup** (string) - BucketGroup名称。
  - **QoSInfo** (object) - 流控配置信息。

#### Response Example
{
  "BucketGroupQoSInfos": [
    {
      "BucketGroup": "group1",
      "QoSInfo": {
        "TotalUploadBandwidth": 500,
        "TotalDownloadBandwidth": 1000
      }
    },
    {
      "BucketGroup": "group2",
      "QoSInfo": {
        "TotalUploadBandwidth": 300,
        "TotalDownloadBandwidth": 600
      }
    }
  ]
}
```

--------------------------------

### ListLiveChannel

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Lists LiveChannels.

```APIDOC
## ListLiveChannel

### Description
Lists LiveChannels.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### SelectObject

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Executes an SQL statement on a target file and returns the result.

```APIDOC
## [POST] SelectObject

### Description
Executes an SQL statement on a target file and returns the result.

### Method
POST

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### OpenMetaQuery

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Enables metadata management for a Bucket.

```APIDOC
## OpenMetaQuery

### Description
Enables metadata management for a Bucket.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### GetBucketWebsite

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Retrieves the static website hosting status of a bucket.

```APIDOC
## GetBucketWebsite

### Description
Retrieves the static website hosting status of a bucket.

### Method
GET

### Endpoint
/Bucket?website

### Parameters
#### Path Parameters
- **Bucket** (string) - Required - The name of the bucket.

### Response
#### Success Response (200)
- **WebsiteConfiguration** (object) - The static website configuration.

#### Response Example
```
HTTP/1.1 200 OK
x-oss-request-id: 559CC9BDC755F95A64485981
<?xml version="1.0" encoding="UTF-8"?>
<WebsiteConfiguration>
  <IndexDocument>
    <Suffix>index.html</Suffix>
  </IndexDocument>
  <ErrorDocument>
    <Key>error.html</Key>
  </ErrorDocument>
</WebsiteConfiguration>
```
```

--------------------------------

### ListResourcePoolBuckets

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

获取指定资源池包含的Bucket列表。

```APIDOC
## ListResourcePoolBuckets

### Description
获取指定资源池包含的Bucket列表。

### Method
GET

### Endpoint
/listResourcePoolBuckets

### Parameters
#### Query Parameters
- **ResourcePoolId** (string) - Required - 资源池ID。

### Request Example
GET /listResourcePoolBuckets?ResourcePoolId=rp-12345

### Response
#### Success Response (200)
- **Buckets** (array) - Bucket列表。
  - **Bucket** (string) - Bucket名称。

#### Response Example
{
  "Buckets": ["bucket1", "bucket2"]
}
```

--------------------------------

### GetBucketRequesterQoSInfo

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

获取指定请求者在Bucket级别的流控配置。

```APIDOC
## GetBucketRequesterQoSInfo

### Description
获取指定请求者在Bucket级别的流控配置。

### Method
GET

### Endpoint
/getBucketRequesterQoSInfo

### Parameters
#### Query Parameters
- **Bucket** (string) - Required - 目标Bucket名称。
- **Requester** (string) - Required - 请求者标识。

### Request Example
GET /getBucketRequesterQoSInfo?Bucket=example-bucket&Requester=user1

### Response
#### Success Response (200)
- **Bucket** (string) - Bucket名称。
- **Requester** (string) - 请求者标识。
- **QoSInfo** (object) - 流控配置信息。

#### Response Example
{
  "Bucket": "example-bucket",
  "Requester": "user1",
  "QoSInfo": {
    "TotalUploadBandwidth": 50,
    "TotalDownloadBandwidth": 100
  }
}
```

--------------------------------

### GetObject

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Retrieves an object from OSS.

```APIDOC
## [GET] GetObject

### Description
Retrieves an object from OSS.

### Method
GET

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### ListResourcePoolRequesterQoSInfos

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

获取所有请求者在资源池的流控配置。

```APIDOC
## ListResourcePoolRequesterQoSInfos

### Description
获取所有请求者在资源池的流控配置。

### Method
GET

### Endpoint
/listResourcePoolRequesterQoSInfos

### Parameters
#### Query Parameters
- **ResourcePoolId** (string) - Required - 资源池ID。

### Request Example
GET /listResourcePoolRequesterQoSInfos?ResourcePoolId=rp-12345

### Response
#### Success Response (200)
- **RequesterQoSInfos** (array) - 请求者流控配置列表。
  - **Requester** (string) - 请求者标识。
  - **QoSInfo** (object) - 流控配置信息。

#### Response Example
{
  "RequesterQoSInfos": [
    {
      "Requester": "user1",
      "QoSInfo": {
        "TotalUploadBandwidth": 100,
        "TotalDownloadBandwidth": 200
      }
    },
    {
      "Requester": "user2",
      "QoSInfo": {
        "TotalUploadBandwidth": 50,
        "TotalDownloadBandwidth": 100
      }
    }
  ]
}
```

--------------------------------

### PutStyle

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Adds an image style to a Bucket.

```APIDOC
## PutStyle

### Description
Adds an image style to a Bucket.

### Method
PUT

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### Callback

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Performs a callback by including a Callback parameter in the request to OSS.

```APIDOC
## [POST] Callback

### Description
Performs a callback by including a Callback parameter in the request to OSS.

### Method
POST

### Endpoint
Not specified in the source.

### Parameters
No parameters are specified in the source.

### Request Example
No request example is provided in the source.

### Response
No response details are provided in the source.
```

--------------------------------

### CreateCnameToken

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Creates a CnameToken for domain ownership verification.

```APIDOC
## CreateCnameToken

### Description
Creates a CnameToken for domain ownership verification.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```

--------------------------------

### PutBucketVersioning

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Sets the versioning state of a bucket.

```APIDOC
## PutBucketVersioning

### Description
Sets the versioning state of a bucket.

### Method
PUT

### Endpoint
/{bucket}?versioning

### Parameters
#### Path Parameters
- **bucket** (string) - Required - The name of the bucket.

#### Query Parameters
- **versioning** (string) - Required - Indicates this operation sets versioning.

#### Request Body
- **VersioningConfiguration** (object) - Required - Contains the status (Enabled or Suspended).

### Request Example
{
  "VersioningConfiguration": {
    "Status": "Enabled"
  }
}

### Response
#### Success Response (200)
No content returned.
```

--------------------------------

### ListAccessPointsForObjectProcess

Source: https://help.aliyun.com/zh/oss/developer-reference/list-of-operations-by-function

Retrieves user-level Object FC access point information.

```APIDOC
## ListAccessPointsForObjectProcess

### Description
Retrieves user-level Object FC access point information.

### Method
GET

### Endpoint
Not specified in source.

### Parameters
Not specified in source.

### Request Example
Not specified in source.

### Response
Not specified in source.
```
Tokens:
Raw