All Products
Search
Document Center

Resource Orchestration Service:GetAITask

Last Updated:May 14, 2025

Queries the information about an AI task by task ID.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
ros:GetAITaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the AI task.

t-asasas*****
OutputOptionstringNo

Specifies whether to return the TaskOutput parameter. The TaskOutput parameter specifies the outputs of the AI task. Valid values:

  • Enabled
  • Disabled (default)
Note The value of TaskOutput may be excessively long. If you do not require the outputs of the task, we recommend that you set OutputOption to Disabled to improve the response speed of the API operation.
Disabled

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TaskIdstring

The ID of the AI task.

t-asasas*****
RequestIdstring

The request ID.

14A07460-EBE7-47CA-9757-12CC4761D47A
TaskTypestring

The type of the AI task.

  • GenerateTemplate: The AI task is used to generate a template.
  • FixTemplate: The AI task is used to fix a template.
GenerateTemplate
Statusstring

The state of the AI task.

  • PENDING
  • WAITING
  • RUNNING
  • SUCCESS
  • FAILURE
FAILURE
StatusReasonstring

The reason why the AI task is in the state.

Handler execution unexpected failure
TaskOutputobject

The outputs of the AI task. The outputs include the template.

"Result": { "ROSTemplateFormatVersion": "2015-09-01", }
Codestring

The error code.

Forbidden
HttpStatusCodeinteger

The HTTP status code.

200
Messagestring

The error message.

You are not authorized to complete this action.
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "TaskId": "t-asasas*****\n",
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "TaskType": "GenerateTemplate",
  "Status": "FAILURE",
  "StatusReason": "Handler execution unexpected failure",
  "TaskOutput": {
    "test": "test",
    "test2": 1
  },
  "Code": "Forbidden",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to complete this action.",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history