GetDeepWriteTaskResult
Queries the result of a deep writing task. If the task is not complete, the operation returns its current status—such as queued, running, failed, or canceled. If the task is complete, the operation returns a URL that points to a compressed package of the task output that you can download.
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.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
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 |
|---|---|---|---|---|
aimiaobi:GetDeepWriteTaskResult | get | *All Resource
| None | None |
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | No | llm-1setzb9xb8m11vrc | |
| TaskId | string | No | Task ID. | xbabac91-fdad-44d6-95ce-****** |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | Id of the request | xxxxx |
| Success | boolean | Indicates whether the request was successful. | |
| Code | string | Error code. | DataNotExists |
| Message | string | Error message. | Error message |
| HttpStatusCode | integer | HTTP status code. | 400 |
| Data | object | The task response object. | |
| TaskId | string | Task ID. | f8707efa-c30e-407f-a611-50871aa68952 |
| ArtifactUrl | string | The download URL for the task result. |
Examples
Success response
JSON format
{
"RequestId": "xxxxx",
"Success": false,
"Code": "DataNotExists",
"Message": "Error message",
"HttpStatusCode": 400,
"Data": {
"TaskId": "f8707efa-c30e-407f-a611-50871aa68952",
"ArtifactUrl": "https://aimiaobi-service-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/aimiaobi/deep-write-workspace/142***1/dbaaebd1-eb1b-41e8-9b99-******-result.zip?Expire=1111"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.