GetInstanceLicense - Identity as a Service - Alibaba Cloud Documentation Center

Queries the active license information for an instance.

Operation description

Ensure that the instance is no longer in use. When you delete an EIAM instance, all of its data is deleted as well.

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

eiam:GetInstanceLicense

get

*Instance

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk2676xxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
License	object	The license information.
LicenseId	string	The unique identifier of the license.	license_1234xxxx
LicenseStatus	string	The status of the license.	valid
LicenseChargeType	string	The billing method of the license.	prepay
LicenseConfigJson	string	The detailed configurations of the license, in a JSON string.	{"modules":[{"features":[{"name":"urn:alibaba:idaas:license:module:ud:customField","status":"enabled"}]……{"name":"urn:alibaba:idaas:license:tag:enterprise","status":"enabled"}],"version":"1.0"}
LicenseCreateTime	integer	The time when the license was created. This is a UNIX timestamp.	1720509699000
PurchaseChannel	string	The channel through which the license was purchased.	alibaba_cloud
PurchaseInstanceId	string	The unique ID of the purchased service that corresponds to the license.	eiam-cn-xxxxx
Edition	string	The edition of the license.	free
UserQuota	integer	The user quota of the license.	100
StartTime	integer	The start time of the validity period for the license. This is a UNIX timestamp.	1720509699000
EndTime	integer	The end time of the validity period for the license. This is a UNIX timestamp.	1723996800000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "License": {
    "LicenseId": "license_1234xxxx",
    "LicenseStatus": "valid",
    "LicenseChargeType": "prepay",
    "LicenseConfigJson": "{\"modules\":[{\"features\":[{\"name\":\"urn:alibaba:idaas:license:module:ud:customField\",\"status\":\"enabled\"}]……{\"name\":\"urn:alibaba:idaas:license:tag:enterprise\",\"status\":\"enabled\"}],\"version\":\"1.0\"}",
    "LicenseCreateTime": 1720509699000,
    "PurchaseChannel": "alibaba_cloud",
    "PurchaseInstanceId": "eiam-cn-xxxxx",
    "Edition": "free",
    "UserQuota": 100,
    "StartTime": 1720509699000,
    "EndTime": 1723996800000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.