You can call this operation to query license information.

When you use a license to query business information, the system first checks whether the license is valid.

  • If the license is invalid, the system returns an error message.
  • If the license is valid, the system returns the license information.

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 DescribeLicense

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

LicenseCode String Yes APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA

The license whose information is to be queried.

Response parameters

Parameter Type Example Description
RequestId String A007A214-4B7D-40F9-B617-A1C0C1D49FD1

The ID of the request.

License Struct -

The license information.

LicenseStatus String INACTIVATED

The status of the license. Valid values:

  • ACTIVATED: The license was activated.
  • INACTIVATED: The license was not activated.
  • EXPIRED: The license had expired.
  • DISCARD: The license was discarded.
LicenseCode String ZEJLPPNWNSC1PLMPQGSMP1FZ4ECD7KE7JCPRAAA3YJ

The license.

InstanceId String 100***65

The business instance ID of the license on Alibaba Cloud Marketplace.

CreateTime String 2016-05-18T14:14Z

The time when the license was created.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

ExpiredTime String 2016-06-04T00:00Z

The time when the license expires.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

ActivateTime String 2016-05-20T18:27Z

The time when the license was used to activate a product.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

ProductSkuId String cmgj00**11-code34600

The SKU ID of the product activated by using the license.

ProductCode String cmgj00**11

The code of the product activated by using the license.

ProductName String Sample product

The name of the product activated by using the license.

SupplierName String Alibaba

The name of the ISV that provides the product.

ExtendArray Array -

-

Code String orderId

The key of an extended attribute of the license.

Value String 201015528710797,201022520050797

The value of an extended attribute of the license.

ExtendInfo Struct -

The extended information about the license.

AliUid Long 11111111

The unique ID of the product buyer.

Email String test@aliyun.com

The email address of the product buyer.

Mobile String 123*****111

The mobile number of the product buyer.

AccountQuantity Long 1

The number of accounts allowed by the license.

Examples

Sample requests

http(s)://market.aliyuncs.com/? Action=DescribeLicense
&LicenseCode=APSEDH8TA5CSGK-********_6CNTACBH9EQPOATFXJQL4B2COE7M43VVQ7GUGKAA
&<Common request parameters>

Sample success responses

XML format

<DescribeLicenseResponse>
  <License>
        <ActivateTime>2016-05-20T18:27Z</ActivateTime>
        <CreateTime>2016-05-18T14:14Z</CreateTime>
        <ExpiresTime>2016-06-04T00:00Z</ExpiresTime>
        <ExtendArray>
              <Code>package_version</Code>
              <Value>yuncode1283800001</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>instanceId</Code>
              <Value>11***11</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>activeAddress</Code>
              <Value>https://pro.formtalk.net/org/orgMgt.do?method=viewRegisterEnterprise&amp;from=aliyun</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>orderId</Code>
              <Value>201015528711111,201022520022222</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>orderBizId</Code>
              <Value>111111</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>mobile</Code>
              <Value>130****3454</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>accountQuantity</Code>
              <Value>1</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>aliUid</Code>
              <Value>183***111</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>expiresTime</Code>
              <Value>2021-07-26 00:00:00</Value>
        </ExtendArray>
        <ExtendArray>
              <Code>skuId</Code>
              <Value>yuncode1283800001</Value>
        </ExtendArray>
        <ExtendInfo>
              <UserNum>100</UserNum>
              <Package_version>yuncode1283800001</Package_version>
              <InstanceId>1934558</InstanceId>
              <ActiveAddress>https://pro.formtalk.net/org/orgMgt.do?method=viewRegisterEnterprise&amp;from=aliyun</ActiveAddress>
              <OrderId>201015528711111,201022520022222</OrderId>
              <OrderBizId>11111</OrderBizId>
              <Mobile>130****3454</Mobile>
              <AccountQuantity>1</AccountQuantity>
              <AliUid>183***111</AliUid>
              <ExpiresTime>2021-07-26 00:00:00</ExpiresTime>
              <SkuId>yuncode1283800001</SkuId>
        </ExtendInfo>
        <Identification>1835994468517295</Identification>
        <InstanceId>111111</InstanceId>
        <LicenseCode>XGZHOZSQSYC2EEJB-OL1UHLCBPL********_CCH4YDTH8MPMQ2FYUUSZTR</LicenseCode>
        <LicenseStatus>ACTIVATED</LicenseStatus>
        <ProductCode>cmgj0**838</ProductCode>
        <ProductName>B ** Platform</ProductName>
        <ProductSkuId>yuncode1283800001</ProductSkuId>
        <SupplierName>Beijing ** Software Co. Ltd.</SupplierName>        <SupplierPk>183599411111</SupplierPk>
  </License>
  <RequestId>c635b305-7481-4f9a-8ebb-aeff43229993</RequestId>
</DescribeLicenseResponse>

JSON format

{
    "License": 
    {
        "ActivateTime":"2016-05-20T18:27Z",
        "CreateTime":"2016-05-18T14:14Z",
        "ExpiresTime":"2016-06-04T00:00Z",
        "ExtendArray":[
            {
                "Code":"package_version",
                "Value":"yuncode1283800001"
            },
            {
                "Code":"instanceId",
                "Value":"11***11"
            },
            {
                "Code":"activeAddress",
                "Value":"https://pro.formtalk.net/org/orgMgt.do?method=viewRegisterEnterprise&from=aliyun"
            },
            {
                "Code":"orderId",
                "Value":"201015528711111,201022520022222"},{"Code":"orderBizId","Value":"111111"
            },
            {
                "Code":"mobile",
                "Value":"130****3454"
            },
            {
                "Code":"accountQuantity",
                "Value":"1"
            },
            {
                "Code":"aliUid",
                "Value":"183***111"
            },
            {
                "Code":"expiresTime",
                "Value":"2021-07-26 00:00:00"
            },
            {
                "Code":"skuId",
                "Value":"yuncode1283800001"
            }
        ],
        "ExtendInfo":
        {
            "UserNum":"100",
            "Package_version":"yuncode1283800001",
            "InstanceId":1934558,
            "ActiveAddress":"https://pro.formtalk.net/org/orgMgt.do?method=viewRegisterEnterprise&from=aliyun",
            "OrderId":"201015528711111,201022520022222",
            "OrderBizId":"11111",
            "Mobile":"130****3454",
            "AccountQuantity":"1",
            "AliUid":"183***111",
            "ExpiresTime":"2021-07-26 00:00:00",
            "SkuId":"yuncode1283800001"
        },
        "Identification":"1835994468517295",
        "InstanceId":111111,
        "LicenseCode":"XGZHOZSQSYC2EEJB-OL1UHLCBPL********_CCH4YDTH8MPMQ2FYUUSZTR",
        "LicenseStatus":"ACTIVATED",
        "ProductCode":"cmgj0**838",
        "ProductName":"B ** Platform",
        "ProductSkuId":"yuncode1283800001",
        "SupplierName":"Beijing ** Software Co. Ltd.",
        "SupplierPk":1845454111
    },
    "RequestId":"c635b305-7481-4f9a-8ebb-aeff43229993"
}

Error codes

HTTP status code Error code Error message Description
400 Auth.SubAccount.Error The specified AccessKey information does not belong to the RAM user. The error message returned because the specified AccessKey information does not belong to the RAM user.
400 License.Invalid The specified license is invalid. The error message returned because the specified license is invalid.
400 License.Expired The specified license has expired. The error message returned because the specified license has expired.
400 License.Discard The specified license has been discarded. The error message returned because the specified license has been discarded.
400 License.NotFound The specified license does not exist. The error message returned because the specified license does not exist.
400 Auth.ISV.Error Only ISV accounts are allowed to call the specified API operation. The error message returned because only ISV accounts are allowed to call the operation.
400 Auth.Match The product to be enabled by the specified license does not belong to the ISV. The error message returned because the product to be activated by using the specified license does not belong to the ISV.
400 Auth.Authorized The specified RAM user is not authorized. The error message returned because the specified RAM user is not authorized.

For a list of error codes, visit the API Error Center.