All Products
Search
Document Center

DataWorks:RunSmokeTest

Last Updated:Nov 21, 2024

Creates a workflow to perform smoke testing.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectEnvstringYes

The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment. A workspace in basic mode does not have a development environment. For more information, see Differences between workspaces in basic mode and workspaces in standard mode.

PROD
BizdatestringYes

The data timestamp.

2020-05-26 00:00:00
NamestringYes

The name of the workflow.

xm_create_test
NodeIdlongYes

The node ID. You can call the ListNodes operation to query the ID.

1234
NodeParamsstringNo

The parameters related to the node. Set this parameter to a JSON string. A key in the string indicates a parameter, and a value in the string indicates the value of the related parameter.

bizdate=$bizdate tbods=$tbods

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

HttpStatusCodeinteger

The HTTP status code.

200
Datalong

The workflow ID.

3333333
ErrorMessagestring

The error message.

The connection does not exist.
RequestIdstring

The request ID. You can use the ID to locate logs and troubleshoot issues.

E6F0DBDD-5AD****
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Successboolean

Indicates whether the request was successful.

false

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 3333333,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": false
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history