GetServiceInstance - Compute Nest - Alibaba Cloud Documentation Center

Queries the details of a service instance by its region ID, service instance ID, or Alibaba Cloud Marketplace instance ID. The returned information includes the service status, template name, and a list of resources.

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

computenest:GetServiceInstance

get

*ServiceInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceInstanceId	string	No	The service instance ID. Note You must specify either `ServiceInstanceId` or `MarketInstanceId` to query the detailed information about the service instance.	si-d6ab3a63ccbb4b17****
RegionId	string	Yes	The region ID.	cn-hangzhou
MarketInstanceId	string	No	The Alibaba Cloud Marketplace instance ID.	704***59

Response elements

Element	Type	Description	Example
	object
Outputs	string	The output fields returned when the service instance is created. In ROS mode, all output fields of the template are returned. In Service Provider Interface (SPI) mode, the output fields from the independent software vendor (ISV) and the additional features of Compute Nest are returned.	{"InstanceIds":["i-hp38ofxl0dsyfi7z****"]}
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
Progress	integer	The deployment progress of the service instance. Unit: %.	90
Parameters	string	The parameters that are entered for deploying the service instance.	{"param":"value"}
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
StatusDetail	string	The description of the deployment status of the instance.	deploy successfully
Resources	string	The list of resources.	[{"StackId": "stack-xxx"}]
Service	object	The details of the service.
Status	string	The service status. Valid values: Draft: The service is pending registration submission. Submitted: The registration is submitted. 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 information about the service deployment configuration. The information varies based on the deployment type. The data is stored in the JSON string format.	{"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 by calling 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
ServiceType	string	The service type. Valid values: private: The service is deployed in the user's account. managed: The service is hosted in the service provider's account. operation: The service is an Alibaba Cloud Managed Service.	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	The summary of the service.	B是A公司自主设计并研发的开源分布式的关系型数据库
VersionName	string	The custom version name defined by the service provider.	版本A
UpgradeMetadata	string	The upgrade metadata.	{ "Type": "OOS", "Description": "Changelog or something description", "SupportUpgradeFromVersions": [1, 2], "UpgradeSteps": { "PreUpgradeStage": { "Description": "初始化数据库", "Type": "RunCommand", "ResourceName": "EcsRole1", "CommandType": "runShellScript", "CommandContent": "echo hello" }, "UpgradeStage": [{ "Description": "更新EcsRole1实例", "Type": "RunCommand", "ResourceName": "EcsRole1", "ArtifactsDownloadDirectory": "/home/admin", "CommandType": "runShellScript", "CommandContent": "echo hello" }], "PostUpgradeStage": { "Description": "部署后post check", "Type": "None/RunCommand", "ResourceName": "EcsRole1", "CommandType": "runShellScript", "CommandContent": "echo hello" } } }
UpgradableServiceVersions	array	The list of service versions to which the service can be upgraded.
	string	The service version 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.	draft
VersionName	string	The version name.	20241112
ServiceProductUrl	string	The URL of the product page.	https://service-info-private.oss-cn-hangzhou.aliyuncs.com
ServiceDocUrl	string	The URL of the product documentation.	http://example.com
OperationMetadata	string	The parameters related to O&M operations, including service upgrade and downgrade, Prometheus, and log configurations.	{"SupportBackup":false,"PrometheusConfigMap":{},"ModifyParametersConfig":[{"TemplateName":"国内版","Operation":[{"Name":"套餐变配","Description":"套餐变配","Type":"Custom","SupportPredefinedParameters":true,"EnableLogging":false},{"Name":"参数变配","Description":"参数变配","Type":"Custom","SupportPredefinedParameters":false,"EnableLogging":false,"Parameters":["DataDiskSize"]}]}]}
OperationStartTime	string	The start time of the managed O&M.	2021-12-29T06:48:56Z
OperationEndTime	string	The end time of the managed O&M.	2022-01-28T06:48:56Z
OperatedServiceInstanceId	string	The ID of the service instance that is managed.	si-d6ab3a63ccbb4b17****
EnableInstanceOps	boolean	Indicates whether the service instance supports managed O&M. Valid values: true: The service instance supports managed O&M. false: The service instance does not support managed O&M.	true
IsOperated	boolean	Indicates whether managed O&M is enabled for the service instance. Valid values: true: Managed O&M is enabled for the service instance. false: Managed O&M is not enabled for the service instance.	true
NetworkConfig	object	The network configuration. Note This parameter is deprecated.
EndpointId	string	The endpoint ID of the PrivateLink connection. Note This parameter is deprecated.	ep-m5ei37240541816b****
PrivateZoneId	string	The ID of the PrivateZone for the custom private domain name. Note This parameter is deprecated.	cb7f214f80ac348d87daaeac1f35****
PrivateVpcConnections	array<object>	The information about the PrivateLink connection.
	array<object>	The information about the PrivateLink connection.
EndpointId	string	The endpoint ID of the PrivateLink connection.	ep-m5ei37240541816b****
PrivateZoneId	string	The ID of the PrivateZone for the custom private domain name.	cb7f214f80ac348d87daaeac1f35****
PrivateZoneName	string	The custom domain name.	test.computenest.aliyuncs.com
ConnectionConfigs	array<object>	The network configurations. This parameter is used for PrivateLink connections.
	object	The network configurations. This parameter is used for PrivateLink connections.
VpcId	string	The virtual private cloud (VPC) ID.	vpc-bp1vwnn14rqpyiczj****
SecurityGroups	array	The security group name.
	string	The security group name.	'sg-m5ec4mvoq9egn7xxxxxx
VSwitches	array	The vSwitch name.
	string	The vSwitch name.	vsw-uf6iqwohr05dw4mxxxxxx
IngressEndpointStatus	string	The status of the Ingress endpoint. Valid values: Ready: The Ingress endpoint is connected. Pending: The Ingress endpoint is being connected. Failed: The Ingress endpoint failed to be connected. Deleted: The Ingress endpoint is deleted. Deleting: The Ingress endpoint is being deleted.	Ready
NetworkServiceStatus	string	The status of the network service. Valid values: Ready: The network service is connected. Pending: The network service is being connected. Failed: The network service failed to be connected. Deleted: The network service is deleted. Deleting: The network service is being deleted.	Ready
EndpointIps	array	The IP address of the PrivateLink endpoint.
	string	The IP address of the PrivateLink endpoint.	192.xxx.xxx.xxx
DomainName	string	The domain name.	ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com
RegionId	string	The region where the VPC of the endpoint is located when a private connection is established in Compute Nest intranet-connected mode.	cn-beijing
ConnectBandwidth	integer	The bandwidth limit for the connection that is established in Compute Nest intranet-connected mode.	1536Mbps
RegionId	string	The region ID of the endpoint for the PrivateLink connection.	cn-hangzhou
ReversePrivateVpcConnections	array<object>	The information about the reverse PrivateLink connection.
	object	The information about the reverse PrivateLink connection.
EndpointId	string	The endpoint ID of the reverse PrivateLink connection.	ep-m5ei42370541816b****
Tags	array<object>	The custom tags.
	object	The custom tags.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
LicenseEndTime	string	The time when the license expires.	2022-01-01T12:00:00
UserId	integer	The user's Alibaba Cloud account ID.	130920852836****
SupplierUid	integer	The Alibaba Cloud account ID of the service provider.	158927391332*****
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 hosted in the service provider's account. operation: a managed service instance. poc: a trial service instance.	private
PayType	string	The billing method. Valid values: Permanent: permanent. Subscription: subscription. PayAsYouGo: pay-as-you-go. CustomFixTime: a custom fixed duration.	Subscription
Name	string	The name of the service instance.	TestName
EnableUserPrometheus	boolean	Indicates whether Prometheus monitoring is enabled. Valid values: true: enabled. false: disabled.	true
Components	string	The extra billing items of Alibaba Cloud Marketplace.	{"TiKVServerCount":"3","package_version":"yuncode5398300001","PDServerCount":"3","TiDBServerCount":"2"}
PredefinedParameterName	string	The name of the package.	套餐一
MarketInstanceId	string	The Alibaba Cloud Marketplace instance ID.	704***59
ResourceGroupId	string	The resource group ID.	rg-bp67acfmxazb4p****
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 renewal failed. Expired: The service instance has expired.	Normal
GrafanaDashBoardUrl	string	The URL of the Grafana dashboard.	https://gnew.console.alibabacloud.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s
SupportTrialToPrivate	boolean	Indicates whether the trial service can be converted to a paid service.
PolicyNames	string
GrantedPermission	object
OperationEndTime	string
PolicyNames	string

Examples

Success response

JSON format

{
  "Outputs": "{\"InstanceIds\":[\"i-hp38ofxl0dsyfi7z****\"]}",
  "Status": "Deployed",
  "TemplateName": "模板1",
  "UpdateTime": "2021-05-20T00:00:00Z",
  "Progress": 90,
  "Parameters": "{\"param\":\"value\"}",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "CreateTime": "2021-05-20T00:00:00Z",
  "StatusDetail": "deploy successfully",
  "Resources": "[{\"StackId\": \"stack-xxx\"}]",
  "Service": {
    "Status": "Online",
    "PublishTime": "2021-05-21T00:00:00Z",
    "Version": "1",
    "DeployMetadata": "{\"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": "ros",
    "ServiceId": "service-9c8a3522528b4fe8****",
    "SupplierUrl": "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",
    "UpgradeMetadata": "{\n  \"Type\": \"OOS\",\n  \"Description\": \"Changelog or something description\",\n  \"SupportUpgradeFromVersions\": [1, 2],\n  \"UpgradeSteps\": {\n    \"PreUpgradeStage\": {\n      \"Description\": \"初始化数据库\",\n      \"Type\": \"RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    },\n    \"UpgradeStage\": [{\n      \"Description\": \"更新EcsRole1实例\",\n      \"Type\": \"RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"ArtifactsDownloadDirectory\": \"/home/admin\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    }],\n    \"PostUpgradeStage\": {\n      \"Description\": \"部署后post check\",\n      \"Type\": \"None/RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    }\n  }\n}",
    "UpgradableServiceVersions": [
      "1"
    ],
    "UpgradableServiceInfos": [
      {
        "Version": "draft",
        "VersionName": "20241112"
      }
    ],
    "ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
    "ServiceDocUrl": "http://example.com",
    "OperationMetadata": "{\"SupportBackup\":false,\"PrometheusConfigMap\":{},\"ModifyParametersConfig\":[{\"TemplateName\":\"国内版\",\"Operation\":[{\"Name\":\"套餐变配\",\"Description\":\"套餐变配\",\"Type\":\"Custom\",\"SupportPredefinedParameters\":true,\"EnableLogging\":false},{\"Name\":\"参数变配\",\"Description\":\"参数变配\",\"Type\":\"Custom\",\"SupportPredefinedParameters\":false,\"EnableLogging\":false,\"Parameters\":[\"DataDiskSize\"]}]}]}"
  },
  "OperationStartTime": "2021-12-29T06:48:56Z",
  "OperationEndTime": "2022-01-28T06:48:56Z",
  "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "EnableInstanceOps": true,
  "IsOperated": true,
  "NetworkConfig": {
    "EndpointId": "ep-m5ei37240541816b****",
    "PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
    "PrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei37240541816b****",
        "PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
        "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": "ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com",
            "RegionId": "cn-beijing",
            "ConnectBandwidth": 0
          }
        ],
        "RegionId": "cn-hangzhou"
      }
    ],
    "ReversePrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei42370541816b****"
      }
    ]
  },
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "LicenseEndTime": "2022-01-01T12:00:00",
  "UserId": 0,
  "SupplierUid": 0,
  "EndTime": "2022-01-01T12:00:00",
  "Source": "User",
  "ServiceType": "private",
  "PayType": "Subscription",
  "Name": "TestName",
  "EnableUserPrometheus": true,
  "Components": "{\"TiKVServerCount\":\"3\",\"package_version\":\"yuncode5398300001\",\"PDServerCount\":\"3\",\"TiDBServerCount\":\"2\"}",
  "PredefinedParameterName": "套餐一",
  "MarketInstanceId": "704***59",
  "ResourceGroupId": "rg-bp67acfmxazb4p****",
  "BizStatus": "Normal",
  "GrafanaDashBoardUrl": "https://gnew.console.alibabacloud.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s",
  "SupportTrialToPrivate": false,
  "PolicyNames": "",
  "GrantedPermission": {
    "OperationEndTime": "",
    "PolicyNames": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.