调用ListInstances分页获取当前租户下智能导航实例列表_智能语音导航（文档停止维护）(Voice Navigator)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListInstances	系统规定参数。取值：ListInstances。
PageNumber	Integer	是	1	页号
PageSize	Integer	是	10	每页条数
NluServiceTypeListJsonString	String	否	["CCC_AUTHORIZED"]	nlu类型,对话能力来源筛选条件。不填则全选。 MANAGED：托管【已废弃】 AUTHORIZED：授权，公共云：智能对话机器人服务 PROVIDED：私有，通过在运维控制台配置as、sk、以及chatEndpoint等。 CCC_AUTHORIZED：使用云联络中心授权的小蜜机器人 CCC_FUNCTION：使用阿里函数计算服务 SSE_FUNCTION：使用流式函数服务，支持SSE的函数计算，用于对接三方大模型对话机器人 PROMPTS：对接qwen基模等 LOCAL：专有云，本地基蜜
UnionSource	String	否	CCC	来源。 CCC ：云联络中心
UnionInstanceId	String	否	zhyl	实例ID 说明当UnionSource为CCC时，UnionInstanceId填入云联络中心的实例ID。
Name	String	否	测试	场景名称筛选条件
Status	String	否	PUBLISHED	当前场景状态筛选条件，当为空时则默认为全选。 DISABLED：已下线 PUBLISHED：已发布
Number	String	否	021xxxxxxx	呼入号码筛选条件
InstanceIdListJsonString	String	否	["e4bebxxxxxxxxxxx"]	数字员工场景ID列表

返回数据

名称	类型	示例值	描述
Instances	Array of Instance		实例数组
Status	String	Published	实例状态
ModifyUserName	String	xxx	操作人
Description	String	测试的实例	描述
ApplicableOperations	Array of String	["Edit", "Publish", "Duplicate", "Delete", "ListHistories"]	实例可操作列表
InstanceId	String	dc437bba-5a25-4bbc-b4c2-f268864bebb5	实例id
Name	String	测试实例	名字
Concurrency	Long	10	并发数
ModifyTime	Long	1582266750353	修改时间
Numbers	Array of String	021xxxxxxxx	呼入号码
CreateTime	Long	1697596919519	创建时间
UnionSource	String	CCC	来源。 CCC ：云联络中心
UnionInstanceId	String	zhyl	实例ID 说明当UnionSource为CCC时，UnionInstanceId填入云联络中心的实例ID。
NluServiceParamsJson	String	{"agentId":"1213503","isCCCAgent":"true","agentKey":"107e04a7519243eb83c9b549ea3b6829_p_ccc_public"}	大模型服务参数JSON
TotalCount	Integer	1	总数量
PageSize	Integer	10	个数
RequestId	String	A8AED3C8-F57B-5D71-9A34-4A170287533F	请求id
PageNumber	Integer	2	页号

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&PageNumber=1
&PageSize=10
&NluServiceTypeListJsonString=["CCC_AUTHORIZED"]
&UnionSource=CCC
&UnionInstanceId=zhyl
&Name=测试
&Status=PUBLISHED
&Number=021xxxxxxx
&InstanceIdListJsonString=["e4bxxxxxxxxxx"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListInstancesResponse>
    <Instances>
        <Status>Published</Status>
        <ModifyUserName>xxx</ModifyUserName>
        <Description>测试的实例</Description>
        <ApplicableOperations>Edit</ApplicableOperations>
        <InstanceId>dc437bba-5a25-4bbc-b4c2-f268864bebb5</InstanceId>
        <Name>测试实例</Name>
        <Concurrency>10</Concurrency>
        <ModifyTime>1582266750353</ModifyTime>
        <Numbers>021xxxxxxxx</Numbers>
        <CreateTime>1697596919519</CreateTime>
        <UnionSource>CCC</UnionSource>
        <UnionInstanceId>zhyl</UnionInstanceId>
        <NluServiceParamsJson>{"agentId":"12xxx","isCCCAgent":"true","agentKey":"107e04a7519243eb83c9bxxxxxxxe_p_ccc_public"}</NluServiceParamsJson>
    </Instances>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>A8AED3C8-F57B-5D71-9A34-4A170287533F</RequestId>
    <PageNumber>2</PageNumber>
</ListInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Instances" : [ {
    "Status" : "Published",
    "ModifyUserName" : "xxx",
    "Description" : "测试的实例",
    "ApplicableOperations" : [ "Edit" ],
    "InstanceId" : "dc437bba-5a25-4bbc-b4c2-f268864bebb5",
    "Name" : "测试实例",
    "Concurrency" : 10,
    "ModifyTime" : 1582266750353,
    "Numbers" : [ "021xxxxxxxx" ],
    "CreateTime" : 1697596919519,
    "UnionSource" : "CCC",
    "UnionInstanceId" : "zhyl",
    "NluServiceParamsJson" : "{\"agentId\":\"12xxx\",\"isCCCAgent\":\"true\",\"agentKey\":\"107e04a7519243eb83c9bxxxxxxxe_p_ccc_public\"}"
  } ],
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "A8AED3C8-F57B-5D71-9A34-4A170287533F",
  "PageNumber" : 2
}

错误码

HttpCode	错误码	错误信息	描述
400	InvalidParameter	The specified parameter %s is invalid.	参数值校验不通过。请使用请求参数构造规范化的请求字符串。
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

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