All Products
Search
Document Center

Security Center:ListOssBucket

Last Updated:Feb 20, 2024

Queries Object Storage Service (OSS) buckets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
BucketNamestringNo

The name of the bucket.

iboxpublic****
LangstringNo

The language of the content in the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
en

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

3956048F-9D73-5EDB-834B-4827BB48****
Dataobject []

The data returned.

BucketNamestring

The name of the bucket.

iboxpublic****
Supportboolean

Indicates whether the bucket can be checked. Valid values:

  • true
  • false
true
Messagestring

The reason why the bucket cannot be checked.

Unsupported Region.
StorageClassstring

The storage class of the bucket. Valid values:

  • Standard (default)
  • IA
  • Archive
  • ColdArchive
Standard
RegionIdstring

The region ID.

cn-hangzhou
SupportConfigstring

Whether to support config. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "3956048F-9D73-5EDB-834B-4827BB48****",
  "Data": [
    {
      "BucketName": "iboxpublic****",
      "Support": true,
      "Message": "Unsupported Region.",
      "StorageClass": "Standard",
      "RegionId": "cn-hangzhou",
      "SupportConfig": "true"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-07The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.