Skip to Content
Object-based Storage(US3)GetBucketStaticPageRule

Get bucket static website configuration - GetBucketStaticPageRule

Overview

Get bucket static website configuration

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetBucketStaticPageRule.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Availability Zone ListYes
ProjectIdstringProject ID. Leave blank for the default project; sub-accounts must fill this in. Please refer to the GetProjectList APINo
BucketstringBucket NameYes

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
RuleBucketStaticPageRuleRule ContentYes

Data Model

BucketStaticPageRule

Field NameTypeDescription InformationRequired
StatusstringEnabled StatusNo
DefaultIndexstringDefault Web PageNo
SubDirRedirectstringThe status of the subdirectory redirection functionNo
RuleFor404stringHandling rules for 404 errorsNo
DefaultPage404stringDefault 404 page in the storage bucket pathNo

Example

Request Example

https://api.ucloud-global.com/?Action=GetBucketStaticPageRule &Region=cn-zj &Zone=cn-zj-01 &ProjectId=BELIiUAZ &Bucket=WVpWnjRF

Response Example

{ "Action": "GetBucketStaticPageRuleResponse", "RetCode": 0, "Rule": {} }