GetBatchTranslate-阿里云帮助中心

Operation description

1. The queries per second (QPS) limit for this API is 50. To request a limit increase, contact us in DingTalk group 23369411. 2. The maximum length of a single text segment is 1,000 characters. You can translate up to 50 segments in a single request. If your content exceeds these limits, save it to a file and use Document Translation. 3. Before you use this API, review the billing methods and pricing for the General-purpose and Professional editions. 4. You can use the Alibaba Cloud OpenAPI Developer Portal to test this API call.

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

alimt:GetBatchTranslate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FormatType	string	Yes	The format of the text to translate. `html`: The source and translated text are processed as HTML. `text`: The source and translated text are processed as plain text.	text
TargetLanguage	string	Yes	The target language. For more information, see Language codes. For more information, see Language codes.	zh
SourceLanguage	string	Yes	The source language. For more information, see Language codes. For more information, see Language codes.	en
Scene	string	Yes	Scenarios supported by the Professional Edition: product titles (`title`), product descriptions (`description`), customer communication (`communication`), medical (`medical`), and social (`social`). Scenario supported by the General-purpose Edition: `general`.	general
ApiType	string	Yes	The edition type. You must specify an edition. General-purpose Edition: `translate_standard` Professional Edition: `translate_ecommerce`	translate_standard
SourceText	string	Yes	The source text to translate, in JSON format. key: A unique ID to map the translation result to the source text. value: The content to translate. The format is as follows: `{ "11": "hello boy", "12": "go home", "13": "we can" }` Note The number of text segments cannot exceed 50. The length of a single text segment cannot exceed 1,000 characters. The total number of characters cannot exceed 8,000. The key is not included in the character count. Punctuation, spaces, and HTML tags in the content are included in the character count.	{"11":"hello boy","12":"go home","13":"we can"}

Response elements

Element	Type	Description	Example
	object
Code	integer	The error code.	200
Message	string	The message returned.	success
RequestId	string	The unique ID of the request. Use this ID for troubleshooting.	86D18195-D89C-4C8C-9DC4-5FCE789CE6D5
TranslatedList	array<object>
	object	The result, in JSON format. code: The status code for the translation of a single segment. wordCount: The number of characters in the source text. detectedLanguage: The language code of the source language detected when SourceLanguage is set to `auto`. index: The key from the input parameters. This unique ID maps the result to the source text. translated: The translation result.	[ { "code": "200", "wordCount": "9", "detectedLanguage": "en" "index": "11", "translated": "Hello男孩" }, { "code": "200", "wordCount": "7", "detectedLanguage": "en" "index": "12", "translated": "Go home" }, { "code": "200", "wordCount": "6", "detectedLanguage": "en" "index": "13", "translated": "We can" } ]

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "86D18195-D89C-4C8C-9DC4-5FCE789CE6D5",
  "TranslatedList": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
110	System.AccountNotActivated	The account has not activated the service.
111	System.SubServiceFailed	Sub-account service failed.
199	System.unknownError	An unknown error occurred.
199	System.UnknownError	An unknown system error occurred.
101	System.RequestTimeOut	The request has timed out.
112	System.TranslateServiceCallFailed	Failed to call the translation service.
102	System.Error	A system error occurred.
113	System.AccountNotActivatedOrInArrears	The service is not activated or the account has an outstanding balance.
103	System.UrlDecodingError	An error occurred while decoding the URL. Verify that the specified URL is encoded.
104	System.ParameterError	Some required parameters are missing.
105	System.LanguageNotSupported	The specified language pair is not supported.
106	System.LanguageDetectError	An error occurred while detecting the language.
107	System.TranslateError	An error occurred while translating.
108	System.StringTooLong	The maximum length of the specified string is exceeded.
109	System.SubNotPermission	The sub account is not authorized to perform the operation.
109	System.subNotPermission	The sub-account is not authorized to perform the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.