Help Center/ CloudDevice/ API Reference/ APIs/ Instance Subscription/ Querying Saleable Instance SKUs in Batches

Updated on 2025-10-30 GMT+08:00

View PDF

Querying Saleable Instance SKUs in Batches

Function

Query instance SKUs in batches.

The API returns the specifications of all available instances of the tenant.

Query the SKU information of a specific offering based on the query parameter.

URI

GET /v1/instances/sku

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Type of the SKU to be queried. Currently, only general cloud terminal SKUs can be queried. 0: Query the general cloud terminal SKU.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	IAM token information of the tenant.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response.
data	SkuSpecBaseResponse object	Response body.

**Table 4** SkuSpecBaseResponse
Parameter	Type	Description
bandInfo	bandInfo object	Bandwidth information.
skuSpecResponseList	Array of skuSpecResponseList objects	Instance specifications in different regions.

**Table 5** bandInfo
Parameter	Type	Description
cbcSkuId	String	Bandwidth SKU ID, corresponding to bandSkuId in the subscription API.

**Table 6** skuSpecResponseList
Parameter	Type	Description
skuResponses	Array of skuResponses objects	Instance specifications.
regionId	String	Region ID.

**Table 7** skuResponses
Parameter	Type	Description
type	String	SKU specification types: ENTERPRISE or PROFESSIONAL.
cbcSkuId	String	SKU ID of the instance, corresponding to the subscribed instanceSkuId.
name	String	Flavor name.
calcSpec	String	CPU \| Memory specifications.
storageSpec	String	Storage specifications.
specDesc	String	Specification description.
bandSize	String	Bandwidth size of the instance. The return value is a character string, for example, "2,4,8," indicating that three types of bandwidth are available.
chargeMode	Integer	Billing mode. 0: yearly/monthly 1: pay-per-use 2: yearly/monthly and pay-per-use
maxResolution	String	Highest resolution.
poolInfo	poolInfo object	Resource pool information, including the primary key ID of the SKU data record, resource pool ID, and AOSP version of the resource pool.

**Table 8** poolInfo
Parameter	Type	Description
aosp	Array of aosp objects	Resource pool specifications.

**Table 9** aosp
Parameter	Type	Description
version	String	AOSP version.
resPoolId	String	Resource pool ID.
id	Integer	Primary key ID of the data in the SKU table.
network	String	Network type. The value can be EIP or ADN.
enable	Boolean	Enabled or not. The value can be true or false.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	0: successful. KOOPHONE.API.1000: The request parameter is incorrect. Check whether the type in the request parameter is correct. KOOPHONE.API.1001: Insufficient instance permissions. KOOPHONE.API.9999: Internal service error.
error_msg	String	Error message.

Example Requests

/v1/instances/sku

Example Responses

Status code: 200

Returned parameters of the SKU API.

{
  "data" : {
    "bandInfo" : {
      "id" : "62",
      "cbcSkuId" : "kp.bandwidth"
    },
    "skuSpecResponseList" : [ {
      "skuResponses" : [ {
        "type" : "PROFESSIONAL",
        "cbcSkuId" : "kp.professional.xlarge.32g.2",
        "name" : "sku_1_xiahui",
        "calcSpec" : "4vCPUs | 8GB",
        "storageSpec" : "32GB",
        "specDesc" : "Professional | 4 vCPUs | 8 GB | 32 GB storage | Maximum resolution: 720p (imperceptible)",
        "specDescEn" : "Professional | 4 Core | 8GB | 32GB Storage | 720P Max Output",
        "bandSize" : "4,6",
        "poolInfo" : {
          "aosp" : [ {
            "version" : "AOSP9",
            "resPoolId" : "1600087199176311111",
            "id" : "40",
            "network" : "ADN",
            "enable" : true
          } ]
        },
        "nestInfo" : [ {
          "bandSize" : 6,
          "sceneType" : "CLOUD_PHONE",
          "network" : "EIP",
          "storageDesc" : "1.2T",
          "sceneDesc" : "Applicable to light office scenarios.",
          "sceneDescEn" : "Lightweight Office",
          "tags" : "Self-use and Office",
          "tagsEn" : "Personal Use,Business"
        }, {
          "bandSize" : 4,
          "sceneType" : "CLOUD_PHONE",
          "network" : "EIP",
          "storageDesc" : "1.2T",
          "sceneDesc" : "Applicable to light office scenarios-2.",
          "sceneDescEn" : "Lightweight Office",
          "tagsEn" : "Personal Use,Business"
        } ],
        "chargeMode" : 2,
        "maxResolution" : "720p (imperceptible)"
      }, {
        "type" : "ENTERPRISE",
        "cbcSkuId" : "kp.enterprise.xlarge.32g.2",
        "name" : "sku_basic_app",
        "calcSpec" : "4vCPUs | 8GB",
        "storageSpec" : "32GB",
        "specDesc" : "Instances available for subscription.",
        "specDescEn" : "Professional | 4 Core | 8GB | 32GB Storage | 720P Max Output",
        "bandSize" : "4",
        "poolInfo" : {
          "aosp" : [ {
            "version" : "AOSP9",
            "resPoolId" : "1600087199176322222",
            "id" : "58",
            "network" : "ADN",
            "enable" : true
          } ]
        },
        "nestInfo" : [ ],
        "chargeMode" : 2,
        "maxResolution" : "720p"
      } ],
      "regionId" : "cn-north-7"
    }, {
      "skuResponses" : [ {
        "type" : "PROFESSIONAL",
        "cbcSkuId" : "kp.professional.xlarge.32g.2",
        "name" : "sku_1",
        "calcSpec" : "4vCPUs | 8GB",
        "storageSpec" : "32GB",
        "specDesc" : "Professional | 4 vCPUs | 8 GB | 32 GB storage | Maximum resolution: 720p",
        "specDescEn" : "Professional | 4 Core | 8GB | 32GB Storage | 720P Max Output",
        "bandSize" : "4,8",
        "poolInfo" : {
          "aosp" : [ {
            "version" : "AOSP9",
            "resPoolId" : "1600087199176333333",
            "id" : "43",
            "network" : "ADN",
            "enable" : true
          } ]
        },
        "chargeMode" : 2,
        "maxResolution" : "720p"
      } ],
      "regionId" : "cn-north-208"
    }, {
      "skuResponses" : [ {
        "type" : "PROFESSIONAL",
        "cbcSkuId" : "kp.professional.xlarge.32g.2",
        "name" : "sku_xingneng_ceshi",
        "calcSpec" : "4vCPUs | 8GB",
        "storageSpec" : "32GB",
        "specDesc" : "Professional | 4 vCPUs | 8 GB | 32 GB storage | Maximum resolution: 720p",
        "specDescEn" : "Professional | 4 Core | 8GB | 32GB Storage | 720P Max Output",
        "bandSize" : "4,8",
        "poolInfo" : {
          "aosp" : [ {
            "version" : "AOSP9",
            "resPoolId" : "9223372036854774444",
            "id" : "50",
            "network" : "ADN",
            "enable" : true
          } ]
        },
        "nestInfo" : [ {
          "bandSize" : 8,
          "sceneType" : "CLOUD_PHONE",
          "network" : "EIP",
          "storageDesc" : "1.2T",
          "sceneDesc" : "Applicable to light office scenarios.",
          "sceneDescEn" : "Lightweight Office",
          "tags" : "Self-use and Office",
          "tagsEn" : "Personal Use,Business"
        }, {
          "bandSize" : 4,
          "sceneType" : "CLOUD_PHONE",
          "network" : "EIP",
          "storageDesc" : "1.2T",
          "sceneDesc" : "Applicable to light office scenarios-2.",
          "sceneDescEn" : "Lightweight Office",
          "tagsEn" : "Personal Use,Business"
        } ],
        "chargeMode" : 2,
        "maxResolution" : "720p"
      } ],
      "regionId" : "cn-southwest-252"
    } ]
  },
  "error_code" : "0",
  "error_msg" : "return sku messages success"
}