ListServices - 查询服务信息_计算巢服务(Compute Nest)-阿里云帮助中心

查询当前服务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
computenest:ListServices	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
MaxResults	integer	否	分页查询时每页行数。其中最大值为 100 行，默认值为 20 行。	20
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	BBBAAfu+XtuBE55iRLHEYYuojI4=
Filter	array<object>	否	过滤器。
	object	否	过滤器。
Value	array	否	过滤器值列表。
	string	否	过滤器值列表。N 的取值范围：1~10。	1
Name	string	否	过滤器名称，可选择一个或者多个名称进行查询。取值范围： ServiceId：服务 ID。 Name：服务名称。 Status：服务状态。 SupplierName：服务商名称。	Status
InUsed	boolean	否	是否被使用。可选值： false：没有被使用。 true：已被使用。	false
Tag	array<object>	否	用户自定义标签。
	object	否	用户自定义标签。
Key	string	否	标签键。	key1
Value	string	否	标签值。	value1
FuzzyKeyword	string	否	关键词模糊查询。	name
ServiceAccessType	string	否	服务访问类型。	All
OrderByType	string	否	服务排序类型	UpdateTime

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询开始 Token。	AAAAAfu+XtuBE55iRLHEYYuojI41
RequestId	string	请求 ID。	3F976EF8-C10A-57DC-917C-BB7BEB508FFB
TotalCount	integer	结果总数。	1
MaxResults	integer	分页查询时，每页显示的行数。每页最大 100 行，默认为 20 行。	20
Services	array<object>	服务列表。
Service	object	服务列表。
Status	string	服务状态。可能的值： Draft：草稿状态。 Submitted：已提交审核。不允许修改。 Approved：已通过审核。不允许修改，可以发布上线。 Launching：服务上线中。 Online：已上线。 Offline：已下线。	Online
PublishTime	string	发布时间。	2022-01-21T10:35:44Z
Version	string	服务版本。	4
DeployType	string	部署类型。可能值： ros：通过 ROS 部署。 terraform：通过 Terraform 部署。 spi：调用 SPI 部署。	ros
ServiceId	string	服务 ID。	service-6b5d632edd394dxxxxxx
SupplierUrl	string	服务商地址。	http://example.com
ServiceType	string	服务类型。可能值： private：部署在用户账户下。 managed：托管在服务商账户下。 operation：代运维服务。	private
SupplierName	string	服务商名称。	A有限公司
ServiceInfos	array<object>	服务信息。
ServiceInfo	object	服务信息。
Locale	string	服务配置语言。可能的值： zh-CN：中文。 en-US：英文。	zh-CN
Image	string	服务图标地址。	http://img.tidb.oss.url
Name	string	服务名称。	B数据库
ShortDescription	string	服务概述。	B是A公司自主设计并研发的开源分布式的关系型数据库
CommodityCode	string	云市场商品 code。	cmjj00xxxx
ServiceProductUrl	string	产品页 URL。	http://example1.com
Categories	string	数据盘的种类。取值范围： cloud_efficiency：高效云盘。 cloud_ssd：SSD 云盘。 cloud_essd：ESSD 云盘。 cloud：普通云盘。	cloud_ssd
VersionName	string	服务商自定义版本名称。	v2.0.0
DeployFrom	string	服务部署途径。可选值： NoWhere：没有部署途径。 Marketplace：从云市场部署。 ComputeNest：从计算巢部署。	ComputeNest
Score	integer	服务分数。	5
Tags	array<object>	服务标签。
Tag	object	服务标签。
Key	string	标签键。	key1
Value	string	标签值。	value1
TrialDuration	string	试用时长。单位：天。试用时长的最长天数不超过 30 天。	7
TrialType	string	试用类型。可选值： Trial：支持试用。 NotTrial：不支持试用。	Trial
TenantType	string	租户类型。可选值： SingleTenant：单租户。 MultiTenant：多租户。	SingleTenant
VirtualInternetService	string	是否是虚拟互联网服务。可能的值： false：否。 true：是。	false
SupplierUid	long	服务商 AliUid。	1436322xxxxx
Commodity	object	商品规格。
DeployPage	string	部署页面。	Order：下单页 Detail：详情页
CommodityCode	string	商品规格码。	cmjj00****
SupplierNameEng	string	服务商英文名称。	Alibaba Cloud

示例

正常返回示例

JSON格式

{
  "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": "A有限公司",
      "ServiceInfos": [
        {
          "Locale": "zh-CN",
          "Image": "http://img.tidb.oss.url",
          "Name": "B数据库",
          "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库"
        }
      ],
      "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： 下单页\nDetail： 详情页",
        "CommodityCode": "cmjj00****\n\n"
      },
      "SupplierNameEng": "Alibaba Cloud"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-09	OpenAPI 返回结构发生变更	查看变更详情