查询计算实例信息。传入了多个参数时,必须同时满足多个参数才返回结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAIInstance |
系统规定参数。取值:DescribeAIInstance。 |
PageSize | Long | 是 | 10 |
每页显示多少条,最大每页100条 |
InstanceId | String | 否 | 1 |
实例ID。 项目ID、实例ID、实例名称至少填写1个 |
PageNumber | Long | 是 | 1 |
当前页序号,从1开始 |
ProjectId | String | 否 | 1 |
项目ID。 项目ID、实例ID、实例名称至少填写1个 |
InstanceName | String | 否 | example |
实例名称,支持模糊搜索。 项目ID、实例ID、实例名称至少填写1个 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D001BEB9-A281-4BF0-B595-512A5CBDC122 |
RequestID |
Code | String | 0 |
返回错误码 |
Message | String | SUCCESS |
错误信息 |
Data | Object |
返回数据 |
|
TotalCount | Long | 100 |
数据总数 |
PageSize | Long | 10 |
每页显示多少条 |
PageNumber | Long | 1 |
当前页序号,从1开始 |
Records | Array of records |
返回数据条目 |
|
InstanceId | String | 1 |
实例ID |
InstanceName | String | example |
实例名称 |
AlgorithmId | String | 1 |
算子ID |
AlgorithmName | String | example |
算子名称 |
ComputeType | String | StreamCompute |
计算类型 |
DataSource | String | Camera |
数据来源 |
DataType | String | Picture |
数据类型 |
ScheduleType | String | EVERYDAY |
调度类型 |
ScheduleCycleDates | String | [1, 4, 6] |
JSON数组格式。含义随ScheduleType取值不同。 EVERY_MONTH:每个数字代表月内某一天。比如[1,20, 25, 28 ]表示每月1日、20日、25日、28日。 EVERY_WEEK: 每个数字代表周内某一天。比如 [ 1, 4, 6 ] 表示每周周一、周四、周六。 |
ScheduleTimes | String | [{"StartTime":"10:00:00","EndTime":"11:00:00"}] |
执行时间段,以JSON格式填写StartTime和EndTime,格式为时分秒(HH:mm:ss)。 |
Spf | Long | 5 |
多少秒抽取1帧,取值范围 0 到 3600。 0表示不抽帧。 |
Status | String | ONLINED |
实例状态: UN_STATE 待启动 INIT 启动中 RUNNING 已启动 BLOCKED 停止中 EXCEPTION 异常 DELETED 已删除 |
CreateDateTime | String | 2021-08-26 10:55:58 |
实例创建时间 |
AcuUsed | Long | 1 |
ACU使用数量 |
CameraNumber | Long | 10 |
实例中计算的摄像机数量。 仅当DataSource是Camera时返回。 |
Storage | double | 1.66 |
「该实例预计产生上云数据」容量,单位为 TB/月,表示该实例中所用摄像头上云的原始视频或者图片的预估容量,不含分析后产生的图片占用容量。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeAIInstance
&PageSize=10
&InstanceId=1
&PageNumber=1
&ProjectId=1
&InstanceName=example
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAIInstanceResponse>
<RequestId>D001BEB9-A281-4BF0-B595-512A5CBDC122</RequestId>
<Code>0</Code>
<Message>SUCCESS</Message>
<Data>
<TotalCount>100</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Records>
<InstanceId>1</InstanceId>
<InstanceName>example</InstanceName>
<AlgorithmId>1</AlgorithmId>
<AlgorithmName>example</AlgorithmName>
<ComputeType>StreamCompute</ComputeType>
<DataSource>Camera</DataSource>
<DataType>Picture</DataType>
<ScheduleType>EVERYDAY</ScheduleType>
<ScheduleCycleDates>[1, 4, 6]</ScheduleCycleDates>
<ScheduleTimes>[{"StartTime":"10:00:00","EndTime":"11:00:00"}]</ScheduleTimes>
<Spf>5</Spf>
<Status>ONLINED</Status>
<CreateDateTime>2021-08-26 10:55:58</CreateDateTime>
<AcuUsed>1</AcuUsed>
<CameraNumber>10</CameraNumber>
<Storage>1.66</Storage>
</Records>
</Data>
</DescribeAIInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D001BEB9-A281-4BF0-B595-512A5CBDC122",
"Code" : "0",
"Message" : "SUCCESS",
"Data" : {
"TotalCount" : 100,
"PageSize" : 10,
"PageNumber" : 1,
"Records" : [ {
"InstanceId" : "1",
"InstanceName" : "example",
"AlgorithmId" : "1",
"AlgorithmName" : "example",
"ComputeType" : "StreamCompute",
"DataSource" : "Camera",
"DataType" : "Picture",
"ScheduleType" : "EVERYDAY",
"ScheduleCycleDates" : "[1, 4, 6]",
"ScheduleTimes" : "[{\"StartTime\":\"10:00:00\",\"EndTime\":\"11:00:00\"}]",
"Spf" : 5,
"Status" : "ONLINED",
"CreateDateTime" : "2021-08-26 10:55:58",
"AcuUsed" : 1,
"CameraNumber" : 10,
"Storage" : 1.66
} ]
}
}
错误码
访问错误中心查看更多错误码。