All Products
Search

This Product

    Identity as a Service:GetInstanceLicense

    Document Center

    Identity as a Service:GetInstanceLicense

    Last Updated:Sep 17, 2026

    Queries the license information that is currently effective for an instance.

    Operation description

    Make sure that the instance is no longer in use. After an EIAM instance is deleted, all related data is deleted.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk2676xxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    License

    object

    The returned result.

    LicenseId

    string

    The unique identifier of the license.

    license_1234xxxx
    LicenseStatus

    string

    The status of the license.

    Valid values:

    • valid :

      Valid.

    • expired :

      Expired.

    • released :

      Released.

    valid
    LicenseChargeType

    string

    The billing type of the license.

    Valid values:

    • prepay :

      Subscription.

    • postpay :

      Pay-as-you-go.

    prepay
    LicenseConfigJson

    string

    The detailed license configuration as 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 creation time of the license, in timestamp format.

    1720509699000
    PurchaseChannel

    string

    The purchase channel of the license.

    Valid values:

    • alibaba_cloud :

      Alibaba Cloud sales channel.

    • system_free :

      System free channel.

    • system_trial :

      System trial channel.

    alibaba_cloud
    PurchaseInstanceId

    string

    The unique identifier of the external commodity associated with the license.

    eiam-cn-xxxxx
    Edition

    string

    The edition of the license.

    Valid values:

    • enterprise :

      Enterprise edition.

    • free :

      Free edition.

    • trial :

      Trial edition.

    free
    UserQuota

    integer

    The user quota of the license.

    100
    StartTime

    integer

    The start date of the license validity period, in timestamp format.

    1720509699000
    EndTime

    integer

    The end date of the license validity period, in timestamp format.

    1723996800000
    InstanceLicenseDetail

    object

    The detailed license information of the instance.

    UserQuota

    integer

    The user quota of the license.

    100
    PrepaidActiveUserNumber

    integer

    The number of prepaid active users.

    100
    M2mApplicationQuota

    integer

    The M2M application quota of the license.

    2
    M2mApplicationLicenseStatus

    string

    The M2M license status.

    Valid values:

    • disabled :

      Disabled.

    • enabled :

      Enabled.

    enabled
    MimApplicationLicenseStatus

    string

    The machine identity license status.

    enabled
    PamLicenseStatus

    string

    The PAM privileged access management license status.

    Valid values:

    • disabled :

      Disabled.

    • enabled :

      Enabled.

    enabled
    NetworkAccessEndpointQuota

    integer

    The network access endpoint quota of the license.

    1
    ConditionalAccessPolicyLicenseStatus

    string

    The conditional access license status.

    Valid values:

    • disabled :

      Disabled.

    • enabled :

      Enabled.

    enabled

    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,
    "InstanceLicenseDetail": {
      "UserQuota": 100,
      "PrepaidActiveUserNumber": 100,
      "M2mApplicationQuota": 2,
      "M2mApplicationLicenseStatus": "enabled",
      "MimApplicationLicenseStatus": "enabled",
      "PamLicenseStatus": "enabled",
      "NetworkAccessEndpointQuota": 1,
      "ConditionalAccessPolicyLicenseStatus": "enabled"
    }
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.