ListServices - Compute Nest - Alibaba Cloud Documentation Center

Queries for a list of services based on specified parameters, such as a region ID and service IDs. The returned information includes the service status, service version, and publish time.

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

list

*Service

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

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.	10
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the NextToken value returned by a previous call.	BBBAAfu+XtuBE55iRLHEYYuojI4=
AllVersions	boolean	No	Specifies whether to return all versions of the service. The default value is false. If this parameter is set to false, only the default version of each service is returned.	false
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzkt5bu****
Filter	array<object>	No	The filter.
	object	No	The filter.
Value	array	No	The filter values.
	string	No	The filter values. You can specify up to 10 values.	1
Name	string	No	The name of the filter. You can query by one or more filter names. Valid values: ServiceId: The service ID. Name: The service name. Status: The service status. SupplierName: The name of the service provider.	Status
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

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that is used to retrieve the next page of results.	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	The request ID.	51945B04-6AA6-410D-93BA-236E0248B104
TotalCount	integer	The total number of entries that meet the filter criteria.	100
MaxResults	integer	The number of entries returned on each page. Maximum value: 100. Default value: 20.	1
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. Modifications are not allowed. Approved: The service is approved. Modifications are not allowed. The service can be published. Launching: The service is being published. Online: The service is published. Offline: The service is unpublished.	Online
DefaultVersion	boolean	Indicates whether the service is the default version. Valid values: false: The service is not the default version. true: The service is the default version.	true
PublishTime	string	The time when the service was published.	2021-05-21T00:00:00Z
Version	string	The service version.	1.0
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 an SPI. operation: The service is deployed using Alibaba Cloud Managed Services. container: The service is deployed using a container.	ros
ServiceId	string	The service ID.	service-70a3b15bb62643****
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: It 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 configuration. Valid values: zh-CN: Chinese. en-US: English.	zh-CN
Image	string	The URL of the service icon.	http://img.example.oss.url
Name	string	The service name.	B数据库
ShortDescription	string	A brief description of the service.	B是A公司自主设计并研发的开源分布式的关系型数据库
CommodityCode	string	The commodity code of the service in Alibaba Cloud Marketplace.	cmjj00****
CreateTime	string	The time when the service was created.	2021-05-20T00:00:00Z
UpdateTime	string	The time when the service was last updated.	2021-05-21T00:00:00Z
ShareType	string	The sharing type. Valid values: Public: Public. Official and trial deployments are not restricted. Restricted: Restricted. Official and trial deployments are restricted. OnlyFormalRestricted: Only official deployments are restricted. OnlyTrailRestricted: Only trial deployments are restricted. Hidden: Hidden. The service is not visible and you cannot request deployment permissions.	Public
ApprovalType	string	The approval type for service usage requests. Valid values: Manual: Manual approval. AutoPass: Automatic approval.	AutoPass
VersionName	string	The custom version name defined by the service provider.	v2.0.0
Tags	array<object>	The service tags.
	object	The service tags.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
ArtifactId	string	The artifact ID.	artifact-21ca53ac16a643****
ArtifactVersion	string	The artifact version.	draft
SourceImage	string	The source image.	centos_7
RelationType	string	The artifact association type. Valid values: ServiceDeployment: Service deployment. ServiceUpgrade: Service upgrade.	ServiceDeployment
TrialType	string	The trial policy. Valid values: Trial: The service supports a trial. NotTrial: The service does not support a trial.	Trial
TenantType	string	The tenant type for the managed service. Valid values: SingleTenant: Single-tenant. MultiTenant: Multi-tenant.	SingleTenant
ResourceGroupId	string	The ID of the resource group.	rg-aekz5b555****
SourceServiceId	string	The ID of the source service for distribution.	service-70a3b15bb62643****
SourceServiceVersion	string	The version of the source service for distribution.	1
SourceSupplierName	string	The name of the source service provider for distribution.	SourceSupplier
ResellServiceId	string	The ID of the distributed service.	service-70a3b15bb62643****
LatestResellSourceServiceVersion	string	The latest version of the source service for distribution.	1
ResellApplyStatus	string	The distribution authorization status of the service. Valid values: CanApply: You can apply for authorization. Applied: An application has been submitted. Approved: The application is approved.	CanApply
VirtualInternetService	string	Indicates whether the service is a virtual Internet service. Valid values: false: No. true: Yes.	false
Categories	string	The service category.	OpenSource
ServiceDiscoverable	string	Indicates whether the service is discoverable. Valid values: INVISIBLE: Not discoverable. DISCOVERABLE: Discoverable.	INVISIBLE
HasDraft	boolean	Indicates whether the service has a draft version. Valid values: true: Yes. false: No.	true
HasBeta	boolean	Indicates whether the service has a beta version. Valid values: true: Yes. false: No.	true
BuildInfo	string	The information about the service build.	{ "RepoUrl": "https://github.com/user/example.git", "Brancn": "main"}
Commodity	object	The commodity specifications.
CommodityCode	string	The commodity code.	cmjj00****
Type	string	The type. Valid values: Marketplace: Alibaba Cloud Marketplace. Css: Lingxiao. SaasBoost: SaaS Boost.	Marketplace
SaasBoostMetadata	string	The metadata of the SaaS Boost configuration.	{ //开启/关闭SaaS Boost绑定 "Enabled":true/false,默认为false //公网交互地址 "PublicAccessUrl":"https://example.com" }
ServiceLocaleConfigs	array<object>	The multi-language configurations of the service.
	object	The multi-language configurations of the service.
OriginalValue	string	The original 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+XtuBE55iRLHEYYuojI4=",
  "RequestId": "51945B04-6AA6-410D-93BA-236E0248B104",
  "TotalCount": 100,
  "MaxResults": 1,
  "Services": [
    {
      "Status": "Online",
      "DefaultVersion": true,
      "PublishTime": "2021-05-21T00:00:00Z",
      "Version": "1.0",
      "DeployType": "ros",
      "ServiceId": "service-70a3b15bb62643****",
      "SupplierUrl": "http://example.com",
      "ServiceType": "private",
      "SupplierName": "A有限公司",
      "ServiceInfos": [
        {
          "Locale": "zh-CN",
          "Image": "http://img.example.oss.url",
          "Name": "B数据库",
          "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库"
        }
      ],
      "CommodityCode": "cmjj00****",
      "CreateTime": "2021-05-20T00:00:00Z",
      "UpdateTime": "2021-05-21T00:00:00Z",
      "ShareType": "Public",
      "ApprovalType": "AutoPass",
      "VersionName": "v2.0.0",
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "ArtifactId": "artifact-21ca53ac16a643****",
      "ArtifactVersion": "draft",
      "SourceImage": "centos_7",
      "RelationType": "ServiceDeployment",
      "TrialType": "Trial",
      "TenantType": "SingleTenant",
      "ResourceGroupId": "rg-aekz5b555****",
      "SourceServiceId": "service-70a3b15bb62643****",
      "SourceServiceVersion": "1",
      "SourceSupplierName": "SourceSupplier",
      "ResellServiceId": "service-70a3b15bb62643****",
      "LatestResellSourceServiceVersion": "1",
      "ResellApplyStatus": "CanApply",
      "VirtualInternetService": "false",
      "Categories": "OpenSource",
      "ServiceDiscoverable": "INVISIBLE",
      "HasDraft": true,
      "HasBeta": true,
      "BuildInfo": "{ \"RepoUrl\": \"https://github.com/user/example.git\", \"Brancn\": \"main\"}",
      "Commodity": {
        "CommodityCode": "cmjj00****",
        "Type": "Marketplace",
        "SaasBoostMetadata": "{\n     //开启/关闭SaaS Boost绑定\n    \"Enabled\":true/false,默认为false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}"
      },
      "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.