GetBucketMetadataConfiguration
Call GetBucketMetadataConfiguration to query the metadata management configuration of a general-purpose bucket, including where metadata is stored and the status and configuration of the journal table and the live inventory table.
Permissions
By default, an Alibaba Cloud account has full permissions. A RAM user or RAM role under an Alibaba Cloud account has no permissions by default; the account or an account administrator must grant the required permissions.
|
API |
Action |
Description |
|
GetBucketMetadataConfiguration |
|
Queries the metadata management configuration. |
Request syntax
GET /?metadataConfiguration HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue
Request headers
|
Name |
Type |
Required |
Description |
|
x-oss-expected-bucket-owner |
String |
No |
The expected account ID of the bucket owner. |
Response elements
|
Name |
Type |
Description |
|
DestinationResult.TableBucketArn |
String |
The ARN of the managed table bucket. |
|
DestinationResult.TableBucketType |
String |
The type of the table bucket. |
|
DestinationResult.TableNamespace |
String |
The name of the namespace that contains the metadata tables. |
|
JournalTableConfigurationResult.TableStatus |
String |
The status of the journal table. Valid values: CREATING, ACTIVE, FAILED. |
|
JournalTableConfigurationResult.TableName |
String |
The name of the journal table, which is always journal. |
|
JournalTableConfigurationResult.TableArn |
String |
The ARN of the journal table. Present only when the status is ACTIVE. |
|
JournalTableConfigurationResult.Error |
Container |
Error information. Present only when the status is FAILED. Contains ErrorCode and ErrorMessage. |
|
JournalTableConfigurationResult.RecordExpiration.Expiration |
String |
Whether record expiration is enabled. Valid values: ENABLED, DISABLED. |
|
JournalTableConfigurationResult.RecordExpiration.Days |
Integer |
The number of days after which records expire. Present only when Expiration is ENABLED. |
|
InventoryTableConfigurationResult.ConfigurationState |
String |
Whether the live inventory table is enabled. Valid values: ENABLED, DISABLED. |
|
InventoryTableConfigurationResult.TableStatus |
String |
The status of the live inventory table. Present only when ConfigurationState is ENABLED. Valid values: CREATING, BACKFILLING, ACTIVE, FAILED. |
|
InventoryTableConfigurationResult.TableName |
String |
The name of the live inventory table. Present only when enabled, and is always inventory. |
|
InventoryTableConfigurationResult.TableArn |
String |
The ARN of the live inventory table. Present only when the status is BACKFILLING or ACTIVE. |
|
InventoryTableConfigurationResult.Error |
Container |
Error information. Present only when the status is FAILED. Contains ErrorCode and ErrorMessage. |
Response headers
This operation uses only common response headers. For more information, see Common response headers.
Examples
-
Sample request
GET /?metadataConfiguration HTTP/1.1 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Date: Wed, 16 Sep 2026 12:00:00 GMT Authorization: SignatureValue -
Sample response
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <GetBucketMetadataConfigurationResult> <MetadataConfigurationResult> <DestinationResult> <TableBucketArn>acs:oss:cn-hangzhou:123456789012:table-bucket/oss-managed-table-bucket</TableBucketArn> <TableBucketType>oss-managed</TableBucketType> <TableNamespace>b_examplebucket</TableNamespace> </DestinationResult> <JournalTableConfigurationResult> <TableStatus>ACTIVE</TableStatus> <TableName>journal</TableName> <TableArn>acs:oss:cn-hangzhou:123456789012:table/b_examplebucket/journal</TableArn> <RecordExpiration> <Expiration>ENABLED</Expiration> <Days>7</Days> </RecordExpiration> </JournalTableConfigurationResult> <InventoryTableConfigurationResult> <ConfigurationState>ENABLED</ConfigurationState> <TableStatus>ACTIVE</TableStatus> <TableName>inventory</TableName> <TableArn>acs:oss:cn-hangzhou:123456789012:table/b_examplebucket/inventory</TableArn> </InventoryTableConfigurationResult> </MetadataConfigurationResult> </GetBucketMetadataConfigurationResult>
SDK
The SDKs for GetBucketMetadataConfiguration in each language are as follows:
ossutil command-line interface
For the ossutil command that corresponds to GetBucketMetadataConfiguration, see get-bucket-metadata-configuration.