Queries detailed information of an event-triggered recording plan.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
PlanId | String | Yes | fsaoi2xxxx |
The ID of the plan. |
For information about other common request parameters, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | MissingParamter |
The error code returned if the call fails. |
Data |
The returned data. |
||
Name | String | record1 |
The name of the event-triggered video. |
PlanId | String | fsaoi2xxxx |
The ID of the plan. |
PreRecordDuration | Integer | 30 |
The prerecording period. Unit: seconds. |
RecordDuration | Integer | 120 |
The recording period. This value includes the prerecording period. |
TemplateId | String | aoi921xxxx |
The ID of the time template. |
TemplateInfo |
The details of the time template. |
||
AllDay | Integer | 1 |
|
Default | Integer | 1 |
|
Name | String | temp1 |
The name of the template. |
TemplateId | String | aoi921xxxx |
The ID of the time template. |
TimeSectionList |
The list of time templates. |
||
Begin | Integer | 6000 |
The start time on each day. Unit: seconds. Valid values: 0 to 86399. |
DayOfWeek | Integer | 0 |
The day of the week. Valid values: 0 to 6. 0 indicates Sunday and 6 indicates Saturday. |
End | Integer | 2000 |
The end time on each day. Unit: seconds. Valid values: 1 to 86399. |
ErrorMessage | String | XXXis mandatory for this action |
The error message returned if the call fails. |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
http(s)://[Endpoint]/? Action=QueryEventRecordPlanDetail
&PlanId=fsaoi2xxxx
&<Common request parameters>
Sample success responses
XML
format
<QueryEventRecordPlanDetailResponse>
<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
<Success>true</Success>
<Data>
<PlanId>jfo92*</PlanId>
<Name>planAA</Name>
<PreRecordDuration>0</PreRecordDuration>
<RecordDuration>10</RecordDuration>
<TemplateId>1234</TemplateId>
<TemplateInfo>
<TemplateId>aoi921***</TemplateId>
<Name>testtime1</Name>
<AllDay>0</AllDay>
<Default>0</Default>
<TimeSectionList>
<DayOfWeek>1</DayOfWeek>
<Begin>0</Begin>
<End>86399</End>
</TimeSectionList>
<TimeSectionList>
<DayOfWeek>5</DayOfWeek>
<Begin>0</Begin>
<End>40000</End>
</TimeSectionList>
</TemplateInfo>
</Data>
</QueryEventRecordPlanDetailResponse>
JSON
format
{
"Data":{
"Name":"planAA",
"TemplateInfo":{
"Default":0,
"Name":"testtime1",
"AllDay":0,
"TimeSectionList":[
{
"End":86399,
"Begin":0,
"DayOfWeek":1
},
{
"End":40000,
"Begin":0,
"DayOfWeek":5
}
],
"TemplateId":"aoi921***"
},
"PreRecordDuration":0,
"PlanId":"jfo92*",
"TemplateId":1234,
"RecordDuration":10
},
"RequestId":"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
"Success":true
}
Error codes
For a list of error codes, visit the API Error Center.