Docs
api
Object-based Storage(US3)
DescribeBucket

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 NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeBucket.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringIf this parameter is provided, the names of all spaces in the corresponding region will be obtained (only the space name information is returned).No
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
BucketNamestringThe name of the bucket to be obtained, if not provided, all buckets will be obtained.No
OffsetintThe offset number for obtaining all Bucket lists, default is 0No
LimitintThe limit for retrieving all Bucket lists, default is 20No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[UFileBucketSet]Description information of the Bucket, see parameters in UFileBucketSetNo

Data Model

UFileBucketSet

Field NameTypeDescription InformationRequired
RegionstringRegion of the BucketNo
BucketNamestringBucket NameNo
BucketIdstringBucket’s IDNo
DomainUFileDomainSetCollection of Bucket’s domain names, see UFileDomainSet for parametersNo
CdnDomainIdarray[string]The ID list of the CND acceleration domain names associated with the BucketNo
TypestringBucket Access TypeNo
CreateTimeintCreation time of the BucketNo
ModifyTimeintModification time of the BucketNo
BizstringBucket’s business ownership, general or vod or udb general: general business; vod: video cloud business; udb: cloud database businessNo
TagstringAffiliated Business GroupNo
HasUserDomainintWhether a custom domain exists. 0 does not exist, 1 exists, 2 errorNo

UFileDomainSet

Field NameTypeDescription InformationRequired
Srcarray[string]Source DomainNo
Cdnarray[string]UCDN Accelerated DomainNo
CustomSrcarray[string]User-defined origin domain nameNo
CustomCdnarray[string]User-defined CDN acceleration domain nameNo

Example

Request Example

https://api.dezai.com/?Action=DescribeBucket
&BucketName=blue
&Region=cxqbTMaU

Response Example

{
  "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
}