List & Filter Services via ListServices API - Compute Nest - Alibaba Cloud - Compute Nest

Queries information about your services.

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

get

*All Resource

*

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 token that is used to retrieve the next page of results. Set this 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 filter values.
	string	No	The filter values. The value of N can be from 1 to 10.	1
Name	string	No	The filter name. You can specify one or more filter names to query services. Valid values: ServiceId: The service ID. Name: The service name. Status: The service status. SupplierName: The service provider name.	Status
InUsed	boolean	No	Specifies whether the service is in use. Valid values: false: The service is not in use. true: The service is in use.	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
FuzzyKeyword	string	No	The keyword for a fuzzy query.	name
ServiceAccessType	string	No	The service access type.	All
OrderByType	string	No	The sorting type for services.	UpdateTime

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token for the next query.	AAAAAfu+XtuBE55iRLHEYYuojI41
RequestId	string	The request ID.	3F976EF8-C10A-57DC-917C-BB7BEB508FFB
TotalCount	integer	The total number of results.	1
MaxResults	integer	The number of entries returned per page. Maximum value: 100. Default value: 20.	20
Services	array<object>	The list of services.
	object	The list of services.
Status	string	The service status. Valid values: Draft: The service is in the draft state. Submitted: The service is submitted for review. You cannot modify the service. Approved: The service is approved. You cannot modify the service, but you can publish it. Launching: The service is being published. Online: The service is published. Offline: The service is unpublished.	Online
PublishTime	string	The time when the service was published.	2022-01-21T10:35:44Z
Version	string	The service version.	4
DeployType	string	The deployment type. Valid values: ros: The service is deployed using ROS. terraform: The service is deployed using Terraform. spi: The service is deployed by calling SPI.	ros
ServiceId	string	The service ID.	service-6b5d632edd394dxxxxxx
SupplierUrl	string	The service provider's URL.	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 service provider name.	ACo., Ltd.
ServiceInfos	array<object>	The service information.
	object	The service information.
Locale	string	The language of the service configuration. Valid values: zh-CN: Chinese. en-US: English.	zh-CN
Image	string	The URL of the service icon.	http://img.tidb.oss.url
Name	string	The service name.	Bdatabase
ShortDescription	string	The service overview.	Bis an open-source distributed relational database independently designed and developed
Softwares	array<object>	The software information of the service.
	object	The software information of the service.
Name	string	The software name.	wordpress
Version	string	The software version.	6.0.1
CommodityCode	string	The commodity code of the service in Alibaba Cloud Marketplace.	cmjj00xxxx
ServiceProductUrl	string	The URL of the product page.	http://example1.com
Categories	string	The category of the data disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: ESSD. cloud: basic disk.	cloud_ssd
VersionName	string	The custom version name defined by the service provider.	v2.0.0
DeployFrom	string	The deployment source of the service. Valid values: NoWhere: The service has no deployment source. Marketplace: The service is deployed from Alibaba Cloud Marketplace. ComputeNest: The service is deployed from Compute Nest.	ComputeNest
Score	integer	The service score.	5
Tags	array<object>	The service tags.
	object	The service tags.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
TrialDuration	string	The trial duration. Unit: days. The maximum trial duration is 30 days.	7
TrialType	string	The trial type. Valid values: Trial: The service supports trial. NotTrial: The service does not support trial.	Trial
TenantType	string	The tenant type. Valid values: SingleTenant: single-tenant. MultiTenant: multi-tenant.	SingleTenant
VirtualInternetService	string	Indicates whether the service is a virtual Internet service. Valid values: false: No. true: Yes.	false
SupplierUid	integer	The Alibaba Cloud account ID of the service provider.	1436322xxxxx
Commodity	object	The commodity specifications.
DeployPage	string	The deployment page.	Order: Order page Detail: Details page
CommodityCode	string	The commodity specification code.	cmjj00****
SupplierNameEng	string	The English name of the service provider.	Alibaba Cloud
ServiceLocaleConfigs	array<object>	The multi-language configurations of the service.
	object	The multi-language configurations of the service.
OriginalValue	string	The raw data value of the business information.	Service Name
ZhValue	string	The Chinese value of the business information.	服务名称
EnValue	string	The English value of the business information.	Service Name

Examples

Success response

JSON format

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI41",
  "RequestId": "3F976EF8-C10A-57DC-917C-BB7BEB508FFB",
  "TotalCount": 1,
  "MaxResults": 20,
  "Services": [
    {
      "Status": "Online",
      "PublishTime": "2022-01-21T10:35:44Z",
      "Version": "4",
      "DeployType": "ros",
      "ServiceId": "service-6b5d632edd394dxxxxxx",
      "SupplierUrl": "http://example.com",
      "ServiceType": "private",
      "SupplierName": "ACo., Ltd.",
      "ServiceInfos": [
        {
          "Locale": "zh-CN",
          "Image": "http://img.tidb.oss.url",
          "Name": "Bdatabase",
          "ShortDescription": "Bis an open-source distributed relational database independently designed and developed",
          "Softwares": [
            {
              "Name": "wordpress",
              "Version": "6.0.1"
            }
          ]
        }
      ],
      "CommodityCode": "cmjj00xxxx",
      "ServiceProductUrl": "http://example1.com",
      "Categories": "cloud_ssd",
      "VersionName": "v2.0.0",
      "DeployFrom": "ComputeNest",
      "Score": 5,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "TrialDuration": "7",
      "TrialType": "Trial",
      "TenantType": "SingleTenant",
      "VirtualInternetService": "false",
      "SupplierUid": 0,
      "Commodity": {
        "DeployPage": "Order: Order page\nDetail: Details page",
        "CommodityCode": "cmjj00****\n\n"
      },
      "SupplierNameEng": "Alibaba Cloud",
      "ServiceLocaleConfigs": [
        {
          "OriginalValue": "Service Name\n",
          "ZhValue": "服务名称",
          "EnValue": "Service Name\n"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.