All Products
Search

This Product

    Compute Nest:GetServiceInstance

    Document Center

    Compute Nest:GetServiceInstance

    Last Updated:Oct 22, 2025

    Queries the details of a specified service instance using the service instance ID and region ID. The returned information includes the deployment status, template name, and service details.

    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

    computenestsupplier:GetServiceInstance

    get

    *ServiceInstance

    acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ServiceInstanceId

    string

    Yes

    The ID of the service instance.

    si-d6ab3a63ccbb4b17****
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    Status

    string

    The deployment status of the service instance. Valid values:

    • Created: The service instance is created.

    • Deploying: The service instance is being deployed.

    • DeployedFailed: The service instance failed to be deployed.

    • Deployed: The service instance is deployed.

    • Upgrading: The service instance is being upgraded.

    • Deleting: The service instance is being deleted.

    • Deleted: The service instance is deleted.

    • DeletedFailed: The service instance failed to be deleted.

    Deployed
    TemplateName

    string

    The template name.

    模板1
    UpdateTime

    string

    The time when the service instance was updated.

    2021-05-20T00:00:00Z
    RequestId

    string

    The request ID.

    4DB0F536-B3BE-4F0D-BD29-E83FB56D550C
    ServiceInstanceId

    string

    The service instance ID.

    si-d6ab3a63ccbb4b17****
    CreateTime

    string

    The time when the service instance was created.

    2021-05-20T00:00:00Z
    UserId

    integer

    The user's Alibaba Cloud account ID.

    1234567
    SupplierUid

    integer

    The service provider's Alibaba Cloud account ID.

    1964460391538545
    Service

    object

    The service details.

    Status

    string

    The service status. Valid values:

    Draft: The service is pending registration.

    Submitted: The service is submitted for registration.

    Approved: The registration is approved.

    Online: The service is published.

    Offline: The service is unpublished.

    Deleted: The service is deleted.

    Launching: The service is being published.

    Online
    PublishTime

    string

    The time when the service was published.

    2021-05-21T00:00:00Z
    Version

    string

    The service version.

    1
    DeployMetadata

    string

    The deployment configuration of the service. The data format varies based on the deployment type. The value is a JSON string.

    { "EstimateTime": null, "SupplierDeployMetadata": { "DeployTimeout": null }, "TemplateConfigs": [ { "Name": "模板1", "Url": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json", "PredefinedParameters": [], "AllowedRegions": [ "cn-hangzhou" ] } ] }
    DeployType

    string

    The deployment type. Valid values:

    • ros: The service is deployed using ROS.

    • terraform: The service is deployed using Terraform.

    • ack: The service is deployed using ACK.

    • spi: The service is deployed using SPI.

    • operation: The service is deployed using Alibaba Cloud Managed Services.

    ros
    ServiceId

    string

    The service ID.

    service-9c8a3522528b4fe8****
    SupplierUrl

    string

    The URL of the service provider.

    http://example.com
    ServiceProductUrl

    string

    The URL of the product page for the service.

    https://service-info-private.oss-cn-hangzhou.aliyuncs.com
    ServiceDocUrl

    string

    The URL of the documentation for the service.

    http://example.com
    ServiceType

    string

    The service type. Valid values:

    • private: The service is deployed in the user's account.

    • managed: The service is deployed in the service provider's account.

    • operation: The service is an Alibaba Cloud Managed Services.

    private
    SupplierName

    string

    The name of the service provider.

    A公司
    ServiceInfos

    array<object>

    The service information.

    object

    The service information.

    Locale

    string

    The language of the service instance.

    zh-CN
    Image

    string

    The URL of the service icon.

    https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png
    Name

    string

    The service name.

    B数据库
    ShortDescription

    string

    A short description of the service.

    B是A公司自主设计并研发的开源分布式的关系型数据库
    VersionName

    string

    The custom version name specified by the service provider.

    版本A
    UpgradableServiceVersions

    array

    The service versions to which the service can be upgraded.

    string

    The service versions to which the service can be upgraded.

    1
    UpgradableServiceInfos

    array<object>

    The information about the service versions to which the service can be upgraded.

    object

    The information about the service versions to which the service can be upgraded.

    Version

    string

    The service version to which the service can be upgraded.

    4
    VersionName

    string

    The name of the service version to which the service can be upgraded.

    新增参数管理功能
    Parameters

    string

    The parameters that are entered for deploying the service instance.

    { "param": "value" }
    Progress

    integer

    The deployment progress of the service instance. Unit: %.

    90
    StatusDetail

    string

    The description of the deployment status of the instance.

    deploy successfully
    OperationStartTime

    string

    The start time of the Alibaba Cloud Managed Services.

    2021-12-29T06:48:56Z
    OperationEndTime

    string

    The end time of the Alibaba Cloud Managed Services.

    2022-01-28T06:48:56Z
    OperatedServiceInstanceId

    string

    The ID of the service instance that is managed by Alibaba Cloud Managed Services.

    si-d6ab3a63ccbb4b17****
    IsOperated

    boolean

    Indicates whether Alibaba Cloud Managed Services is enabled for the service instance. Valid values:

    • true: Alibaba Cloud Managed Services is enabled for the service instance.

    • false: Alibaba Cloud Managed Services is not enabled for the service instance.

    true
    EnableInstanceOps

    boolean

    Indicates whether the service instance supports Alibaba Cloud Managed Services. Valid values:

    • true: The service instance supports Alibaba Cloud Managed Services.

    • false: The service instance does not support Alibaba Cloud Managed Services.

    true
    Resources

    string

    The resources.

    [ { "StackId": "stack-xxx" } ]
    NetworkConfig

    object

    The network configuration.

    Note

    This parameter is deprecated.

    EndpointServiceId

    string

    The ID of the endpoint service for the PrivateLink connection.

    Note

    This parameter is deprecated.

    epsrv-5ei07324541816bxxxx
    EndpointId

    string

    The ID of the endpoint for the PrivateLink connection.

    Note

    This parameter is deprecated.

    ep-m5ei37240541816b****
    PrivateVpcConnections

    array<object>

    The information about the PrivateLink connection.

    array<object>

    The information about the PrivateLink connection.

    EndpointId

    string

    The ID of the endpoint for the PrivateLink connection.

    ep-m5ei37240541816b****
    EndpointServiceId

    string

    The ID of the endpoint service for the PrivateLink connection.

    epsrv-5ei07324541816bxxxx
    PrivateZoneName

    string

    The custom domain name.

    test.computenest.aliyuncs.com
    ConnectionConfigs

    array<object>

    The network configuration. This is mainly used for PrivateLink connections.

    object

    The network configuration. This is mainly used for PrivateLink connections.

    VpcId

    string

    The virtual private cloud (VPC) ID.

    vpc-bp1vwnn14rqpyiczj****
    SecurityGroups

    array

    The name of the security group.

    string

    The name of the security group.

    sg-m5ec4mvoq9egn7xxxxxx
    VSwitches

    array

    The name of the virtual switch.

    string

    The name of the virtual switch.

    vsw-uf6iqwohr05dw4mxxxxxx
    IngressEndpointStatus

    string

    The status of the Ingress endpoint. Valid values:

    • Ready: The endpoint is connected.

    • Pending: The endpoint is being connected.

    • Failed: The endpoint failed to be connected.

    • Deleted: The endpoint is deleted.

    • Deleting: The endpoint is being deleted.

    Ready
    NetworkServiceStatus

    string

    The status of the network service. Valid values:

    • Ready: The endpoint is connected.

    • Pending: The endpoint is being connected.

    • Failed: The endpoint failed to be connected.

    • Deleted: The endpoint is deleted.

    • Deleting: The endpoint is being deleted.

    Ready
    EndpointIps

    array

    The IP address of the endpoint for the PrivateLink connection.

    string

    The IP address of the endpoint for the PrivateLink connection.

    192.xxx.xxx.xxx
    DomainName

    string

    The domain name.

    example.com
    ConnectBandwidth

    integer

    The bandwidth throttling for the connection that is established using the internal network of Compute Nest. Unit: Mbps.

    1536Mbps
    ReversePrivateVpcConnections

    array<object>

    The information about the reverse PrivateLink connection.

    object

    The information about the reverse PrivateLink connection.

    EndpointId

    string

    The ID of the endpoint for the reverse PrivateLink connection.

    ep-m5ei42370541816b****
    EndpointServiceId

    string

    The ID of the endpoint service for the PrivateLink connection.

    epsrv-5ei07324541816bxxxx
    Tags

    array<object>

    The custom tags.

    object

    The custom tags.

    Key

    string

    The tag key.

    key1
    Value

    string

    The tag value.

    value1
    Outputs

    string

    The output fields that are returned after the service instance is created.

    • In ROS mode, all output fields of the template are returned.

    • In SPI mode, the output fields of the ISV and the output fields of the additional features of Compute Nest are returned.

    { "InstanceIds": [ "i-hp38ofxl0dsyfi7z****" ] }
    EndTime

    string

    The time when the service instance expires.

    2022-01-01T12:00:00
    Source

    string

    The source of the service instance. Valid values:

    • User: a Compute Nest user.

    • Market: Alibaba Cloud Marketplace.

    • Supplier: a Compute Nest service provider.

    User
    ServiceType

    string

    The service type. Valid values:

    • private: a service instance that is deployed in the user's account.

    • managed: a service instance that is deployed in the service provider's account.

    • operation: an Alibaba Cloud Managed Services instance

    • poc: a trial service instance.

    private
    PayType

    string

    The billing method. Valid values:

    • Permanent: The service is permanently purchased.

    • Subscription: The service is a subscription service from Alibaba Cloud Marketplace.

    • PayAsYouGo: The service is a pay-as-you-go service from Alibaba Cloud Marketplace.

    • CustomFixTime: The service has a custom fixed duration.

    Subscription
    LicenseMetadata

    string

    The license metadata.

    {"renewType":"MONTHLY"}
    Name

    string

    The name of the service instance.

    TestName
    EnableUserPrometheus

    boolean

    Indicates whether Prometheus is enabled for the user.

    true
    RdAccountLoginUrl

    string

    The logon URL for the member in the resource directory that corresponds to the service instance.

    https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole
    PredefinedParameterName

    string

    The package name.

    套餐一
    ResourceGroupId

    string

    The resource group ID.

    rg-aekzkt5buxxxxxx
    BizStatus

    string

    The business status of the service instance. Valid values:

    • Normal: The service instance is normal.

    • Renewing: The service instance is being renewed.

    • RenewFoiled: The service instance failed to be renewed.

    • Expired: The service instance has expired.

    Normal
    GrafanaDashBoardUrl

    string

    The URL of the Grafana dashboard.

    https://g.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s
    OperationExtraInfo

    string

    The additional information about Alibaba Cloud Managed Services.

    6cc5ce3590ed7f5529e85fec
    PolicyNames

    string

    GrantedPermission

    object

    OperationEndTime

    string

    PolicyNames

    string

    Examples

    Success response

    JSON format

    {
  "Status": "Deployed",
  "TemplateName": "模板1",
  "UpdateTime": "2021-05-20T00:00:00Z",
  "RequestId": "\t\n4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "CreateTime": "2021-05-20T00:00:00Z",
  "UserId": 1234567,
  "SupplierUid": 1964460391538545,
  "Service": {
    "Status": "Online",
    "PublishTime": "2021-05-21T00:00:00Z",
    "Version": "1",
    "DeployMetadata": "{\n      \"EstimateTime\": null,\n      \"SupplierDeployMetadata\": {\n            \"DeployTimeout\": null\n      },\n      \"TemplateConfigs\": [\n            {\n                  \"Name\": \"模板1\",\n                  \"Url\": \"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\",\n                  \"PredefinedParameters\": [],\n                  \"AllowedRegions\": [\n                        \"cn-hangzhou\"\n                  ]\n            }\n      ]\n}",
    "DeployType": "ros",
    "ServiceId": "service-9c8a3522528b4fe8****",
    "SupplierUrl": "http://example.com",
    "ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
    "ServiceDocUrl": "http://example.com",
    "ServiceType": "private",
    "SupplierName": "A公司",
    "ServiceInfos": [
      {
        "Locale": "zh-CN",
        "Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
        "Name": "B数据库",
        "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库"
      }
    ],
    "VersionName": "版本A",
    "UpgradableServiceVersions": [
      "1"
    ],
    "UpgradableServiceInfos": [
      {
        "Version": "4",
        "VersionName": "新增参数管理功能"
      }
    ]
  },
  "Parameters": "{\n      \"param\": \"value\"\n}",
  "Progress": 90,
  "StatusDetail": "deploy successfully",
  "OperationStartTime": "2021-12-29T06:48:56Z",
  "OperationEndTime": "2022-01-28T06:48:56Z",
  "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "IsOperated": true,
  "EnableInstanceOps": true,
  "Resources": "[\n      {\n            \"StackId\": \"stack-xxx\"\n      }\n]",
  "NetworkConfig": {
    "EndpointServiceId": "epsrv-5ei07324541816bxxxx",
    "EndpointId": "ep-m5ei37240541816b****",
    "PrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei37240541816b****",
        "EndpointServiceId": "epsrv-5ei07324541816bxxxx",
        "PrivateZoneName": "test.computenest.aliyuncs.com",
        "ConnectionConfigs": [
          {
            "VpcId": "vpc-bp1vwnn14rqpyiczj****",
            "SecurityGroups": [
              "sg-m5ec4mvoq9egn7xxxxxx"
            ],
            "VSwitches": [
              "vsw-uf6iqwohr05dw4mxxxxxx"
            ],
            "IngressEndpointStatus": "Ready",
            "NetworkServiceStatus": "Ready",
            "EndpointIps": [
              "192.xxx.xxx.xxx"
            ],
            "DomainName": "example.com",
            "ConnectBandwidth": 0
          }
        ]
      }
    ],
    "ReversePrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei42370541816b****",
        "EndpointServiceId": "epsrv-5ei07324541816bxxxx"
      }
    ]
  },
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "Outputs": "{\n      \"InstanceIds\": [\n            \"i-hp38ofxl0dsyfi7z****\"\n      ]\n}",
  "EndTime": "2022-01-01T12:00:00",
  "Source": "User",
  "ServiceType": "private",
  "PayType": "Subscription",
  "LicenseMetadata": "{\"renewType\":\"MONTHLY\"}",
  "Name": "TestName",
  "EnableUserPrometheus": true,
  "RdAccountLoginUrl": "https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole",
  "PredefinedParameterName": "套餐一",
  "ResourceGroupId": "rg-aekzkt5buxxxxxx",
  "BizStatus": "Normal",
  "GrafanaDashBoardUrl": "https://g.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s",
  "OperationExtraInfo": "6cc5ce3590ed7f5529e85fec",
  "PolicyNames": "",
  "GrantedPermission": {
    "OperationEndTime": "",
    "PolicyNames": ""
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.