ListInstance - 查詢執行個體列表 - Chat App Message Service

查詢執行個體列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cams:ListInstance

list

*Instance

acs:cams:{#regionId}:{#accountId}:instance/*

無

請求參數

名稱	類型	必填	描述	樣本值
ChannelType	string	否	通道類型。取值： whatsapp。 messenger。 instagram。 viber。	VIBER
InstanceName	string	否	執行個體名稱。	viber_ins
SubmitTime	string	否	提交時間。	2023-12-12 00:00:00
PageSize	integer	否	每頁記錄條數。	87
PageIndex	integer	否	頁號	92
ResourceGroupId	string	否	執行個體所在的企業資源組 ID。	11
InstanceId	string	否	執行個體 ID。僅支援非阿里雲主機。	r-uf6wd7pkyjwxvlxfhk
FilterStr	string	否	過濾條件	aa

返回參數

名稱	類型	描述	樣本值
	object
AccessDeniedDetail	string	訪問被拒絕詳細資料。	{}
TotalCount	integer	滿足條件的記錄總數。	15
RequestId	string	請求 ID。	2993*****
Message	string	介面返回資訊	NULL
Data	array<object>	返回資料。
	object	返回資料。
CountryId	string	國家 ID。	1
ContactMail	string	聯絡郵箱	ma**@gmail.com
ResourceRegionId	string	資源所屬地區。	11
ResourceGroupId	string	資源群組 ID。	12
InstanceId	string	執行個體 ID。	29339****
OfficeAddress	string	企業地址。	example
SubmitTime	string	提交時間。	2023-12-12 00:00:00
InstanceName	string	執行個體名稱。	viber_ins
CustSpaceId	string	客戶 SpaceID。	dad-gf**
IsvTerms	string	Isv/Client 協議檔案名稱。	aa
FacebookBmId	string	綁定 facebook 的 id	1
InstanceDescription	string	執行個體描述資訊。	ins
ChannelType	string	通道類型。	VIBER
State	string	狀態	published
Code	string	請求狀態代碼。返回 OK 代表請求成功。其他錯誤碼，請參見錯誤碼列表。	OK
Success	boolean	是否調用成功： true：調用成功。 false：調用失敗。	true

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "{}",
  "TotalCount": 15,
  "RequestId": "2993*****",
  "Message": "NULL",
  "Data": [
    {
      "CountryId": "1",
      "ContactMail": "ma**@gmail.com",
      "ResourceRegionId": "11",
      "ResourceGroupId": "12",
      "InstanceId": "29339****",
      "OfficeAddress": "example",
      "SubmitTime": "2023-12-12 00:00:00",
      "InstanceName": "viber_ins",
      "CustSpaceId": "dad-gf**",
      "IsvTerms": "aa",
      "FacebookBmId": "1",
      "InstanceDescription": "ins",
      "ChannelType": "VIBER",
      "State": "published"
    }
  ],
  "Code": "OK",
  "Success": true
}

錯誤碼

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

變更歷史

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