支付宝

列出所有的租户实例（数据权限）

开发环境

http://dev-cn.your-api-server.com

GET

/v3/alipay/iservice/ccm/instance/query

alipay.iservice.ccm.instance

列出所有的租户实例（数据权限）。一个云客服租户下可以有多个租户实例（数据权限），每个租户实例之间的数据是隔离的（除了用户、权限、私信、IVR数据外）。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/v3/alipay/iservice/ccm/instance/query'

响应示例

200 - 示例 1

{
  "instances": [
    {
      "creator_id": "2018051101015016",
      "description": "我是描述信息",
      "external_id": "939459821",
      "id": "pYv_gs0m",
      "name": "XXX租户实例",
      "status": "STARTED",
      "updater_id": "2018051101015016",
      "create_time": {},
      "update_time": {}
    }
  ],
  "page_num": 1,
  "page_size": 10,
  "total_count": 100
}

请求参数

Query 参数

page_num

integer

可选

查询结果的页码，起始值为 1，默认值为 1

page_size

integer

可选

分页查询时设置的每页记录数，最大值 100 行，默认为 10

返回响应

🟢200common response

application/json

Body

instances

array[object (Instance) {9}]

租户实例列表

可选

creator_id

string

创建人id

可选

示例值:

2018051101015016

description

string

部门描述

可选

示例值:

我是描述信息

external_id

string

外部id

可选

示例值:

939459821

string

可选

部门id（即租户实例ID、数据权限ID）

示例值:

pYv_gs0m

name

string

可选

租户实例（数据权限）名称

示例值:

XXX租户实例

status

string

可选

租户实例（数据权限）状态，所有可能的状态如下：INIT（初始化）、STARTED（准备完成）、START_FAILED（准备失败）、STOPPING（停用中）、STOPPED（已停用）、RELEASING（释放中）、RELEASED（已释放）、RESUMING（重新启动）、MODIFING（修改规格中）、DELETED（已删除）。

示例值:

STARTED

updater_id

string

最后修改人id

可选

示例值:

2018051101015016

create_time

string

?创建时间

可选

示例值:

{}

update_time

string

最后修改时间

可选

示例值:

{}

page_num

integer

查询结果的页码

可选

示例值:

page_size

integer

可选

分页查询时设置的每页记录数

示例值:

total_count

integer

总条目数

可选

示例值:

100

🔴500请求失败

查询单个租户实例（数据权限）

租户开通isv服务接口