Creates a scan authorization for a database, project, or Object Storage Service (OSS) bucket.
Operation description
This operation is used to authorize scanning of data assets to further protect the data security of your data assets.
QPS limit
The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation at an appropriate frequency.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-sddp:CreateDataLimit |
create |
*All Resource
|
|
None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ResourceType |
integer |
Yes |
The type of the service to which the asset to be scanned belongs. Valid values:
|
1 |
| ServiceRegionId |
string |
No |
Required. The region in which the asset resides. Valid values:
|
cn-hangzhou |
| ParentId |
string |
No |
Required. The name of the asset, which consists of the instance ID and the database connection string separated by a period (.). |
rm-****34.******name |
| UserName |
string |
No |
The username of the database asset. |
y*****m |
| Password |
string |
No |
The password used to access the database asset. |
p****d |
| AuditStatus |
integer |
No |
Specifies whether to enable auditing. Valid values:
|
1 |
| AutoScan |
integer |
No |
Specifies whether to automatically trigger a rescan when rules are changed. Valid values:
Note
When a rule change triggers an automatic rescan, a full scan is performed on all data in the data source. |
1 |
| LogStoreDay |
integer |
No |
The retention period of raw logs after auditing is enabled. Unit: days. Valid values:
|
30 |
| EngineType |
string |
No |
The type of the database. Valid values:
|
MySQL |
| Port |
integer |
No |
The database connection port. |
3306 |
| OcrStatus |
integer |
No |
The OCR status. Valid values:
|
0 |
| EventStatus |
integer |
No |
The anomalous activity detection status. Valid values:
|
1 |
| Enable |
integer |
No |
Specifies whether to enable sensitive data detection. Valid values:
Note
If the asset is authorized for the first time, the default value is 1. If the asset has been previously authorized, the value from the last authorization is used, which may be 0 or 1. To perform sensitive data detection on the asset, set this parameter to 1. |
1 |
| SamplingSize |
integer |
No |
The number of sample entries for sensitive data detection after data detection is enabled. Valid values:
Note
Default value: 10. |
0 |
| CertificatePermission |
string |
No |
The credential permission. Valid values:
|
ReadOnly |
| FeatureType |
integer |
No |
This parameter is deprecated. |
2 |
| SourceIp |
string |
No |
This parameter is deprecated. |
106.11.XX.XX |
| InstantlyScan |
boolean |
No |
Specifies whether to immediately scan the authorized asset. Valid values:
|
false |
| Lang |
string |
No |
The language of the request and response. Default value: zh_cn. Valid values:
|
zh_cn |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Id |
integer |
The ID of the authorized resource. |
1 |
| RequestId |
string |
The unique ID generated by Alibaba Cloud for the request. |
7C3AC882-E5A8-4855-BE77-B6837B695EF1 |
Examples
Success response
JSON format
{
"Id": 1,
"RequestId": "7C3AC882-E5A8-4855-BE77-B6837B695EF1"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.