文档

ListServiceInstances - 查询服务实例列表

更新时间:

查询服务实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenestsupplier:ListServiceInstancesList
  • ServiceInstance
    acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
MaxResultsinteger

分页查询时每页行数。其中最大值为 100 行,默认值为 20 行。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

BBBAAfu+XtuBE55iRLHEYYuojI4=
Filterarray<object>

过滤器。

object

过滤器。

Valuearray

过滤器值列表。

string

过滤器值列表。N 的取值范围:1~10。

value1
Namestring

过滤器名称,可选择一个或者多个名称进行查询。取值范围:

  • Name:按服务名称查询。 若您需要模糊搜索,则在 value 处输入内容格式为:xxx。例如服务名称为我的服务,在模糊搜索时,可输入我的或者服务进行搜索。

  • ServiceInstanceId:服务实例 ID

  • ServiceId:服务 ID

  • UserId:用户 ID

  • Version:服务版本

  • Status:服务实例状态

  • DeployType:部署类型

  • ServiceType:服务类型

  • OperationStartTimeBefore:代运维服务开始前

  • OperationStartTimeAfter:代运维服务开始后

  • OperationEndTimeBefore:代运维服务结束前

  • OperationEndTimeAfter:代运维服务结束后

  • OperatedServiceInstanceId:私有部署服务下代运维服务实例 ID

  • OperationServiceInstanceId:纯代运维服务下的服务实例 ID

  • EnableInstanceOps:服务实例是否开通代运维服务的功能

ServiceInstanceId
ShowDeletedboolean

是否显示已删除。可能的值:

  • true:显示

  • false:不显示

false
Tagarray<object>

用户自定义标签。

object

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
ResourceGroupIdstring

资源组 ID。

rg-aekzkt5buxxxxxx

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始 token

AAAAAfu+XtuBE55iRLHEYYuojI4=
RequestIdstring

请求的 ID。

E50287CB-AABF-4877-92C0-289B339A1546
TotalCountinteger

结果总数。

100
MaxResultsinteger

分页查询时,每页显示的行数。每页最大 100 行,默认为 20 行。

20
ServiceInstancesarray<object>

服务实例信息。

object

服务实例信息。

Statusstring

服务实例状态。可能值:

  • Created:已创建

  • Deploying:部署中

  • DeployedFailed:部署失败

  • Deployed:已部署

  • Upgrading:升级中

  • Deleting:删除中

  • Deleted:已删除

Deployed
UpdateTimestring

更新时间。

2021-05-20T00:00:00Z
Namestring

服务实例名称。

TestName
ServiceInstanceIdstring

服务实例 ID。

si-d6ab3a63ccbb4b17****
CreateTimestring

创建时间。

2021-05-20T00:00:00Z
UserIdlong

用户 AliUid。

1234567
Serviceobject

服务。

Statusstring

服务状态。

Online
PublishTimestring

发布时间。

2021-05-21T00:00:00Z
Versionstring

服务版本。

1.0
DeployTypestring

部署类型。可能值:

  • ros:通过 ROS 部署

  • terraform:通过 Terraform 部署

  • ack:通过 ACK 部署

  • spi:调用 SPI 部署

  • operation:代运维服务部署

ros
ServiceIdstring

服务 ID。

service-0e6fca6a51a54420****
SupplierUrlstring

服务商地址。

http://example.com
ServiceTypestring

服务类型。可能值:

  • private:部署在用户账户下

  • managed:托管在服务商账户下

  • operation:代运维服务

  • poc:试用服务实例。

private
SupplierNamestring

服务商名称。

A有限公司
ServiceInfosarray<object>

服务信息。

object

服务信息。

Localestring

服务实例语言。

zh-CN
Imagestring

服务图标地址。

https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png
Namestring

服务名称。

B数据库
ShortDescriptionstring

服务概述。

B是A公司自主设计并研发的开源分布式的关系型数据库
VersionNamestring

服务商自定义版本名称。

版本A
DeployMetadatastring

存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 JSON String 格式进行数据存储。

{ "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" ] } ] }
EnablePrivateVpcConnectionboolean

是否已开启私网连接。可能的值:

  • true:已开启

  • false:未开启

false
SourceSupplierNamestring

分销源服务商名称。

A有限公司
Parametersstring

服务实例参数信息。

{"param":"value"}
Progresslong

服务实例的部署进度,单位:%。

90
StatusDetailstring

服务实例的部署信息描述。

deploy successfully
TemplateNamestring

模板名称。

模板1
OperatedServiceInstanceIdstring

被代运维的服务实例 ID。

si-d6ab3a63ccbb4b17****
OperationStartTimestring

代运维开始时间。

2021-12-29T06:48:56Z
OperationEndTimestring

代运维结束时间。

2021-12-29T06:48:56Z
EnableInstanceOpsboolean

服务实例是否有代运维功能。可能的值:

  • true:服务实例有代运维功能

  • false:服务实例没有代运维功能

true
Tagsarray<object>

用户自定义标签。

object

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
Sourcestring

服务实例创建来源。

Supplier
EndTimestring

服务实例过期时间。

2022-01-01T12:00:00
ServiceTypestring

服务类型。可能的值:

  • private:部署在用户账户下的服务实例。

  • managed:托管在服务商账户下的服务实例。

  • operation:代运维服务实例

  • poc:试用服务实例。

private
PayTypestring

付费类型。取值范围:

  • Permanent:永久购买。

  • Subscription:云市场包年包月。

  • PayAsYouGo:云市场按量付费。

  • CustomFixTime:商家自定义固定时长。

Subscription
IsOperatedboolean

服务实例的代运维功能是否开启。可能值:

  • true:服务实例的代运维功能已开启

  • false:服务实例的代运维功能未开启

true
ResourceGroupIdstring

资源组 ID。

si-d6ab3a63ccxxxxxx
BizStatusstring

服务实例的业务状态。可能的值:

  • Normal:正常。

  • Renewing:续费中。

  • RenewFoiled:续费失败。

  • Expired:已过期。

Normal

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-15OpenAPI 返回结构发生变更查看变更详情
2023-08-11OpenAPI 返回结构发生变更查看变更详情
2023-08-08OpenAPI 返回结构发生变更查看变更详情
2023-07-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-03-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-07-22新增 OpenAPI查看变更详情