All Products
Search

This Product

    Hologres:GetInstanceModel

    Document Center

    Hologres:GetInstanceModel

    Last Updated:Sep 17, 2026

    Queries the list of large model services bound to a Hologres instance.

    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

    hologram:GetInstanceModel

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v1/instances/{instanceId}/getInstanceModel HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    No

    The instance ID.

    hgpostcn-cn-7mz2vmuxxxx

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    requestId

    string

    Id of the request

    819A7F0F-2951-540F-BD94-6A41ECF0281F
    cpu

    integer

    The total CPU of the node. This parameter applies only to Hologres AI nodes.

    32
    gpu

    integer

    The total GPU of the node. This parameter applies only to Hologres AI nodes.

    4
    memory

    integer

    The total memory of the node. This parameter applies only to Hologres AI nodes.

    128
    gpuMemory

    integer

    The total GPU memory of the node. This parameter applies only to Hologres AI nodes.

    128
    modelServiceList

    array<object>

    The list of model services.

    object

    gpuMemory

    integer

    The GPU memory consumed by this model service. This parameter applies only to Hologres AI nodes.

    32
    memory

    integer

    The memory consumed by this model service. This parameter applies only to Hologres AI nodes.

    32
    cpu

    integer

    The CPU consumed by this model service. This parameter applies only to Hologres AI nodes.

    32
    modelType

    string

    The model name.

    qwen3.5-plus
    gpu

    integer

    The GPU consumed by this model service. This parameter applies only to Hologres AI nodes.

    2
    status

    string

    The status.

    Running
    modelName

    string

    The custom name of the model service.

    my_model
    serviceCount

    integer

    The number of service replicas. This parameter applies only to Hologres AI nodes.

    2
    version

    string

    The version.

    v1.1
    message

    string

    The error message.

    Failed
    taskType

    string

    The model purpose.

    embedding
    modelParams

    string

    The model parameters. This parameter applies only to Bailian models.

    {"timeout":600,"max_retries":10,"max_retry_delay":8,"initial_retry_delay":0.5}
    apiKey

    string

    The Bailian API key (for display only and cannot be used directly).

    sk-42f6c8xxxxxb
    provider

    string

    The underlying model provider.

    bailian
    instanceRegion

    string

    The region where the AI node is deployed.

    cn-beijing
    serviceDeployRegion

    string

    The deployment region.

    cn-beijing
    supportApiKeyAccess

    boolean

    Indicates whether access to the model service through an API key is supported.

    true
    cpuUsed

    integer

    The total CPU used by the node. This parameter applies only to Hologres AI nodes.

    32
    memoryUsed

    integer

    The total memory used by the node. This parameter applies only to Hologres AI nodes.

    64
    gpuUsed

    integer

    The total GPU used by the node. This parameter applies only to Hologres AI nodes.

    2
    aiInstanceId

    string

    The AI node instance ID.

    hologram_aicombo_public_cn-77xxx
    gpuMemoryUsed

    integer

    The total GPU memory used by the node. This parameter applies only to Hologres AI nodes.

    64
    regionId

    string

    The region ID.

    cn-shanghai
    resourceType

    string

    The resource type.

    Valid values:

    • small :

      small

    • middle :

      middle

    • large :

      large

    middle
    nodeCount

    integer

    The number of nodes.

    2
    commodityCode

    string

    The commodity code.

    hologram_aipostpay_public_cn
    chargeType

    string

    The billing method. Valid values:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    PrePaid
    status

    string

    The node status.

    Valid values:

    • ResourceReady :

      Running normally.

    • InstanceWaiting :

      Being created.

    ResourceReady
    expirationTime

    string

    The expiration time (UTC).

    2026-01-28T07:44:27.535Z
    autoRenewal

    boolean

    Indicates whether auto-renewal is enabled for the resource.

    • true: Auto-renewal is enabled. The resource is automatically renewed upon expiration.

    • false: Auto-renewal is not enabled. The resource stops being available upon expiration.

    true

    Examples

    Success response

    JSON format

    {
  "requestId": "819A7F0F-2951-540F-BD94-6A41ECF0281F",
  "cpu": 32,
  "gpu": 4,
  "memory": 128,
  "gpuMemory": 128,
  "modelServiceList": [
    {
      "gpuMemory": 32,
      "memory": 32,
      "cpu": 32,
      "modelType": "qwen3.5-plus",
      "gpu": 2,
      "status": "Running",
      "modelName": "my_model",
      "serviceCount": 2,
      "version": "v1.1",
      "message": "Failed",
      "taskType": "embedding",
      "modelParams": "{\"timeout\":600,\"max_retries\":10,\"max_retry_delay\":8,\"initial_retry_delay\":0.5}",
      "apiKey": "sk-42f6c8xxxxxb",
      "provider": "bailian",
      "instanceRegion": "cn-beijing",
      "serviceDeployRegion": "cn-beijing",
      "supportApiKeyAccess": true
    }
  ],
  "cpuUsed": 32,
  "memoryUsed": 64,
  "gpuUsed": 2,
  "aiInstanceId": "hologram_aicombo_public_cn-77xxx",
  "gpuMemoryUsed": 64,
  "regionId": "cn-shanghai",
  "resourceType": "middle",
  "nodeCount": 2,
  "commodityCode": "hologram_aipostpay_public_cn",
  "chargeType": "PrePaid",
  "status": "ResourceReady",
  "expirationTime": "2026-01-28T07:44:27.535Z",
  "autoRenewal": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.