SubmitQualityCheckTask

Updated at:

Creates a dataset quality inspection task.

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

sca:SubmitQualityCheckTask

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

JsonStr

string

Yes

The complete JSON string. For details, see the following information.

"{"jobName":"Task 2020-03-19 14:16:55","jobType":0,"jsonStr":{"dataSetIds":[123**],"modeCustomizationId":"046db35352904c5dbb0564****","ruleIds":[185**,185**],"vocabId":"0f0cd63546c747bcb306bb05***"}}"

BaseMeAgentId

integer

No

baseMeAgentId

123456

Request parameters

PropertyData typeRequiredDescription
jsonStrStringYesThe complete JSON string. For details, see the following information.
jobNameStringNoThe name of the task.
jobTypeIntegerNoThe task type. A value of 0 indicates a common dataset task. Set this parameter to 0.
scheduledFireTimeStringNoThe execution time of the scheduled task. Format: yyyy-MM-dd HH:mm:ss. The time cannot be earlier than the current time. If this parameter is left empty, the task is executed immediately.

JSON string for request parameters

PropertyData typeRequiredDescription
dataSetIdsListYesThe IDs of the datasets.
ruleIdsListYesThe IDs of the rules.
modeCustomizationIdStringYesThe ID of the language model.
vocabIdStringNoThe ID of the hot word model.

Response elements

Element

Type

Description

Example

object

Code

string

The result code. A value of 200 indicates success, and other values indicate failure. You can determine the cause of the failure based on this field.

200

Message

string

The error details when an error occurs, or successful when the request is successful.

successful

Data

string

The ID of the task.

F6C2B68F-2311-4495-82AC-DAE86C9****

RequestId

string

The ID of the request.

00A044A2-D59B-4104-96BA-84060AE8345F

Success

boolean

Indicates whether the request is successful. You can determine whether the request is successful based on this field. A value of true indicates success, and a value of false or null indicates failure.

true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "Data": "F6C2B68F-2311-4495-82AC-DAE86C9****",
  "RequestId": "00A044A2-D59B-4104-96BA-84060AE8345F",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.