How to query the status of a license-Elastic Desktop Service-阿里云帮助中心

Use this API to poll the status of a software license created by an Independent Software Vendor (ISV).

API description

During license creation, poll the license status until the creation is successful or has failed.

Request parameters

Name	Type	Required	Example value	Description
action	String	Yes	QUERY_ORDER	The type of the request operation. Set the value to QUERY_ORDER.
orderId	Long	Yes	123451****	The order ID.

The following is a sample request:

{
   "action": "QUERY_ORDER",
   "orderId": 123451****
}

Returned data

Name	Type	Example value	Description
isvOrderStatus	String	DEPLOYED	The status of the license. Possible values: CREATING: The license is being created. Successfully deployed DEPLOY_FAILED: The creation process failed.
licenseInfo	Array	{"effet":true,"licenseUserCount":10}	If the creation is successful, an object that contains license information is returned.
effect	Boolean	true	Specifies whether the license is in effect.
licenseUserCount	Integer	10	The number of users included in the license. This is a sub-parameter of `licenseInfo`.
startTime	Long	1625097600	The time when the license becomes effective. The value is a UNIX timestamp. This is a sub-parameter of `licenseInfo`.
endTime	Long	1656633600	The expiration time of the license. The value is a UNIX timestamp.
errorMessage	String	err msg description	If the creation fails, an error message is returned.
errorCode	String	XXX_YYY	If the creation fails, an error code is returned.

Response examples

Creating

{
    "isvOrderStatus": "CREATING",
    "licenseInfo": null,
    "errorMessage": null,
    "errorCode": null
}

Success

{
    "isvOrderStatus": "DEPLOYED",
    "licenseInfo": {
        "effect": true,
        "licenseUserCount": 10,
        "startTime": 1625097600,
        "endTime": 1656633600
    },
    "errorMessage": null,
    "errorCode": null
}

Failure

{
    "isvOrderStatus": "DEPLOY_FAILED",
    "licenseInfo": null,
    "errorMessage": "err msg description",
    "errorCode": "XXX_YYY"
}