九游平台/ 数据工坊 dwr/ / / 自定义函数开发规范
更新时间:2024-07-12 gmt 08:00

自定义函数开发规范-九游平台

用户在自行开发自定义函数时,函数的输入参数和输出参数需要遵守本节的开发规范。

自定义函数的编译方式请参考functiongraph的。

函数输入参数

工作流执行自定义函数时,函数输入参数的json格式的结构体和环境变量的定义如下:
表1 函数输入的json格式体

名称

是否必选

参数类型

说明

execution_name

string

工作流实例名称。

graph_name

string

工作流名称。

records

array

工作流触发的事件源事件消息。

inputs

map[string]string

用户可修改参数列表,可以为空。

dynamic_source

map

函数执行必须的参数,可用于传入调用的服务。

表2 函数的环境变量

名称

是否必选

参数类型

说明

region

string

当前区域名称。

函数输入的json示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
"execution_name":"84a3dd2bd67f43aa9b98cdd74604ca68",//工作流实例名称
"graph_name":"test_workflow",//工作流名称
"records":[
{
"eventname":"objectcreated:put",//触发事件通知的事件名
"eventregion":"cn-north-4",//事件所在的region
"eventsource":"obs",//消息源,固定为"obs"
"eventtime":"2021-12-23t14:50:22.957z",//事件时间,格式为iso-8601,示例:2020-07-10t09:24:11.418z
"eventversion":"3.0",//版本号,目前为"3.0"
"obs":{
"version":"1.0",
"bucket":{
"bucket":"examplebucket",//桶名
"name":"examplebucket",//桶名
"owneridentity":{
"id":"08b4efe0fc00d3ce0f17c01b948f6e80"//桶拥有者的账号id
}
},
"configurationid":"test-trigger",//此事件匹配的obs中事件触发器的名称
"object":{
"etag":"fc85a07cff68977bf5b2108e7436ca2d",//对象的etag
"key":"exampleobject.docx",//对象名
"oldpsxpth":"",//文件在并行文件系统中rename前的路径
"sequencer":"1",//确定某个特定对象事件顺序的标识
"size":"524298",//对象的大小
"versionid":"g001017de60e176d0000401106696610null"//对象的版本id
}
},
"requestparameters":{
"sourceipaddress":"x.x.x.x"//请求的源ip
},
"responseelements":{
"x-obs-id-2":"",//帮助定位问题的特殊符号
"x-obs-request-id":"84a3dd2bd67f43aa9b98cdd74604ca68"//请求对应的requestid
},
"useridentity":{
"id":"08b4efe0fc00d3ce0f17c01b948f6e80"//触发事件的用户对应的计费id
}
}
],
"inputs":{//执行工作流的输入参数
"parametername":"parametervalue",
"parametername":"parametervalue"
},
"dynamic_source":{//执行自定义函数的输入参数
"parametername":"parametervalue",
"parametername":"parametervalue"
}
}

函数输出参数

函数输出参数的json格式的结构体定义如下:

表3 函数输出的json格式体

名称

是否必选

参数类型

说明

约束

execution_name

string

工作流实例名称。

继承函数输入参数的execution_name。

graph_name

string

工作流名称。

继承函数输入参数的graph_name。

records

array

工作流触发的事件源事件消息。

如果没有变化,则继承函数输入参数的records。

inputs

map[string]string

用户可修改参数列表。

如果没有新增,则继承函数输入参数的inputs。

dynamic_source

map

函数的输出参数,可用于传递给下一个执行的函数。

-

operation_name

string

函数操作名。

系统内置的工作流函数操作名有:

  • 视频解析:mpc.metadata
  • 视频截图:mpc.thumbnail
  • 视频转码:mpc.transcode
  • smn消息通知:smn.publish

对接截图函数示例(go语言)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
packagemain
import(
"encoding/json"
"errors"
"go-runtime/go-api/context"
)
funcdemohandler(jsondata[]byte,ctxcontext.runtimecontext)(interface{},error){
vareventmsgpayload
err:=json.unmarshal(jsondata,&eventmsg)
iferr!=nil{
returnnil,errors.new("not correct format")
}
// 存储输入桶和对象值
record:=eventmsg.records[0]
// 定义输出
resp:=struct{
obsmessages
inputsmap[string]interface{}`json:"inputs"`
executionnamestring`json:"execution_name"`
graphnamestring`json:"graph_name"`
dynamicsourcestruct{
*createthumbnaildynamicsourcebody
}`json:"dynamic_source"`
}{}
// 配置截图参数,为下游截图任务提供参数配置
resp.dynamicsource.createthumbnaildynamicsourcebody=&createthumbnaildynamicsourcebody{
thumbnails:[]*thumbnailcreatetaskbody{
&thumbnailcreatetaskbody{
//源文件地址。
input:&fileaddr{
location:"cn-north-1",
bucketname:record.obs.bucket.name,
object:record.obs.object.key,
},
//输出地址。
output:&fileaddr{
location:"cn-north-1",
bucketname:record.obs.bucket.name,
object:"thumb_out",
},
//是否压缩抽帧图片生成tar包。
tar:0,
//是否同步处理,同步处理是指不下载全部文件,快速定位到截图位置进行截图。
mode:0,
//截图参数
thumbnailparam:&thumbnailparam{
type:"dots",
maxlength:0,
dots:[]int64{2,10,14},// 截图的位置(s)
outputfilename:"default_cover.jpg",
},
},
},
}
// 以下参数需要继承传递,方便工作流下游函数获取对应参数值
resp.inputs=eventmsg.inputs
resp.records=eventmsg.records
resp.graphname=eventmsg.graphname
resp.executionname=eventmsg.executionname
returnresp,nil
}

对接转码函数示例(go语言)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
packagemain
import(
"encoding/json"
"errors"
"go-runtime/go-api/context"
)
funcdemotranscodehandler(jsondata[]byte,ctxcontext.runtimecontext)(interface{},error){
vareventmsgpayload
err:=json.unmarshal(jsondata,&eventmsg)
iferr!=nil{
returnnil,errors.new("not correct format")
}
// 存储输入桶和对象值
record:=eventmsg.records[0]
// 定义输出
resp:=struct{
obsmessages
inputsmap[string]interface{}`json:"inputs"`
executionnamestring`json:"execution_name"`
graphnamestring`json:"graph_name"`
dynamicsourcestruct{
*createtranscodedynamicsourcebody
}`json:"dynamic_source"`
}{}
// 配置截图参数,为下游截图任务提供参数配置
resp.dynamicsource.createtranscodedynamicsourcebody=&createtranscodedynamicsourcebody{
transcodes:[]*createtranscodetaskbody{
&createtranscodetaskbody{
//源文件地址。
input:&fileaddr{
location:"cn-north-4",
bucketname:record.obs.bucket.name,
object:record.obs.object.key,
},
//输出地址。
output:&fileaddr{
location:"cn-north-4",
bucketname:record.obs.bucket.name,
object:"transcode_out",
},
transtemplateid:[]int{7000523,7000524,7000526,7000528,7000530,7000538},
outputfilenames:[]string{"out_file1","out_file2","out_file3","out_file4","out_file5","out_file6"},
},
},
}
// 以下参数需要继承传递,方便工作流下游函数获取对应参数值
resp.inputs=eventmsg.inputs
resp.records=eventmsg.records
resp.graphname=eventmsg.graphname
resp.executionname=eventmsg.executionname
returnresp,nil
}

结构体示例(go语言)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
packagemain
typecreatetranscodedynamicsourcebodystruct{
transcodes[]*createtranscodetaskbody`json:"transcodes"`
}
typecreatetranscodetaskbodystruct{
//源文件存储地址。
input*fileaddr`json:"input,omitempty"`
//转码后的视频文件存储地址。
output*fileaddr`json:"output"`
//转码模板id,数组
transtemplateid[]int`json:"trans_template_id,omitempty"`
//支持图片水印和文字水印,最多支持20个。
watermarks[]*watermark`json:"watermarks,omitempty"`
//任务优先级。
prioritystring`json:"priority,omitempty"`
//输出文件名称,每一路转码输出对应一个名称,需要与转码模板id数组的顺序对应。
outputfilenames[]string`json:"output_filenames,omitempty"`
}
typewatermarkstruct{
input*fileaddr`json:"input,omitempty"`
templateidint`json:"template_id,omitempty"`
textcontextstring`json:"text_context,omitempty"`
imagewatermark*imagewatermark`json:"image_watermark,omitempty"`
textwatermark*textwatermark`json:"text_watermark,omitempty"`
}
typetextwatermarkstruct{
dxstring`json:"dx,omitempty"`
dystring`json:"dy,omitempty"`
referposstring`json:"referpos,omitempty"`
timelinestartstring`json:"timeline_start,omitempty"`
timelinedurationstring`json:"timeline_duration,omitempty"`
fontnamestring`json:"font_name,omitempty"`
fontsizestring`json:"font_size,omitempty"`
fontcolorstring`json:"font_color,omitempty"`
basestring`json:"base,omitempty"`
}
typeimagewatermarkstruct{
dxstring`json:"dx,omitempty"`
dystring`json:"dy,omitempty"`
referposstring`json:"referpos,omitempty"`
timelinestartstring`json:"timeline_start,omitempty"`
timelinedurationstring`json:"timeline_duration,omitempty"`
imageprocessstring`json:"image_process,omitempty"`
widthstring`json:"width,omitempty"`
heightstring`json:"height,omitempty"`
basestring`json:"base,omitempty"`
}
typecreatethumbnaildynamicsourcebodystruct{
thumbnails[]*thumbnailcreatetaskbody`json:"thumbnails"`
}
//fileaddr 文件路径结构定义
typefileaddrstruct{
locationstring`json:"location"`
bucketnamestring`json:"bucket"`
objectstring`json:"object"`
}
typethumbnailcreatetaskbodystruct{
//源文件地址。
input*fileaddr`json:"input"`
//输出地址。
output*fileaddr`json:"output"`
//是否压缩抽帧图片生成tar包。
tarint`json:"tar,omitempty"`
//是否同步处理,同步处理是指不下载全部文件,快速定位到截图位置进行截图。
modeint`json:"sync,omitempty"`
//截图参数
thumbnailparam*thumbnailparam`json:"thumbnail_para"`
}
typethumbnailparamstruct{
typestring`json:"type"`
timeint64`json:"time,omitempty"`
starttimeint64`json:"start_time,omitempty"`
durationint64`json:"duration,omitempty"`
dots[]int64`json:"dots,omitempty"`
formatint64`json:"format,omitempty"`
aspectratioint64`json:"aspect_ratio,omitempty"`
widthint64`json:"width,omitempty"`
heightint64`json:"height,omitempty"`
maxlengthint64`json:"max_length,omitempty"`
outputfilenamestring`json:"output_filename,omitempty"`
}
typeobsmessagesstruct{
records[]obsrecord`json:"records"`
}
// obsrecord obs消息格式
typeobsrecordstruct{
eventversionstring`json:"eventversion"`
eventsourcestring`json:"eventsource"`
eventregionstring`json:"eventregion"`
eventtimestring`json:"eventtime"`
eventnamestring`json:"eventname"`
useridentityuseridentity`json:"useridentity"`
requestparametersrequestparameters`json:"requestparameters"`
responseelementsresponseelements`json:"responseelements"`
obs*obsinfo`json:"obs"`
}
// useridentity 用户id
typeuseridentitystruct{
idstring`json:"id,omitempty"`
}
//requestparameters 原始请求参数
typerequestparametersstruct{
sourceipaddressstring`json:"sourceipaddress,omitempty"`
}
//responseelements 响应参数
typeresponseelementsstruct{
obsrequestidstring`json:"x-obs-request-id"`
obsid2string`json:"x-obs-id-2"`
}
//obsinfo obs信息
typeobsinfostruct{
versionstring`json:"version"`
configurationidstring`json:"configurationid"`
bucketbucketinfo`json:"bucket"`
objectobjectinfo`json:"object"`
}
//bucketinfo 桶信息
typebucketinfostruct{
namestring`json:"name"`
owneridentityuseridentity`json:"owneridentity"`
bucketstring`json:"bucket"`
}
//objectinfo 对象信息
typeobjectinfostruct{
keystring`json:"key"`
tagstring`json:"etag"`
sizeuint64`json:"size"`
versionidstring`json:"versionid"`
sequencerstring`json:"sequencer"`
}
typepayloadstruct{
executionnamestring`json:"execution_name"`
graphnamestring`json:"graph_name"`
obsmessages
dynamicsourceinterface{}`json:"dynamic_source"`
inputsmap[string]interface{}`json:"inputs"`
}

相关文档

网站地图