All Products
Search
Document Center

Data Management:GetOrderBaseInfo

Last Updated:Mar 14, 2024

Queries the basic information about a ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetOrderBaseInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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
OrderIdlongYes

The ID of the ticket.

12345

Response parameters

ParameterTypeDescriptionExample
object
OrderBaseInfoobject

The basic information about the ticket.

RelatedUserNickListarray

The nicknames of the operators that are related to the ticket.

string

The nickname of the operator that is related to the ticket.

nickname
Commentstring

The remarks of the ticket.

test
CreateTimestring

The time when the ticket was created.

2019-10-10 00:00:00
Committerstring

The applicant.

xxx
WorkflowInstanceIdlong

The ID of the approval process.

1
CommitterIdlong

The ID of the applicant. Note: The ID is different from the Alibaba Cloud account ID of the applicant.

1
LastModifyTimestring

The time when the ticket was last modified.

2019-10-10 00:00:00
StatusCodestring

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
RelatedUserListarray

The IDs of the operators that are related to the ticket.

string

The ID of the operator that is related to the ticket.

1
WorkflowStatusDescstring

The description of the approval process.

approved
StatusDescstring

The description of the status.

success
PluginTypestring

The type of the ticket. For more information about the value of this parameter, see the request parameters of the CreateOrder operation.

DC_COMMON
OrderIdlong

The ID of the ticket.

12345
AttachmentKeystring

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
OriginAttachmentNamestring

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
RequestIdstring

The ID of the request.

7133DF67-5B25-460F-8285-C4CC93472C2F
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
Successboolean

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 timeSummary of changesOperation
2023-10-12The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.