All Products
Search
Document Center

Security Center:ListOssBucket

Last Updated:Nov 14, 2024

Queries Object Storage Service (OSS) buckets.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListOssBucketget
  • All Resources
    *
    none
none

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****
Dataarray<object>

The data returned.

BucketListobject
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 changedView Change Details