Data Management:GetOrderAttachmentFile - Data Management - Alibaba Cloud - Data Management

Operation description

仅当工单创建时上传了附件，才可通过此接口获取附件下载地址。

Note

您可通过调用 GetOrderBaseInfo 接口，以 AttachmentKey 参数是否有返回值来判断工单创建时是否上传了附件。

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

dms:GetOrderAttachmentFile

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	51****
Tid	integer	No	The tenant ID. Note To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	FE8EE2F1-4880-46BC-A704-5CF63EAF9A04
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request fails.	UnknownError
ErrorCode	string	The error code. Note the following rules: The ErrorCode parameter is not returned if the request is successful. The ErrorCode parameter is returned if the request fails. For more information, see the Error codes section of this topic.	UnknownError
FileUrl	string	The download URL of the attachment.	https://dmsxxx

Examples

Success response

JSON format

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF9A04",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "FileUrl": "https://dmsxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.