ListServiceInstances - Compute Nest - Alibaba Cloud Documentation Center

Queries a list of service instances.

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

list

*ServiceInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	10
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	A list of filter values.
	string	No	A 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 service instances. Valid values: Name: The name of the service. To perform a fuzzy search, enter the content in the xxx format for the value parameter. For example, if the service name is `My Service`, you can enter `My` or `Service` for a fuzzy search. ServiceInstanceId: The ID of the service instance. ServiceId: The ID of the service. UserId: The ID of the user. Version: The version of the service. Status: The status of the service instance. 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 for a private service. OperationServiceInstanceId: The ID of the service instance for a pure Alibaba Cloud Managed Service. EnableInstanceOps: Indicates whether Alibaba Cloud Managed Services are enabled for the service instance.	ServiceInstanceId
ShowDeleted	boolean	No	Specifies whether to display the deleted service instances. Valid values: true: Displays the deleted service instances. false: Does not display the deleted service instances.	false
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 ID of the resource group.	rg-aekzkt5buxxxxxx

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that is used to start the next query.	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	The request ID.	E50287CB-AABF-4877-92C0-289B339A1546
TotalCount	integer	The total number of entries returned.	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.
Status	string	The 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.	Deployed
UpdateTime	string	The time when the service instance was updated.	2021-05-20T00:00:00Z
Name	string	The name of the service instance.	TestName
ServiceInstanceId	string	The ID of the service instance.	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
Service	object	The service.
Status	string	The status of the service.	Online
PublishTime	string	The time when the service was published.	2021-05-21T00:00:00Z
Version	string	The version of the service.	1.0
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-0e6fca6a51a54420****
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 deployed in the service provider's account. operation: The service is an Alibaba Cloud Managed Service. poc: The service instance is a trial instance.	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 name of the service.	B数据库
ShortDescription	string	The description of the service.	B是A公司自主设计并研发的开源分布式的关系型数据库
VersionName	string	The custom version name defined by the service provider.	版本A
DeployMetadata	string	The deployment configuration of the service. The configuration 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" ] } ] }
EnablePrivateVpcConnection	boolean	Indicates whether PrivateLink is enabled. Valid values: true: Enabled. false: Disabled.	false
SourceSupplierName	string	The name of the source service provider that distributes the service.	A有限公司
Parameters	string	The parameters of the service instance.	{"param":"value"}
Progress	integer	The deployment progress of the service instance. Unit: %.	90
StatusDetail	string	The description of the deployment of the service instance.	deploy successfully
TemplateName	string	The name of the template.	模板1
OperatedServiceInstanceId	string	The ID of the service instance that is managed.	si-d6ab3a63ccbb4b17****
OperationStartTime	string	The time when the Alibaba Cloud Managed Services start.	2021-12-29T06:48:56Z
OperationEndTime	string	The time when the Alibaba Cloud Managed Services end.	2021-12-29T06:48:56Z
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
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 time when the service instance expires.	2022-01-01T12:00:00
ServiceType	string	The service type. Valid values: private: The service instance is deployed in the user's account. managed: The service instance is deployed in the service provider's account. operation: The service instance is an Alibaba Cloud Managed Service instance. poc: The service instance is a trial instance.	private
PayType	string	The billing method. Valid values: Permanent: The service is permanently purchased. Subscription: The service is a subscription service from the Alibaba Cloud Marketplace. PayAsYouGo: The service is a pay-as-you-go service from the Alibaba Cloud Marketplace. CustomFixTime: The service has a custom fixed duration.	Subscription
IsOperated	boolean	Indicates whether Alibaba Cloud Managed Services are enabled for the service instance. Valid values: true: Alibaba Cloud Managed Services are enabled for the service instance. false: Alibaba Cloud Managed Services are not enabled for the service instance.	true
ResourceGroupId	string	The ID of the resource group.	si-d6ab3a63ccxxxxxx
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 of the service instance failed. Expired: The service instance has expired.	Normal
GrantedPermission	object
OperationEndTime	string
PolicyNames	string
PolicyNames	string

Examples

Success response

JSON format

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI4=",
  "RequestId": "E50287CB-AABF-4877-92C0-289B339A1546",
  "TotalCount": 100,
  "MaxResults": 20,
  "ServiceInstances": [
    {
      "Status": "Deployed",
      "UpdateTime": "2021-05-20T00:00:00Z",
      "Name": "TestName",
      "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "CreateTime": "2021-05-20T00:00:00Z",
      "UserId": 1234567,
      "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",
        "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}",
        "EnablePrivateVpcConnection": false,
        "SourceSupplierName": "A有限公司"
      },
      "Parameters": "{\"param\":\"value\"}",
      "Progress": 90,
      "StatusDetail": "deploy successfully",
      "TemplateName": "模板1",
      "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "OperationStartTime": "2021-12-29T06:48:56Z",
      "OperationEndTime": "2021-12-29T06:48:56Z",
      "EnableInstanceOps": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Source": "Supplier",
      "EndTime": "2022-01-01T12:00:00",
      "ServiceType": "private",
      "PayType": "Subscription",
      "IsOperated": true,
      "ResourceGroupId": "si-d6ab3a63ccxxxxxx",
      "BizStatus": "Normal",
      "GrantedPermission": {
        "OperationEndTime": "",
        "PolicyNames": ""
      },
      "PolicyNames": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.