ListInstance - 查询实例列表-Chat App 消息服务(Chat App)-阿里云帮助中心

查询实例列表。

调试

您可以在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
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
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。