查詢服務實例列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| computenestsupplier:ListServiceInstances | list | *ServiceInstance acs:computenestsupplier:{#regionId}:{#accountId}: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 |
返回參數
示例
正常返回示例
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 | 查看變更詳情 |