查询服务实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| computenestsupplier:ListServiceInstances | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。 | cn-hangzhou |
| MaxResults | integer | 否 | 分页查询时每页行数。其中最大值为 100 行，默认值为 20 行。 | 10 |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | BBBAAfu+XtuBE55iRLHEYYuojI4= |
| Filter | array<object> | 否 | 过滤器。 | |
| object | 否 | 过滤器。 | ||
| Value | array | 否 | 过滤器值列表。 | |
| string | 否 | 过滤器值列表。N 的取值范围：1~10。 | value1 | |
| Name | string | 否 | 过滤器名称，可选择一个或者多个名称进行查询。取值范围：
| ServiceInstanceId |
| ShowDeleted | boolean | 否 | 是否显示已删除。可能的值：
| false |
| Tag | array<object> | 否 | 用户自定义标签。 | |
| object | 否 | 用户自定义标签。 | ||
| Key | string | 否 | 标签键。 | key1 |
| Value | string | 否 | 标签值。 | value1 |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-aekzkt5buxxxxxx |
返回参数
示例
正常返回示例
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-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-06 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-17 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-07-22 | 新增 OpenAPI | 查看变更详情 |