Creating a People Flow Counting (Cloud) Job

Updated on 2025-02-28 GMT+08:00

View PDF

Function

This API is used to create a people flow counting (cloud) job.

URI

POST /v1/{project_id}/infer/services/c-flowcount-cloud/tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Job name. It can contain up to 100 characters and can include uppercase and lowercase letters, digits, hyphens (-), and underscores (_).
description	No	String	Job description. It can contain up to 500 characters.
schedule	No	TaskSchedule object	Configuration of a scheduled job. Scheduled jobs do not support OBS input. URL input supports only RTMP and RTSP.
input	Yes	TaskInput object	Input configuration of a job
output	Yes	TaskOutput object	Output configuration of a job. At least one output mode must be configured.
config	No	FlowCountServiceConfig object	Job configuration parameters.
service_version	No	String	Service version.
is_saved_as_template	No	Boolean	Whether to save the job configuration as a template.
resource_order_id	No	String	ID of the algorithm capability package, which can be obtained on the page for purchasing an algorithm capability package.

**Table 3** TaskSchedule
Parameter	Mandatory	Type	Description
type	Yes	String	Type of a scheduled job. This parameter is mandatory for scheduled jobs. Options: weekly and monthly
timezone	Yes	String	Time zone where a user is located. This parameter is mandatory for scheduled jobs. The value is accurate to the minute.
days_of_week	No	Array of integers	Days in a week when a job is executed. This parameter is mandatory only for weekly jobs. The values 1 to 7 indicate Monday to Sunday respectively. Minimum: 1 Maximum: 7
days_of_month	No	Array of integers	Days in a month when a job is executed. This parameter is mandatory only for monthly jobs. The values 1 to 31 indicate the first day to the 31st day of a month. Minimum: 1 Maximum: 31
periods	No	Array<Array<PeriodsData>>	Time segment configuration. Select at least one time segment for executing a weekly or monthly job.

**Table 4** PeriodsData
Parameter	Mandatory	Type	Description
begin_at	Yes	String	Start time of a time segment, which is mandatory. The format is hh:mm:ss.
end_at	Yes	String	End time of a time segment, which is mandatory. The format is hh:mm:ss.

**Table 5** TaskInput
Parameter	Mandatory	Type	Description
type	Yes	String	Input type of a job. This parameter is mandatory. Options: obs (files stored in OBS, supported only by cloud jobs) vis (video streams from Video Ingestion Service, supported only by cloud jobs) url (specified file URL or stream request URL, supported only by cloud jobs) edgecamera (edge camera bound to IEF, supported only by edge jobs) restful (stream request URL obtained from a user-specified streaming server through a RESTful API, supported by both cloud and edge jobs) vcn (VCN device, supported only by edge jobs)
data	Yes	Array of TaskInputData objects	Input details of a job. The configuration varies according to the input type. Multiple inputs are allowed during creation, but only one input is allowed for update.
vcn	No	TaskInputVcn object	VCN server information. This parameter is mandatory only when the input type is vcn.

**Table 6** TaskInputData
Parameter	Mandatory	Type	Description
video_source_id	No	String	Video source ID
stream_name	No	String	Name of a VIS video stream. This parameter is mandatory when the input type is vis.
bucket	No	String	OBS bucket name. This parameter is mandatory when the input type is obs. Maximum: 63
path	No	String	OBS path. This parameter is mandatory when the input type is obs. Maximum: 1023
url	No	String	File URL or RESTful request URL for obtaining a video stream. This parameter is mandatory when the input type is url or edgerestful. The value contains a maximum of 1000 characters. Maximum: 1000
headers	No	Object	Headers carried in the RESTful request for obtaining a video stream. This parameter is optional when the input type is edgerestful. The value is key-value pairs in JSON format. A maximum of 10 key-value pairs are allowed.
certificate_check	No	Boolean	Whether to verify the certificate of the HTTPS request. This parameter is mandatory when the input type is edgerestful. The value can be true or false.
rtsp_path_in_response	No	String	Video stream address in the response body for the RESTful request. This parameter is mandatory when the input type is edgerestful. The value contains a maximum of 1024 characters. Maximum: 1024
node_id	No	String	ID of an IEF node. This parameter is mandatory only for some services when the input type is edgerestful or vcn.
device_id	No	String	VCN ID. This parameter is mandatory when the input type is vcn.
stream_type	No	Integer	Stream type used for analysis. This parameter is optional when the input type is vcn. The value ranges from 1 to 3. The value 1 indicates primary stream, the value 2 indicates secondary stream 1, and the value 3 indicates secondary stream 2. Minimum: 1 Maximum: 3
id	No	String	ID of the edge device mounted to IEF. This parameter is mandatory when the input type is edgecamera. Maximum: 63

**Table 7** TaskInputVcn
Parameter	Mandatory	Type	Description
ip	Yes	String	IP address of the VCN server. This parameter is mandatory only when the input type is vcn.
port	Yes	Integer	Port number of the VCN server. This parameter is mandatory only when the input type is vcn. Minimum: 0 Maximum: 65535
username	Yes	String	Account name of the VCN server. This parameter is mandatory only when the input type is vcn.
password	Yes	String	Password of the VCN server account. This parameter is mandatory only when the input type is vcn.

**Table 8** TaskOutput
Parameter	Mandatory	Type	Description
dis	No	TaskOutputDis object	Configuration information when the output type is dis.
webhook	No	TaskOutputWebhook object	Configuration information when the output type is webhook.
event_center	No	Boolean	Whether to send alarms to the event center. This parameter is valid for cloud jobs. Default: false

**Table 9** TaskOutputDis
Parameter	Mandatory	Type	Description
stream_name	Yes	String	DIS stream name. This parameter is mandatory when the dis type is used. Maximum: 64
data_category	No	Array of strings	List of job output types. This parameter is optional and is required only for some services. The output contains data in the dataCategory list.

**Table 10** TaskOutputWebhook
Parameter	Mandatory	Type	Description
url	Yes	String	Result callback address. This parameter is mandatory when the output type is webhook. Maximum: 1000
headers	Yes	Object	Headers carried in result callback. This parameter is mandatory when the output type is webhook. The value is key-value pairs in JSON format. A maximum of 10 key-value pairs are allowed, and a minimum of 1 key-value pair is allowed.
data_category	No	Array of strings	List of job output types. This parameter is optional and is required only for some services. The output contains data in the dataCategory list.

**Table 11** FlowCountServiceConfig
Parameter	Mandatory	Type	Description
common	Yes	FlowCountCommon object	Job runtime configuration items customized by the service publisher. The value must be in JSON format. For details about the configuration items, see the description of the corresponding algorithm service.

**Table 12** FlowCountCommon
Parameter	Mandatory	Type	Description
line_count_interval	No	Integer	Interval for collecting the number of people per second who cross a particular straight line in a video. The value ranges from 1 to 86400 and the default value is 2. Minimum: 1 Maximum: 86400 Default: 2
region_count_interval	No	Integer	Interval for collecting the number of people per second who cross through a particular area. The value ranges from 1 to 86400 and the default value is 2. Minimum: 1 Maximum: 86400 Default: 2
line_detection_sw	No	Integer	Whether to collect the number of people who cross a particular straight line in a video. 0: disabled. 1: enabled. The default value is 1. Minimum: 0 Maximum: 1 Default: 1
region_detection_sw	No	Integer	Whether to collect the number of people who cross through a particular area. 0: disabled. 1: enabled. The default value is 1. Minimum: 0 Maximum: 1 Default: 1
heatmap_detection_sw	No	Integer	Whether to enable heatmap detection. 0: disabled. 1: enabled. The default value is 0. Minimum: 0 Maximum: 1 Default: 0
heatmap_detection_interval	No	Integer	Heatmap detection period, in seconds. The value ranges from 10 to 86400 and the default value is 10. Minimum: 10 Maximum: 86400 Default: 10
heatmap_point_interval	No	Integer	Hotspot update period, in frames. In a heatmap detection period, hotspot values gradually accumulate. The value ranges from 1 to 10000 and the default value is 4. Minimum: 1 Maximum: 10000 Default: 4
target_roi	No	String	Corresponds to the Target ROI parameter on the console. This parameter specifies the detection area. The value of this parameter is a JSON string. An escape character must be added in an API call. For details about the JSON format, see Setting target_roi. Example: {"lines":[{"data":[[560,680],[1185,506]],"properties":{"side1_name":"Side1","side2_name":"Side2"}}],"polygons":[{"data":[[0,0],[0,1080],[1920,1080],[1920,0]]}]} If the line configuration is not specified, the default value is used. By default, the line is horizontal and drawn at the position where the height is 50% of the image height. If the image width is w and the image height is h, the default position of the line is [[1/4w,1/2h], [3/4w,1/2h]]. If the area configuration is not specified, the default value is used. By default, the area is a rectangle, which is 1/4 of the middle of the entire video frame. If the image width is w and the image height is h, the positions of the four endpoints of the area are [[1/4w, 1/4h], [3/4w, 1/4h], [1/4w, 3/4h], [3/4w, 3/4h]].

Response Parameters

Status code: 201

**Table 13** Response body parameters
Parameter	Type	Description
id	String	Job ID.

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Internal service error code
error_msg	String	Error information Minimum: 0 Maximum: 4096

Example Requests

Create a people flow counting job. Use VIS as the input source, and DIS as the output channel.

POST /v1/{project_id}/infer/services/c-flowcount-cloud/tasks

{
  "name" : "flowcount-task",
  "description" : "flowcount task test",
  "input" : {
    "type" : "vis",
    "data" : [ {
      "stream_name" : "flowcount",
      "index" : 0
    } ]
  },
  "output" : {
    "dis" : {
      "stream_name" : "dis-flowcount"
    }
  },
  "service_version" : "3.0",
  "resource_order_id" : "840a5cf90d4a4bbaa71f251dfe8fe64e",
  "config" : {
    "common" : {
      "line_count_interval" : 2,
      "region_count_interval" : 2,
      "line_detection_sw" : 1,
      "region_detection_sw" : 1,
      "attribute_detection_sw" : 0,
      "target_roi" : "{\"lines\":[{\"data\":[[560,680],[1185,506]],\"properties\":{\"side1_name\":\"Side1\",\"side2_name\":\"Side2\"}}],\"polygons\":[{\"data\":[[0,0],[0,1080],[1920,1080],[1920,0]]}]}",
      "heatmap_detection_sw" : 0,
      "heatmap_detection_interval" : 60,
      "heatmap_point_interval" : 4
    }
  }
}