All Products
Search
Document Center

Optimization Solver:GetOrderInfo

Last Updated:Jun 18, 2024

Obtains information about purchased licenses.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

GetOrderInfo

The operation that you want to perform. Set the value to GetOrderInfo.

RelService

String

Yes

MP

The type of the purchased license. Valid value:

  • MP: Mathematical Programming Solution

ResourceType

Integer

Yes

1

The edition of the purchased Optimization Solver service. Valid value:

  • 1: Local Edition

ListReleased

Boolean

No

true

Whether to list released instances.

Response parameters

Parameter

Type

Example

Description

Code

String

0

The status code.

Message

String

success

The response message.

Data

Map

The details about the purchased service. licenseKey: license key of the purchased service. currentConcurrency: maximum number of tasks that are allowed to run concurrently. instanceId: the ID of the instance. totalDays: the total number of days during which the service can be used. currentDays: the number of remaining days during which the service can be used.

RequestId

String

5D6653C5-CA2B-14EC-9CF0-50AA0FF49C31

The ID of the request.

Success

Boolean

true

Indicates whether the call was successful.

Examples

Sample requests

https://opt.cn-beijing.aliyuncs.com?Action=GetOrderInfo
&ResourceType=1
&RelService=MP
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetOrderInfoResponse>
    <Message>Success</Message>
    <RequestId>3FCE6765-742C-1CE7-A44B-83D35C07F286</RequestId>
    <Data>
        <licenseKey>eems7ri3b1u5nuil***</licenseKey>
        <currentConcurrency>2</currentConcurrency>
        <instanceId>opt_mplicense_public_cn-****</instanceId>
        <totalDays>124</totalDays>
        <currentDays>103</currentDays>
    </Data>
    <Code>0</Code>
    <Success>true</Success>
</GetOrderInfoResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "Success",
  "RequestId" : "3FCE6765-742C-1CE7-A44B-83D35C07F286",
  "Data" : {
    "licenseKey" : "eems7ri3b1u5nuil***",
    "currentConcurrency" : 2,
    "instanceId" : "opt_mplicense_public_cn-****",
    "totalDays" : 124,
    "currentDays" : 103
  },
  "Code" : 0,
  "Success" : true
}

Error codes

HTTP status code

Error code

Error message

Description

400

InvalidParameter

The parameter is invalid. Please check again.

The error message returned because the parameters fail to be verified. Check whether the parameters are correctly set.

401

LicenseKeyInvaild

The license key format is invalid, or the license key does not belong to the user.

The error message returned because the license key format is invalid, or the license key does not belong to the user.

403

Unauthorized

The user has not passed RAM verification and is not authorized to perform the operation.

The error message returned because the user is not allowed to perform this operation due to a RAM permission verification failure.

409

ConcurrencyOverLimit

The concurrency exceeds the upper limit allowed by the license key.

The error message returned because the number of concurrent tasks exceeds the maximum number of concurrent tasks allowed by the license key.

410

LicenseKeyExpired

LicenseKey has expired.

The error message returned because the license key has expired.

500

InternalError

The request processing has failed due to some unknown error.

The error message returned because an internal error occurs. Try again later. If the error persists, submit a ticket.

For a list of error codes, see Service error codes.