RunSmokeTest

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

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectEnv	string	Yes	The environment of the workspace. Valid values: PROD: production environment. DEV: development environment. Workspaces in basic mode do not have a development environment. For more information, see Basic mode and standard mode. Valid values: PROD : Production environment. DEV : Development environment.	PROD
Bizdate	string	Yes	The business date. The format is `yyyy-MM-dd HH:mm:ss`. Example: `2020-05-26 00:00:00`.	2020-05-26 00:00:00
Name	string	Yes	The name of the workflow.	xm_create_test
NodeId	integer	Yes	The ID of the node. You can call the ListNodes operation to obtain the node ID. Full retrieval path: first call ListProjects to obtain the ProjectId, then call ListNodes, and obtain the node ID from Data.Nodes[].NodeId.	1234
NodeParams	string	No	The parameters of the node. This parameter is configured as a JSON string. The key is the node ID, and the value is the actual parameter value.	bizdate=$bizdate tbods=$tbods

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
Data	integer	The ID of the workflow.	3333333
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	E6F0DBDD-5AD****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call was successful.	false

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.