GetOrderBaseInfo - Data Management

Queries the basic information about a ticket.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetOrderBaseInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	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	long	Yes	The ID of the ticket.	12345

Response parameters

Parameter	Type	Description	Example
	object
OrderBaseInfo	object	The basic information about the ticket.
RelatedUserNickList	array	The nicknames of the operators that are related to the ticket.
UserNicks	string	The nickname of the operator that is 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	long	The ID of the approval process.	1
CommitterId	long	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	array	The IDs of the operators that are related to the ticket.
UserIds	string	The ID of the operator that is 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 about the value of this parameter, see the request parameters of the CreateOrder operation.	DC_COMMON
OrderId	long	The ID of the ticket.	12345
AttachmentKey	string	The Key of the ticket attachment. This information is returned only when an attachment is uploaded when a ticket is created.	upload_order_info_856887_f356366f-f0f8-42fc-ba57-4a509303e814_18072d8a9bce876e3073bc655c2865f.png
OriginAttachmentName	string	The original file name of the ticket attachment. This information is returned only when an attachment is uploaded when a ticket is created.	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-12	The response structure of the API has changed	View Change Details