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

通过指定地域ID、服务ID等参数，查询服务信息列表。例如，服务状态，服务版本，发布时间等信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
computenestsupplier:ListServices	list	Service acs:computenestsupplier:{#regionId}:{#accountId}:service/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
MaxResults	integer	否	分页查询时每页行数。其中最大值为 100 行，默认值为 20 行。	10
NextToken	string	否	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	BBBAAfu+XtuBE55iRLHEYYuojI4=
AllVersions	boolean	否	返回服务的所有版本。默认值为 false，对每个服务只返回默认版本。	false
ResourceGroupId	string	否	资源组 ID。	rg-aekzkt5buxxxxxx
Filter	array<object>	否	过滤器。
	object	否	过滤器。
Value	array	否	过滤器值列表。
	string	否	过滤器值列表。N 的取值范围：1~10。	1
Name	string	否	过滤器名称，可选择一个或者多个名称进行查询。取值范围： ServiceId：服务 ID。 Name：服务名称。 Status：服务状态。 SupplierName：服务商名称。	Status
Tag	array<object>	否	用户自定义标签。
	object	否	用户自定义标签。
Key	string	否	标签键。	key1
Value	string	否	标签值。	value1

返回参数

名称	类型	描述	示例值
	object
NextToken	string	下一个查询开始 token。	AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestId	string	请求 ID。	51945B04-6AA6-410D-93BA-236E0248B104
TotalCount	integer	符合条件的记录总数。	100
MaxResults	integer	分页查询时每页行数。其中最大值为 100 行，默认值为 20 行。	1
Services	array<object>	服务列表。
Service	object	服务列表。
Status	string	服务状态。可能的值： Draft：草稿状态。 Submitted：已提交审核。不允许修改。 Approved：已通过审核。不允许修改，可以发布上线。 Launching：服务上线中。 Online：已上线。 Offline：已下线。	Online
DefaultVersion	boolean	共享权限是否为默认版本。取值： false：不是默认版本。 true：是默认版本。	true
PublishTime	string	发布时间。	2021-05-21T00:00:00Z
Version	string	服务版本。	1.0
DeployType	string	部署类型。可能值： ros：通过 ROS 部署。 terraform：通过 Terraform 部署。 spi：调用 SPI 部署。 operation：代运维服务部署。 container：通过容器部署。 pkg：包服务。	ros
ServiceId	string	服务 ID。	service-70a3b15bb62643xxxxxx
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
CreateTime	string	创建时间。	2021-05-20T00:00:00Z
UpdateTime	string	更新时间。	2021-05-21T00:00:00Z
ShareType	string	共享类型。可能的值： Public：公开的，正式部署和试用部署都不受限。 Restricted：受限的，正式部署和试用部署都受限。 OnlyFormalRestricted：仅正式部署受限。 OnlyTrailRestricted：仅试用部署受限。 Hidden：隐藏的，不可见且不可申请部署权限。	Public
ApprovalType	string	服务使用申请审批类型，可能的值： Manual：手动审批。 AutoPass：自动通过。	AutoPass
VersionName	string	服务商自定义版本名称。	v2.0.0
Tags	array<object>	服务标签。
Tag	object	服务标签。
Key	string	标签键。	key1
Value	string	标签值。	value1
ArtifactId	string	部署物 ID。	artifact-21ca53ac16a643xxxxxx
ArtifactVersion	string	部署物版本。	draft
SourceImage	string	源镜像。	centos_7
RelationType	string	部署物关联类型。可能的值： ServiceDeployment：服务部署。 ServiceUpgrade：服务升级。	ServiceDeployment
TrialType	string	试用类型。可选值： Trial：支持试用。 NotTrial：不支持试用。	Trial
TenantType	string	托管版服务的租户类型。可能的值： SingleTenant：单租户。 MultiTenant：多租户。	SingleTenant
ResourceGroupId	string	资源组 ID。	rg-aekz5b555xxxxxx
SourceServiceId	string	分销源服务 ID。	service-70a3b15bb62643xxxxxx
SourceServiceVersion	string	分销源服务版本。	1
SourceSupplierName	string	分销源服务商名称。	SourceSupplier
ResellServiceId	string	分销服务 ID。	service-70a3b15bb62643xxxxxx
LatestResellSourceServiceVersion	string	最新的分销源服务版本。	1
ResellApplyStatus	string	服务的分销授权状态。可能的值： CanApply：可申请。 Applied：已申请。 Approved：已通过。	CanApply
VirtualInternetService	string	是否是虚拟互联网服务。可能的值： false：否。 true：是。	false
Categories	string	服务分类。	OpenSource
ServiceDiscoverable	string	服务是否可发现。可能的值： INVISIBLE：不可发现。 DISCOVERABLE：可发现。	INVISIBLE
HasDraft	boolean	当前服务是否有 Draft 版本。可能的值： true：是。 false：否。	true
HasBeta	boolean	当前服务是否有 Beta 版本。可能的值： true：是。 false：否。	true
BuildInfo	string	构建服务信息。	{ "RepoUrl": "https://github.com/user/repo.git", "Brancn": "main"}
Commodity	object	商品规格。
CommodityCode	string	商品 code。	cmjj00xxxx
Type	string	类型。可能的值： Marketplace：云市场。 Css：凌霄。 SaasBoost：Saas Boost。	Marketplace
SaasBoostMetadata	string	SaasBoost 配置元数据。	{ //开启/关闭SaaS Boost绑定 "Enabled":true/false,默认为false //公网交互地址 "PublicAccessUrl":"https://example.com" }

示例

正常返回示例

JSON格式

{
  "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-70a3b15bb62643xxxxxx",
      "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",
      "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-21ca53ac16a643xxxxxx",
      "ArtifactVersion": "draft",
      "SourceImage": "centos_7",
      "RelationType": "ServiceDeployment",
      "TrialType": "Trial",
      "TenantType": "SingleTenant",
      "ResourceGroupId": "rg-aekz5b555xxxxxx",
      "SourceServiceId": "service-70a3b15bb62643xxxxxx",
      "SourceServiceVersion": "1",
      "SourceSupplierName": "SourceSupplier",
      "ResellServiceId": "service-70a3b15bb62643xxxxxx",
      "LatestResellSourceServiceVersion": "1",
      "ResellApplyStatus": "CanApply",
      "VirtualInternetService": "false",
      "Categories": "OpenSource",
      "ServiceDiscoverable": "INVISIBLE",
      "HasDraft": true,
      "HasBeta": true,
      "BuildInfo": "{ \"RepoUrl\": \"https://github.com/user/repo.git\", \"Brancn\": \"main\"}",
      "Commodity": {
        "CommodityCode": "cmjj00xxxx",
        "Type": "Marketplace",
        "SaasBoostMetadata": "{\n     //开启/关闭SaaS Boost绑定\n    \"Enabled\":true/false,默认为false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}"
      }
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-10	OpenAPI 返回结构发生变更	查看变更详情
2024-04-19	OpenAPI 返回结构发生变更	查看变更详情
2023-12-14	OpenAPI 返回结构发生变更	查看变更详情
2023-10-19	OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 返回结构发生变更	查看变更详情
2023-10-16	OpenAPI 返回结构发生变更	查看变更详情
2023-09-21	OpenAPI 返回结构发生变更	查看变更详情
2023-09-15	OpenAPI 返回结构发生变更	查看变更详情
2023-08-11	OpenAPI 返回结构发生变更	查看变更详情
2023-08-08	OpenAPI 返回结构发生变更	查看变更详情
2023-05-08	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-08-18	OpenAPI 入参发生变更	查看变更详情
2022-07-22	新增 OpenAPI	查看变更详情
2021-12-02	OpenAPI 返回结构发生变更	查看变更详情
2021-09-22	OpenAPI 入参发生变更	查看变更详情