文档

DescribeInstance - 查询业务实例信息

更新时间:

查询智能外呼业务实例信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

af81a389-91f0-4157-8d82-720edd02b66a

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
Codestring

状态码。

OK
Messagestring

接口提示信息。

Success
RequestIdstring

请求 ID。

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功。

true
Instanceobject

业务实例信息。

CreationTimelong

创建时间。

1578469042851
InstanceIdstring

业务实例 ID。

90515b5-6115-4ccf-83e2-52d5bfaf2ddf
CreatorIdlong

创建者 ID。

435986
OwnerNamestring

业务实例拥有者名字。

xxxx
InstanceDescriptionstring

业务实例描述。

这个是第一个实例
InstanceNamestring

业务实例名字。

第一个实例
CreatorNamestring

创建者名字。

xxx
ResourceGroupIdstring

资源组 ID。

90515b5-6115-4ccf-83e2-52d5bfaf2ddf
MaxConcurrentConversationinteger

实例最大并发。

4

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Instance": {
    "CreationTime": 1578469042851,
    "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "CreatorId": 435986,
    "OwnerName": "xxxx",
    "InstanceDescription": "这个是第一个实例",
    "InstanceName": "第一个实例",
    "CreatorName": "xxx",
    "ResourceGroupId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "MaxConcurrentConversation": 4
  }
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
暂无变更历史