查询服务实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
computenestsupplier:ListServiceInstances |
list |
*ServiceInstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| NextToken |
string |
下一个查询开始 token |
AAAAAfu+XtuBE55iRLHEYYuojI4= |
| RequestId |
string |
请求的 ID。 |
E50287CB-AABF-4877-92C0-289B339A1546 |
| TotalCount |
integer |
结果总数。 |
100 |
| MaxResults |
integer |
分页查询时，每页显示的行数。每页最大 100 行，默认为 20 行。 |
20 |
| ServiceInstances |
array<object> |
服务实例信息。 |
|
|
array<object> |
服务实例信息。 |
||
| Status |
string |
服务实例状态。可能值：
|
Deployed |
| UpdateTime |
string |
更新时间。 |
2021-05-20T00:00:00Z |
| Name |
string |
服务实例名称。 |
TestName |
| ServiceInstanceId |
string |
服务实例 ID。 |
si-d6ab3a63ccbb4b17**** |
| CreateTime |
string |
创建时间。 |
2021-05-20T00:00:00Z |
| UserId |
integer |
用户 AliUid。 |
1234567 |
| Service |
object |
服务。 |
|
| Status |
string |
服务状态。 |
Online |
| PublishTime |
string |
发布时间。 |
2021-05-21T00:00:00Z |
| Version |
string |
服务版本。 |
1.0 |
| DeployType |
string |
部署类型。可能值：
|
ros |
| ServiceId |
string |
服务 ID。 |
service-0e6fca6a51a54420**** |
| SupplierUrl |
string |
服务商地址。 |
http://example.com |
| ServiceType |
string |
服务类型。可能值：
|
private |
| SupplierName |
string |
服务商名称。 |
A有限公司 |
| ServiceInfos |
array<object> |
服务信息。 |
|
|
object |
服务信息。 |
||
| Locale |
string |
服务实例语言。 |
zh-CN |
| Image |
string |
服务图标地址。 |
https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png |
| Name |
string |
服务名称。 |
B数据库 |
| ShortDescription |
string |
服务概述。 |
B是A公司自主设计并研发的开源分布式的关系型数据库 |
| VersionName |
string |
服务商自定义版本名称。 |
版本A |
| DeployMetadata |
string |
存储服务部署配置的信息。存储的信息与部署类型有关，不同的部署类型存储的数据格式不一样，因此使用 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" ] } ] } |
| EnablePrivateVpcConnection |
boolean |
是否已开启私网连接。可能的值：
|
false |
| SourceSupplierName |
string |
分销源服务商名称。 |
A有限公司 |
| Parameters |
string |
服务实例参数信息。 |
{"param":"value"} |
| Progress |
integer |
服务实例的部署进度，单位：%。 |
90 |
| StatusDetail |
string |
服务实例的部署信息描述。 |
deploy successfully |
| TemplateName |
string |
模板名称。 |
模板1 |
| OperatedServiceInstanceId |
string |
被代运维的服务实例 ID。 |
si-d6ab3a63ccbb4b17**** |
| OperationStartTime |
string |
代运维开始时间。 |
2021-12-29T06:48:56Z |
| OperationEndTime |
string |
代运维结束时间。 |
2021-12-29T06:48:56Z |
| EnableInstanceOps |
boolean |
服务实例是否有代运维功能。可能的值：
|
true |
| Tags |
array<object> |
用户自定义标签。 |
|
|
object |
用户自定义标签。 |
||
| Key |
string |
标签键。 |
key1 |
| Value |
string |
标签值。 |
value1 |
| Source |
string |
服务实例创建来源。 |
Supplier |
| EndTime |
string |
服务实例过期时间。 |
2022-01-01T12:00:00 |
| ServiceType |
string |
服务类型。可能的值：
|
private |
| PayType |
string |
付费类型。取值范围：
|
Subscription |
| IsOperated |
boolean |
服务实例的代运维功能是否开启。可能值：
|
true |
| ResourceGroupId |
string |
资源组 ID。 |
si-d6ab3a63ccxxxxxx |
| BizStatus |
string |
服务实例的业务状态。可能的值：
|
Normal |
| GrantedPermission |
object |
||
| OperationEndTime |
string |
||
| PolicyNames |
string |
||
| PolicyNames |
string |
示例
正常返回示例
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",
"GrantedPermission": {
"OperationEndTime": "",
"PolicyNames": ""
},
"PolicyNames": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。