ScanOssObjectV1 - Data Security Center - Alibaba Cloud Documentation Center

Operation description

Prerequisites

You must authorize and connect to the specified bucket before you call this operation. If the bucket is not authorized, the API call returns the bucket_not_authorized error code.

QPS limits

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled. This may affect your business. We recommend that you call the operation at a reasonable rate.

Usage notes

You can use the returned task ID to call the DescribeIdentifyTaskStatus operation to check the running status of the task.

After the task is complete, call the DescribeOssObjectDetailV2 operation and provide the BucketName, ServiceRegionId, and ObjectKey to view the sensitive data detection results for the object.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:ScanOssObjectV1

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceRegionId	string	Yes	The ID of the region where the OSS bucket is located.	cn-hangzhou
BucketName	string	Yes	The name of the OSS bucket.	sddp-api-demo-bucket
ObjectKeyList	array	Yes	A list of objects to scan in the OSS bucket. You can specify up to 50 ObjectKeys.
	string	No	The name of an object in the OSS bucket. You must specify the full path.	dir1/object.txt
TemplateId	integer	No	The ID of the industry-specific template. Note Call DescribeCategoryTemplateList to get a list of templates. If you do not specify this parameter, the default active template is used for the scan.	1
Lang	string	No	The language of the request and response. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.	7C3AC882-E5A8-4855-BE77-B6837B695EF1
Id	integer	The ID of the scan task. This is returned after the task is successfully created.	268

Examples

Success response

JSON format

{
  "RequestId": "7C3AC882-E5A8-4855-BE77-B6837B695EF1",
  "Id": 268
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.