GetDocTranslateTask-阿里云帮助中心

Operation description

Gets the results of a document translation task.

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

anytrans:GetDocTranslateTask

none

*All Resource

*

None

Request syntax

POST /anytrans/translate/doc/get HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The ID of the Model Studio workspace.	llm-kqtrcpdee4xm29xx
taskId	string	Yes	The document translation task ID.	d3a2397bc2c14ab4a2e40a4f5b46241b

Response elements

Element	Type	Description	Example
	object	The response body.
code	string	The response status code.	success
message	string	The response message.	success
requestId	string	The unique identifier for the request.	AC642EEB-C29D-54DF-8F52-622565BBB78A
success	boolean	Indicates whether the API call was successful.	true
httpStatusCode	string	The HTTP response code.	200
data	object	The response data.
taskId	string	The document translation task ID.	d3a2397bc2c14ab4a2e40a4f5b46241b
status	string	The translation status. Valid values: Valid values: translating : Translating translated : translated	translated
charactersCount	integer	The character count.	4
pageCount	integer	The page count.	2
translateFileUrl	string	The translation result URL.	http://translate-ai-data-dev.oss-cn-hangzhou.aliyuncs.com/tongyiTranslate/123456789/a7630164ce894c799cca0f0822c36f84_merge.md

Examples

Success response

JSON format

{
  "code": "success",
  "message": "success",
  "requestId": "AC642EEB-C29D-54DF-8F52-622565BBB78A",
  "success": true,
  "httpStatusCode": "200",
  "data": {
    "taskId": "d3a2397bc2c14ab4a2e40a4f5b46241b",
    "status": "translated",
    "charactersCount": 4,
    "pageCount": 2,
    "translateFileUrl": "http://translate-ai-data-dev.oss-cn-hangzhou.aliyuncs.com/tongyiTranslate/123456789/a7630164ce894c799cca0f0822c36f84_merge.md"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.