Creates a workflow to perform smoke testing.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | RunSmokeTest |
The operation that you want to perform. Set the value to RunSmokeTest. |
RegionId | String | Yes | cn-shanghai |
The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation. |
ProjectEnv | String | Yes | PROD |
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 Basic mode and standard mode. |
Bizdate | String | Yes | 2020-05-26 00:00:00 |
The data timestamp. |
Name | String | Yes | xm_create_test |
The name of the workflow. |
NodeId | Long | Yes | 1234 |
The ID of the node. You can call the ListNodes operation to query the ID. |
NodeParams | String | No | bizdate=$bizdate tbods=$tbods |
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. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
HttpStatusCode | Integer | 200 |
The HTTP status code returned. |
Data | Long | 3333333 |
The ID of the workflow. |
ErrorMessage | String | The connection does not exist. |
The error message returned. |
RequestId | String | E6F0DBDD-5AD**** |
The ID of the request. You can locate logs and troubleshoot issues based on the ID. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
The error code returned. |
Success | Boolean | false |
Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=RunSmokeTest
&ProjectEnv=PROD
&Bizdate=2020-05-26 00:00:00
&Name=xm_create_test
&NodeId=1234
&NodeParams=bizdate=$bizdate tbods=$tbods
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<RunSmokeTestResponse>
<HttpStatusCode>200</HttpStatusCode>
<Data>3333333</Data>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<RequestId>E6F0DBDD-5AD****</RequestId>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<Success>false</Success>
</RunSmokeTestResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"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 API Error Center.