使用ListServiceInstances查詢服務執行個體-計算巢服務-阿里雲

通過地區 ID，資源ID等參數，查詢當前帳號在某地區下所有服務執行個體列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

computenest:ListServiceInstances

list

*ServiceInstance

acs:computenest:{#regionId}:{#accountId}:serviceinstance/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。	cn-hangzhou
MaxResults	integer	否	分頁查詢時，每頁顯示的行數。每頁最大 100 行，預設為 20 行。	20
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	BBBAAfu+XtuBE55iRLHEYYuojI4=
Filter	array<object>	否	過濾器。
	object	否	過濾器。
Value	array	否	過濾器值列表。
	string	否	過濾器值列表。N 的取值範圍：1~10。	value1
Name	string	否	過濾器名稱，可選擇一個或者多個名稱進行查詢。取值範圍： Name：按服務名稱查詢。若您需要模糊搜尋，則在 value 處輸入內容格式為：xxx。例如服務名稱為我的服務，在模糊搜尋時，可輸入我的或者服務進行搜尋。 ServiceInstanceName：按服務執行個體名稱查詢，當輸入一個服務執行個體名稱時進行模糊查詢；當輸入多個服務執行個體名稱時進行精確查詢。 ServiceInstanceId：服務執行個體 ID。 ServiceId：服務 ID。 Version：服務版本。 Status：服務執行個體狀態。 DeployType：部署類型。 ServiceType：服務類型。 OperationStartTimeBefore：代營運服務開始前。 OperationStartTimeAfter：代營運服務開始後。 OperationEndTimeBefore：代營運服務結束前。 OperationEndTimeAfter：代營運服務結束後。 OperatedServiceInstanceId：私人部署服務下代營運服務執行個體 ID。 OperationServiceInstanceId：純代營運服務下的服務執行個體 ID。 EnableInstanceOps：服務執行個體是否開通代營運服務的功能。	ServiceInstanceId
Tag	array<object>	否	使用者自訂標籤。
	object	否	使用者自訂標籤。
Key	string	否	標籤鍵。	key1
Value	string	否	標籤值。	value1
ResourceGroupId	string	否	資源群組 ID。	rg-bp67acfmxazb4p****

返回參數

名稱	類型	描述	樣本值
	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>	服務執行個體資訊。
Name	string	服務執行個體名稱。	TestName
Status	string	服務執行個體狀態。可能值： Created：已建立。 Deploying：部署中。 DeployedFailed：部署失敗。 Deployed：已部署。 Upgrading：升級中。 Deleting：刪除中。 Deleted：已刪除。 DeletedFailed：刪除失敗。	Deployed
Outputs	string	服務執行個體輸出資訊。	{"managementUrl": "http://xx.xx"}
UpdateTime	string	更新時間。	2021-05-20T00:00:00Z
Parameters	string	服務執行個體參數資訊。	{"param":"value"}
ServiceInstanceId	string	服務執行個體 ID。	si-d6ab3a63ccbb4b17****
CreateTime	string	建立時間。	2021-05-20T00:00:00Z
StatusDetail	string	服務執行個體的部署資訊描述。	deploy successfully
Progress	integer	服務執行個體的部署進度，單位：%。	90
Resources	string	資源清單。	[{"StackId": "stack-xxx"}]
TemplateName	string	模板名稱。	模板1
OperatedServiceInstanceId	string	被代營運的服務執行個體 ID。	si-d6ab3a63ccbb4b17****
Service	object	服務。
Status	string	服務狀態。	Online
PublishTime	string	發布時間。	2021-05-21T00:00:00Z
Version	string	服務版本。	1.0
DeployType	string	部署類型。可能值： ros：通過 ROS 部署。 terraform：通過 Terraform 部署。 ack：通過 ACK 部署。 spi：調用 SPI 部署。 operation：代營運服務部署。	ros
ServiceId	string	服務 ID。	service-0e6fca6a51a54420****
SupplierUrl	string	服務商地址。	http://example.com
ServiceType	string	服務類型。可能值： private：部署在使用者賬戶下。 managed：託管在服務商賬戶下。 operation：代營運服務。	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
Commodity	object	商品規格。
SaasBoostMetadata	string	SaasBoost 配置中繼資料。	{ //開啟/關閉SaaS Boost綁定 "Enabled":true/false,預設為false //公網互動地址 "PublicAccessUrl":"https://example.com" }
Type	string	類型。可能的值： Marketplace：雲市場。 Css：淩霄。 SaasBoost：Saas Boost。	Marketplace
OperationStartTime	string	代營運開始時間。	2021-12-29T06:48:56Z
OperationEndTime	string	代營運結束時間。	2022-01-28T06:48:56Z
EnableInstanceOps	boolean	服務執行個體是否有代營運功能。可能的值： true：服務執行個體有代營運功能。 false：服務執行個體沒有代營運功能。	true
Tags	array<object>	使用者自訂標籤。
	object	使用者自訂標籤。
Key	string	標籤鍵。	key1
Value	string	標籤值。	value1
Source	string	服務執行個體建立來源。	Supplier
EndTime	string	服務執行個體到期時間。	2022-01-01T12:00:00
ServiceType	string	服務類型。可能的值： private：部署在使用者賬戶下。 managed：託管在服務商賬戶下。 operation：代營運服務。 poc：試用服務執行個體。	private
PayType	string	付費類型。取值範圍： Permanent：永久購買。 Subscription：雲市場訂用帳戶。 PayAsYouGo：雲市場隨用隨付。 CustomFixTime：商家自訂固定時間長度。	Subscription
MarketInstanceId	string	雲市場執行個體 ID。	5827****
ResourceGroupId	string	資源群組 ID。	rg-aekz6scpcxxxxxx
BizStatus	string	服務執行個體的業務狀態。可能的值： Normal：正常。 Renewing：續約中。 RenewFoiled：續約失敗。 Expired：已到期。	Normal
OrderId	string	訂單 ID。	2306175xxxxxxxx
SupportTrialToPrivate	boolean	是否支援試用轉正式
PolicyNames	string
GrantedPermission	object
OperationEndTime	string
PolicyNames	string

樣本

正常返回樣本

JSON格式

{
  "NextToken": "AAAAAfu+XtuBE55iRLHEYYuojI4=",
  "RequestId": "E50287CB-AABF-4877-92C0-289B339A1546",
  "TotalCount": 100,
  "MaxResults": 20,
  "ServiceInstances": [
    {
      "Name": "TestName",
      "Status": "Deployed",
      "Outputs": "{\"managementUrl\": \"http://xx.xx\"}",
      "UpdateTime": "2021-05-20T00:00:00Z",
      "Parameters": "{\"param\":\"value\"}",
      "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "CreateTime": "2021-05-20T00:00:00Z",
      "StatusDetail": "deploy successfully",
      "Progress": 90,
      "Resources": "[{\"StackId\": \"stack-xxx\"}]",
      "TemplateName": "模板1",
      "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
      "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",
        "Commodity": {
          "SaasBoostMetadata": "{\n     //開啟/關閉SaaS Boost綁定\n    \"Enabled\":true/false,預設為false\n    //公網互動地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}",
          "Type": "Marketplace"
        }
      },
      "OperationStartTime": "2021-12-29T06:48:56Z",
      "OperationEndTime": "2022-01-28T06:48:56Z",
      "EnableInstanceOps": true,
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "Source": "Supplier",
      "EndTime": "2022-01-01T12:00:00",
      "ServiceType": "private",
      "PayType": "Subscription",
      "MarketInstanceId": "5827****",
      "ResourceGroupId": "rg-aekz6scpcxxxxxx",
      "BizStatus": "Normal",
      "OrderId": "2306175xxxxxxxx",
      "SupportTrialToPrivate": true,
      "PolicyNames": "",
      "GrantedPermission": {
        "OperationEndTime": "",
        "PolicyNames": ""
      }
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。