ListServiceInstances - Compute Nest - Alibaba Cloud Documentation Center

Queries service instances for your account in a specified region.

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:ListServiceInstances

list

*ServiceInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
NextToken	string	No	The query token. Set it to the NextToken value returned from the previous API call.	BBBAAfu+XtuBE55iRLHEYYuojI4=
Filter	array<object>	No	The filter.
	object	No	The filter.
Value	array	No	The list of filter values.
	string	No	The list of filter values. The value of N can be from 1 to 10.	value1
Name	string	No	The name of the filter. You can specify one or more filter names to query resources. Valid values: Name: The name of the service. To perform a fuzzy search, enter the value in the xxx format. For example, if the service name is My Service, you can enter My or Service for a fuzzy search. ServiceInstanceName: The name of the service instance. A fuzzy query is performed if you enter one service instance name. A term query is performed if you enter multiple service instance names. ServiceInstanceId: The service instance ID. ServiceId: The service ID. Version: The service version. Status: The instance status. DeployType: The deployment type. ServiceType: The service type. OperationStartTimeBefore: The time before the start of the Alibaba Cloud Managed Services. OperationStartTimeAfter: The time after the start of the Alibaba Cloud Managed Services. OperationEndTimeBefore: The time before the end of the Alibaba Cloud Managed Services. OperationEndTimeAfter: The time after the end of the Alibaba Cloud Managed Services. OperatedServiceInstanceId: The ID of the managed service instance under a private service. OperationServiceInstanceId: The ID of the service instance under a pure managed service. EnableInstanceOps: Indicates whether the Alibaba Cloud Managed Services feature is enabled for the service instance.	ServiceInstanceId
Tag	array<object>	No	The custom tags.
	object	No	The custom tags.
Key	string	No	The tag key.	key1
Value	string	No	The tag value.	value1
ResourceGroupId	string	No	The resource group ID.	rg-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token for the next query.	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	The request ID.	E50287CB-AABF-4877-92C0-289B339A1546
TotalCount	integer	The total number of results.	100
MaxResults	integer	The number of entries returned per page. Maximum value: 100. Default value: 20.	20
ServiceInstances	array<object>	The information about the service instances.
	array<object>	The information about the service instances.
Name	string	The name of the service instance.	TestName
Status	string	The status of the service instance. Possible 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
Outputs	string	The output information of the service instance.	{"managementUrl": "http://xx.xx"}
UpdateTime	string	The update time.	2021-05-20T00:00:00Z
Parameters	string	The parameter information of the service instance.	{"param":"value"}
ServiceInstanceId	string	The service instance ID.	si-d6ab3a63ccbb4b17****
CreateTime	string	The creation time.	2021-05-20T00:00:00Z
StatusDetail	string	The description of the deployment information of the service instance.	deploy successfully
Progress	integer	The deployment progress of the service instance. Unit: %.	90
Resources	string	The list of resources.	[{"StackId": "stack-xxx"}]
TemplateName	string	The template name.	模板1
OperatedServiceInstanceId	string	The ID of the service instance that is managed by Alibaba Cloud.	si-d6ab3a63ccbb4b17****
Service	object	The service.
Status	string	The service status.	Online
PublishTime	string	The publishing time.	2021-05-21T00:00:00Z
Version	string	The service version.	1.0
DeployType	string	The deployment type. Possible 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-0e6fca6a51a54420****
SupplierUrl	string	The service provider's URL.	http://example.com
ServiceType	string	The service type. Possible 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 service overview.	B是A公司自主设计并研发的开源分布式的关系型数据库
VersionName	string	The custom version name defined by the service provider.	版本A
Commodity	object	The commodity specifications.
SaasBoostMetadata	string	The metadata of the Software as a Service (SaaS) Boost configuration.	{ //开启/关闭SaaS Boost绑定 "Enabled":true/false,默认为false //公网交互地址 "PublicAccessUrl":"https://example.com" }
Type	string	The type. Possible values: Marketplace: Alibaba Cloud Marketplace. Css: Lingxiao. SaasBoost: SaaS Boost.	Marketplace
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
EnableInstanceOps	boolean	Indicates whether the service instance has the Alibaba Cloud Managed Services feature. Possible values: true: The service instance has the Alibaba Cloud Managed Services feature. false: The service instance does not have the Alibaba Cloud Managed Services feature.	true
Tags	array<object>	The custom tags.
	object	The custom tags.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
Source	string	The source from which the service instance was created.	Supplier
EndTime	string	The expiration time of the service instance.	2022-01-01T12:00:00
ServiceType	string	The service type. Possible 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. poc: The service instance is a trial instance.	private
PayType	string	The billing method. Valid values: Permanent: The service is purchased permanently. Subscription: The service is a subscription instance from Alibaba Cloud Marketplace. PayAsYouGo: The service is a pay-as-you-go instance from Alibaba Cloud Marketplace. CustomFixTime: The service has a custom fixed duration.	Subscription
MarketInstanceId	string	The ID of the Alibaba Cloud Marketplace instance.	5827****
ResourceGroupId	string	The resource group ID.	rg-aekz6scpcxxxxxx
BizStatus	string	The business status of the service instance. Possible values: Normal: The service instance is running as expected. Renewing: The service instance is being renewed. RenewFoiled: The renewal of the service instance failed. Expired: The service instance has expired.	Normal
OrderId	string	The order ID.	2306175xxxxxxxx
SupportTrialToPrivate	boolean	Indicates whether the trial instance can be converted to a regular instance.	true
PolicyNames	string
GrantedPermission	object
OperationEndTime	string
PolicyNames	string

Examples

Success response

JSON format

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI4=",
  "RequestId": "E50287CB-AABF-4877-92C0-289B339A1546",
  "TotalCount": 100,
  "MaxResults": 20,
  "ServiceInstances": [
    {
      "Name": "TestName",
      "Status": "Deployed",
      "Outputs": "{\"managementUrl\": \"http://xx.xx\"}",
      "UpdateTime": "2021-05-20T00:00:00Z",
      "Parameters": "{\"param\":\"value\"}",
      "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "CreateTime": "2021-05-20T00:00:00Z",
      "StatusDetail": "deploy successfully",
      "Progress": 90,
      "Resources": "[{\"StackId\": \"stack-xxx\"}]",
      "TemplateName": "模板1",
      "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "Service": {
        "Status": "Online",
        "PublishTime": "2021-05-21T00:00:00Z",
        "Version": "1.0",
        "DeployType": "ros",
        "ServiceId": "service-0e6fca6a51a54420****",
        "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",
        "Commodity": {
          "SaasBoostMetadata": "{\n     //开启/关闭SaaS Boost绑定\n    \"Enabled\":true/false,默认为false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}",
          "Type": "Marketplace"
        }
      },
      "OperationStartTime": "2021-12-29T06:48:56Z",
      "OperationEndTime": "2022-01-28T06:48:56Z",
      "EnableInstanceOps": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Source": "Supplier",
      "EndTime": "2022-01-01T12:00:00",
      "ServiceType": "private",
      "PayType": "Subscription",
      "MarketInstanceId": "5827****",
      "ResourceGroupId": "rg-aekz6scpcxxxxxx",
      "BizStatus": "Normal",
      "OrderId": "2306175xxxxxxxx",
      "SupportTrialToPrivate": true,
      "PolicyNames": "",
      "GrantedPermission": {
        "OperationEndTime": "",
        "PolicyNames": ""
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.