-
响应示例 状态码:200 表示查询表请求成功 {
"table_name" : "test-table-1",
"primary_key_schema" : {
"shard_key_fields" : [ {
"name" : "owner",
"order" : true
} ],
"sort_key_fields" : [ {
"name" : "filename",
"order" : true
} ]
},
"runtime_info" : {
"table_info" : {
"table_status" : "ACTIVE"
}
}
}
-
URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名,全域唯一,不同租户的仓名不能相同。 格式:${prefix}-${region-code}-${account-id},其中prefix为自定义前缀,region-code为kvs集群所在的区域代码,account-id为用户的账户id 取值字符限制:[a-z0-9-]+ 长度:[16,52] 说明: "-"不能出现在名字头部或尾部
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 table_name String 表名。 长度:[3, 63] 取值字符限制:[a-z0-9_-]+ primary_key_schema primary_key_schema object 主键模板, 最多1个,必须指定主键schema。 local_secondary_index_schema Array of secondary_index objects 本地二级索引模板,可以多个。 global_secondary_index_schema Array of global_secondary_index objects 全局二级索引模板。 run_time_info run_time_info object 运行信息。 表4 primary_key_schema 参数 参数类型 描述 shard_key_fields Array of field objects 分区键字段名数组,顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组,顺序组合。 表5 secondary_index 参数 参数类型 描述 index_name String 二级索引名称,表内唯一。 sort_key_fields Array of field objects 排序键字段名数组,顺序组合。 abstract_fields Array of strings 摘要字段名数组。 表6 global_secondary_index 参数 参数类型 描述 index_name String 二级索引名称,表内唯一。 shard_key_fields Array of field objects 分区键字段名数组,顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组,顺序组合。 abstract_fields Array of strings 摘要字段名数组。 provisioned_throughput provisioned_throughput object 预置吞吐读写请求单元数,在bill_mode="provisioned"有效。 表7 field 参数 参数类型 描述 name String 字段名。 order Boolean bool值预留无意义。 表8 provisioned_throughput 参数 参数类型 描述 rcu Long 预置表级读请求单元数。 wcu Long 预置表级写请求单元数。 表9 run_time_info 参数 参数类型 描述 table_info table_info object 表信息。 local_secondary_index_infos Array of secondary_index_info objects 索引状态。 global_secondary_index_infos Array of global_secondary_index_info objects 全局二级索引运行态。 表10 table_info 参数 参数类型 描述 table_status String 表状态。 "creating" "active" "deleting" 表11 secondary_index_info 参数 参数类型 描述 index_name String 索引状态。 长度:[1, 255] 取值字符限制:[a-z0-9_-]+ index_status String 索引状态。 "creating" "active" "deleting" 表12 global_secondary_index_info 参数 参数类型 描述 index_name String 二级索引名称。 index_status String 二级索引名称。 "creating" "active" "deleting" 状态码:400 表13 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。
-
报文样例 请求样例 { "tenantId":"202104237142", "accessCode":"943370855474270208", "timestamp":1628784000000, "type":"hour", "authToken":"wEd*******************Q6VwYMj"} 响应样例 [ { "recordTime": 1628820000000, "tenantId": "202104237142", "accessCode": "943370855474270208", "callCount": 1, "exitNoConsultCount": 0, "callStaffNoConsultCount": 0, "callStaffConsultCount": 0, "exitConsultingCount": 1, "interactCount": 2, "autonomyRate": "1.0000", "averageInteractPerCall": "2.00", "dbRecordTime": 1628820000000, "type": "hour", "interfaceRequestCount": 0, "interfaceSuccessCount": 0, "interfaceSuccessRate": "-1.0000" }]
-
响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - QueryCallStatisticsRes[] body True 呼叫统计报表信息 表2 QueryCallStatisticsRes 名称 是否必选 参数类型 说明 recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识(机器人接入码) callCount True long 接入量 exitNoConsultCount True long 直接退出量,用户和IVR只交互一次的量 callStaffNoConsultCount True long 直接转人工量,用户和IVR交互大于1次且小于等于3次,并且不在IVR挂机的量 callStaffConsultCount True long 咨询后转人工量,用户和IVR交互大于3次,并且不在IVR挂机的量 exitConsultingCount True long 仅咨询机器人量,用户和IVR交互大于1次,并且在IVR挂机的量 interactCount True long 对话轮次,总的用户和IVR交互次数 autonomyRate True String 净自助解决率 -1.000: 机器人总使用量为0(直接转人工量+咨询后转人工量+仅咨询机器人量) 0-1.000:仅咨询机器人量/机器人总使用量 averageInteractPerCall True String 平均对话轮次,平均每通对话,用户和IVR的交互次数 dbRecordTime True Date 数据库记录日期,未设置为null type True String 查询类型 hour: 按小时查询 day: 按天查询 interfaceRequestCount True long 接口调用总数 interfaceSuccessCount True long 接口调用成功数 interfaceSuccessRate True String 接口调用成功率 -1.000: 接口调用总数为0 0-1.000:接口调用成功数/接口调用总数
-
请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询,特定日期的报表数据 day: 按天查询,三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识(机器人接入码) timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。