Call the GetOrderBaseInfo API to query basic ticket information - Data Management - Alibaba Cloud - Data Management

Queries basic information about a ticket.

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:GetOrderBaseInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	-1
OrderId	integer	Yes	The ID of the ticket.	12345

Response elements

Element	Type	Description	Example
	object
OrderBaseInfo	object	Basic information about the ticket.
RelatedUserNickList	object
UserNicks	array	The nicknames of operators related to the ticket.
	string	The nickname of an operator related to the ticket.	nickname
Comment	string	The remarks of the ticket.	test
CreateTime	string	The time when the ticket was created.	2019-10-10 00:00:00
Committer	string	The applicant.	xxx
WorkflowInstanceId	integer	The ID of the approval process.	1
CommitterId	integer	The ID of the applicant. Note: The ID is different from the Alibaba Cloud account ID of the applicant.	1
LastModifyTime	string	The time when the ticket was last modified.	2019-10-10 00:00:00
StatusCode	string	The status code of the ticket. Valid values: new: The ticket is created. toaudit: The ticket is being reviewed. Approved: The ticket is approved. reject: The ticket is rejected. processing: The ticket is being executed. success: The ticket is executed. closed: The ticket is closed.	success
RelatedUserList	object
UserIds	array	The IDs of operators related to the ticket.
	string	The ID of an operator related to the ticket.	1
WorkflowStatusDesc	string	The description of the approval process.	approved
StatusDesc	string	The description of the status.	success
PluginType	string	The type of the ticket. For more information, see the request parameters of the CreateOrder operation.	DC_COMMON
OrderId	integer	The ID of the ticket.	12345
AttachmentKey	string	The key of the ticket attachment. Returned only when an attachment is uploaded during ticket creation.	upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png
OriginAttachmentName	string	The original file name of the ticket attachment. Returned only when an attachment is uploaded during ticket creation.	18072d8a9bce876e3073bc655c2865f.png
RequestId	string	The ID of the request.	7133DF67-5B25-460F-8285-C4CC93472C2F
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

{
  "OrderBaseInfo": {
    "RelatedUserNickList": {
      "UserNicks": [
        "nickname"
      ]
    },
    "Comment": "test",
    "CreateTime": "2019-10-10 00:00:00",
    "Committer": "xxx",
    "WorkflowInstanceId": 1,
    "CommitterId": 1,
    "LastModifyTime": "2019-10-10 00:00:00",
    "StatusCode": "success",
    "RelatedUserList": {
      "UserIds": [
        "1"
      ]
    },
    "WorkflowStatusDesc": "approved",
    "StatusDesc": "success",
    "PluginType": "DC_COMMON",
    "OrderId": 12345,
    "AttachmentKey": "upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png",
    "OriginAttachmentName": "18072d8a9bce876e3073bc655c2865f.png"
  },
  "RequestId": "7133DF67-5B25-460F-8285-C4CC93472C2F",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.