The returned data is in the JSON format. The sample responses provided in API Reference of Operation Orchestration Service (OOS) are formatted with newlines and indentations for better readability. However, the actual responses do not provide such formatting.

Sample success responses

If the call is successful, response parameters and the ID of the request are returned. A successful call returns a 2xx HTTP status code.

JSON format

{
  "RequestId": "AC467B38-3910-447D-87BC-AC049166F216" /* Response */
}

Sample error responses

If the call fails, an error message and the ID of the request are returned. A failed call returns a 4xx or 5xx HTTP status code.

You can troubleshoot issues based on the common error codes and operation-specific error codes. For more information, see common errors and API Error Center. If the error persists, you can submit a ticket and provide the host ID and request ID to get technical support from Alibaba Cloud.

JSON format

{
  "RequestId": "A40CFF28-407A-40B5-B6A5-AC049166F216", /* Request ID */
  "HostId": "oos.cn-hangzhou.aliyuncs.com", /* Host ID */
  "Code": "InvalidNextToken", /* Error code */
  "Message": "NextToken is invalid" /* Error message */
}

Error codes

Error code HTTP status code Error message Description
InvalidVersion 400 Specified parameter Version is not valid. The error message returned because the specified version is invalid. Specify a valid version in the URL and try again.
InvalidAction.NotFound 400 Specified api is not found, please check your url and method. The error message returned because the specified operation does not exist. Enter the correct Action in the URL.
Throttling.User 400 Request was denied due to user flow control. The error message returned because too many requests have been sent over a short period of time. Try again later.
InvalidParameter 400 TemplateName can not contain "*" (The error message varies with the result of parameter verification.) The parameters are invalid. Check the parameters based on the error message.
User.NoPermission 400 User has no permission to do the action: ({api_name}) The error message returned because the user does not have the permission to call this operation. Check whether the current user has the permission to call the OOS API in the Resource Access Management (RAM) console.
InvalidStsToken 400 Invalid STS token to do the action: ({api_name}) The error message returned because the specified STS token is invalid.
ExpiredStsToken 400 Expired STS token to do the action: ({api_name}) The error message returned because the specified STS token has expired.
MissingParameter 400 The Parameter ({name}) was not provided. The error message returned because a required parameter is not specified.
QuotaExceed 400 The Quota ({key}) exceeded ({value}). The error message returned because an upper limit is reached, such as the maximum number of templates and running executions.
InvalidAccountType 400 The account type ({account_type}) was not supported. The error message returned because the specified account type is not supported.
TemplateValidationError 400 {reason} The error message returned because the template failed the validation due to constraints, such as violations of data type and value range.
InvalidFunctionParameters 400 The specified function {fn_name}'s parameters are incorrect. The error message returned because the specified parameters for the function used in the template failed the validation. Check the number and values of the parameters.
InvalidTemplateReference 400 The specified reference {resource} (in {key}) is incorrect. The error message returned because the specified parameter for referencing resources in the template is invalid.
UnknownUserParameter 400 The parameter ({key}) was not defined in engine. The error message returned because the specified parameter in the template is not defined or is not supported.
InvalidTimerTriggerParameter 400 The parameter ({key}) is invalid The error message returned because the TaskAction parameter that was set to TimerTrigger is invalid.
InvalidTemplateParameter 400 The parameter ({key}) has no attributes. The error message returned because the data type of the specified parameter in the template is invalid. Set the data type of the specified parameter to Dictionary.