# Retrieve Bucket Information - DescribeBucket

## Overview

Get the description information of the Bucket

 > 💡 Note: If the parameter BucketName is provided, the parameters Offset and Limit will be invalid.




## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeBucket`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | If this parameter is provided, the names of all spaces in the corresponding region will be obtained (only the space name information is returned). |No|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **BucketName** | string | The name of the bucket to be obtained, if not provided, all buckets will be obtained. |No|
| **Offset** | int | The offset number for obtaining all Bucket lists, default is 0 |No|
| **Limit** | int | The limit for retrieving all Bucket lists, default is 20 |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **DataSet** | array[[*UFileBucketSet*](#ufilebucketset)] | Description information of the Bucket, see parameters in UFileBucketSet |No|

#### Data Model


#### UFileBucketSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region of the Bucket |No|
| **StorageClass** | string | Default Storage Type |No|
| **BucketName** | string | Bucket Name |No|
| **BucketId** | string | Bucket's ID |No|
| **Domain** | [*UFileDomainSet*](#ufiledomainset) | Collection of Bucket's domain names, see UFileDomainSet for parameters |No|
| **CdnDomainId** | array[string] | The ID list of the CND acceleration domain names associated with the Bucket |No|
| **Type** | string | Bucket Access Type |No|
| **CreateTime** | int | Creation time of the Bucket |No|
| **ModifyTime** | int | Modification time of the Bucket |No|
| **Biz** | string | Bucket's business ownership, general or vod or udb general: general business; vod: video cloud business; udb: cloud database business |No|
| **Tag** | string | Affiliated Business Group |No|
| **HasUserDomain** | int | Whether a custom domain exists. 0 does not exist, 1 exists, 2 error |No|

#### UFileDomainSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Src** | array[string] | Source Domain |No|
| **Cdn** | array[string] | UCDN Accelerated Domain |No|
| **CustomSrc** | array[string] | User-defined origin domain name |No|
| **CustomCdn** | array[string] | User-defined CDN acceleration domain name |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeBucket
&BucketName=blue
&Region=cxqbTMaU
```

### Response Example
    
```json
{
  "Aciton": "DescribeBucketResponse",
  "DataSet": [
    {
      "Biz": "general",
      "BucketId": "ufile-xxx",
      "BucketName": "blue",
      "CdnDomainId": [
        "ucdn-xxx"
      ],
      "CreateTime": 1409736300,
      "Domain": {
        "Cdn": [
          "blue.ufile.ucloud.com.cn"
        ],
        "CustomCdn": [],
        "CustomSrc": [],
        "Src": [
          "blue.ufile.ucloud.cn"
        ]
      },
      "HasUserDomain": 1,
      "ModifyTime": 1409736300,
      "Region": "cn-bj2",
      "Tag": "dddd",
      "Type": "public"
    }
  ],
  "Retcode": 0
}
```