All Products
Search
Document Center

Security Center:CreateOssBucketScanTask

Last Updated:Feb 20, 2024

Creates a bucket check task.

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
BucketNameListarrayYes

The names of the buckets.

stringYes

The name of the bucket.

hz-yqq-standard****
ExcludeKeySuffixListarrayNo

The suffixes of the objects that you do not want to check.

stringNo

The suffix of the object that you do not want to check.

.jsp
ScanModeintegerYes

The check mode. Valid values:

  • 1: checks all objects in the bucket.
  • 2: checks only new objects in the bucket.
1
KeySuffixListarrayNo

The suffixes of the objects that you want to check.

stringNo

The suffix of the object that you want to check.

.jsp
KeyPrefixListarrayNo

The prefixes of the objects that you want to check.

stringNo

The prefix of the object that you want to check.

/root
AllKeyPrefixbooleanNo

Whether to match all prefixes.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

BBD75EC2-2F4F-5A7B-AA53-18724DC8****

Examples

Sample success responses

JSONformat

{
  "RequestId": "BBD75EC2-2F4F-5A7B-AA53-18724DC8****"
}

Error codes

HTTP status codeError codeError messageDescription
400ApiAuthExhaustedNo auth count or auth count has been exhausted.You have not purchased a quota, or the purchased quota is used up.
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 request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: KeyPrefixList
    Added Input Parameters: AllKeyPrefix