All Products
Search
Document Center

Security Center:CreateOssBucketScanTask

Last Updated:Nov 25, 2024

Creates a bucket check task.

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:CreateOssBucketScanTaskcreate
*All Resources
*
    none
none

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.

stringNo

The prefix of the object.

/root
AllKeyPrefixbooleanNo

Specifies whether to match the prefixes of all objects.

true
DecompressMaxLayerintegerNo

The maximum number of decompression levels when multi-level packages are decompressed. Valid values: 1 to 5. If the maximum number of decompression levels is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.

1
DecompressMaxFileCountintegerNo

The maximum number of objects that can be extracted during decompression. Valid values: 1 to 1000. If the maximum number of objects that can be extracted is reached, the decompression operation immediately ends and the detection of extracted objects is not affected.

100
DecryptionListarrayNo

The decryption methods.

stringNo

The decryption method. Valid values:

  • OSS: OSS-managed.
  • KMS: Key Management Service (KMS).
KMS
LastModifiedStartTimelongNo

The timestamp when the object was last modified. The time must be later than the timestamp that you specify. Unit: milliseconds.

1724301769834

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.
400TaskIsProcessingTask Is Processing.Task is processing.
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
2024-10-08The Error code has changedView Change Details
2024-07-23The Error code has changed. The request parameters of the API has changedView Change Details
2024-04-10The Error code has changed. The request parameters of the API has changedView Change Details
2023-12-07The Error code has changed. The request parameters of the API has changedView Change Details