GetInstanceLicense - Identity as a Service - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the currently effective License information of the instance

Operation description

Please ensure that your current instance is no longer in use. When the EIAM instance is deleted, all related data will be deleted.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
eiam:GetInstanceLicense		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	idaas_ue2jvisn35ea5lmthk2676xxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID	0441BD79-92F3-53AA-8657-F8CE4A2B912A
License	object	Returned result.
LicenseId	string	Unique identifier of the License	license_1234xxxx
LicenseStatus	string	Status of the License Enumeration Value: valid: 有效. expired: 过期. released: 释放.	valid
LicenseChargeType	string	Payment type of the License Enumeration Value: prepay: 预付费. postpay: 后付费.	prepay
LicenseConfigJson	string	Detailed configuration JSON string of the License	{"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	long	Creation time of the License, timestamp	1720509699000
PurchaseChannel	string	Purchase channel of the License Enumeration Value: alibaba_cloud: 阿里云售卖渠道. system_free: 系统免费渠道. system_trial: 系统试用渠道.	alibaba_cloud
PurchaseInstanceId	string	Unique external product identifier corresponding to the License	eiam-cn-xxxxx
Edition	string	Edition of the License Enumeration Value: enterprise: 企业版. free: 免费版. trial: 试用版.	free
UserQuota	long	User quota of the License	100
StartTime	long	Start date of the validity period of the License, timestamp	1720509699000
EndTime	long	End date of the validity period of the License, timestamp	1723996800000

Examples

Sample success responses

JSONformat

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

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