Queries event-triggered recording plans.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryEventRecordPlans

The operation that you want to perform. Set the value to QueryEventRecordPlans.
CurrentPage Integer Yes 1

The number of the page to return. Pages start from page 1. Default value: 1.
PageSize Integer Yes 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
Code String MissingParamter

The error code returned if the call fails.
Data

The returned data.
List

The list of the event-triggered recording plans.
EventType String 1

The type of the event. Valid values:

  • 1: motion detection
  • 2: sound detection
Name String test

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. Unit: seconds.
TemplateId String aoi921xxxx

The ID of the time template.
Page Integer 1

The page number of the returned page.
PageCount Integer 1

The total number of pages returned.
PageSize Integer 10

The number of entries returned per page.
Total Integer 1

The total number of entries.
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.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests


http(s)://[Endpoint]/? Action=QueryEventRecordPlans
&CurrentPage=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<QueryEventRecordPlansResponse>   
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Success>true</Success>
      <Data>
            <Total>79</Total>
            <PageCount>8</PageCount>
            <Page>1</Page>
            <PageSize>10</PageSize>
            <List>
                  <PlanId>jfo92*</PlanId>
                  <Name>planAA</Name>
                  <PreRecordDuration>0</PreRecordDuration>
                  <RecordDuration>10</RecordDuration>
                  <TemplateId>1234</TemplateId>
            </List>
      </Data>
</QueryEventRecordPlansResponse>

JSON format 

{
	"Data":{
		"PageCount":8,
		"PageSize":10,
		"Page":1,
		"List":{
			"Name":"planAA",
			"PreRecordDuration":0,
			"PlanId":"jfo92*",
			"TemplateId":1234,
			"RecordDuration":10
		},
		"Total":79
	},
	"RequestId":"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.