Create tasks for scanning big keys and hot keys - CreateScanHotBigKeys
Overview
Create a task to scan big keys and hot keys
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CreateScanHotBigKeys. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| Zone | string | Availability Zone. See Availability Zone List | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
| GroupId | string | Resource ID | Yes |
| Type | string | Task Type. 'ScanBigKeys': Scan for big keys, 'ScanHotKeys': Scan for hot keys. | Yes |
| IsRetry | boolean | Do you want to retry the task? If so, TaskId is required. | No |
| TaskId | string | Task ID to retry | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=CreateScanHotBigKeys
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=rNIVBcMu
&GroupId=zMwxHlVM
&Type=1
&IsRetry=true
&TaskId=HKgbjDjF
&IsRetry=false
&TaskId=tJfEjIiXResponse Example
{
"Action": "CreateScanHotBigKeysResponse",
"RetCode": 0
}