forked from uber/cadence
-
Notifications
You must be signed in to change notification settings - Fork 0
/
development_http_api.yaml
114 lines (114 loc) · 5.61 KB
/
development_http_api.yaml
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
services:
frontend:
rpc:
port: 7933
grpcPort: 7833
bindOnLocalHost: true
grpcMaxMsgSize: 33554432
# enable HTTP server, allow to call Start worfklow using HTTP API
# Use curl to start a workflow:
# curl http://0.0.0.0:8800 \
# -H 'context-ttl-ms: 2000' \
# -H 'rpc-caller: rpc-client-name' \
# -H 'rpc-service: cadence-frontend' \
# -H 'rpc-encoding: json' \
# -H 'rpc-procedure: uber.cadence.api.v1.WorkflowAPI::StartWorkflowExecution' \
# -X POST --data @data.json
# Where data.json content looks something like this:
# {
# "domain": "samples-domain",
# "workflowId": "workflowid123",
# "execution_start_to_close_timeout": "11s",
# "task_start_to_close_timeout": "10s",
# "workflowType": {
# "name": "workflow_type"
# },
# "taskList": {
# "name": "tasklist-name"
# },
# "identity": "My custom identity",
# "requestId": "4D1E4058-6FCF-4BA8-BF16-8FA8B02F9651"
# }
http:
# To enable HTTP TLS uncomment the following section
#tls:
# enabled: true
# certFile: config/credentials/keytest.crt
# keyFile: config/credentials/keytest
# caFiles:
# - config/credentials/client.crt
# requireClientAuth: true
#TLSMode: enforced
port: 8800
procedures: # list of available API procedures
# Admin API
- uber.cadence.admin.v1.AdminAPI::AddSearchAttribute
- uber.cadence.admin.v1.AdminAPI::CloseShard
- uber.cadence.admin.v1.AdminAPI::CountDLQMessages
- uber.cadence.admin.v1.AdminAPI::DeleteWorkflow
- uber.cadence.admin.v1.AdminAPI::DescribeCluster
- uber.cadence.admin.v1.AdminAPI::DescribeHistoryHost
- uber.cadence.admin.v1.AdminAPI::DescribeQueue
- uber.cadence.admin.v1.AdminAPI::DescribeShardDistribution
- uber.cadence.admin.v1.AdminAPI::DescribeWorkflowExecution
- uber.cadence.admin.v1.AdminAPI::GetCrossClusterTasks
- uber.cadence.admin.v1.AdminAPI::GetDLQReplicationMessages
- uber.cadence.admin.v1.AdminAPI::GetDomainIsolationGroups
- uber.cadence.admin.v1.AdminAPI::GetDomainReplicationMessages
- uber.cadence.admin.v1.AdminAPI::GetDynamicConfig
- uber.cadence.admin.v1.AdminAPI::GetGlobalIsolationGroups
- uber.cadence.admin.v1.AdminAPI::GetReplicationMessages
- uber.cadence.admin.v1.AdminAPI::GetWorkflowExecutionRawHistoryV2
- uber.cadence.admin.v1.AdminAPI::ListDynamicConfig
- uber.cadence.admin.v1.AdminAPI::MaintainCorruptWorkflow
- uber.cadence.admin.v1.AdminAPI::MergeDLQMessages
- uber.cadence.admin.v1.AdminAPI::PurgeDLQMessages
- uber.cadence.admin.v1.AdminAPI::ReadDLQMessages
- uber.cadence.admin.v1.AdminAPI::ReapplyEvents
- uber.cadence.admin.v1.AdminAPI::RefreshWorkflowTasks
- uber.cadence.admin.v1.AdminAPI::RemoveTask
- uber.cadence.admin.v1.AdminAPI::ResendReplicationTasks
- uber.cadence.admin.v1.AdminAPI::ResetQueue
- uber.cadence.admin.v1.AdminAPI::RespondCrossClusterTasksCompleted
- uber.cadence.admin.v1.AdminAPI::RestoreDynamicConfig
- uber.cadence.admin.v1.AdminAPI::UpdateDomainIsolationGroups
- uber.cadence.admin.v1.AdminAPI::UpdateDynamicConfig
- uber.cadence.admin.v1.AdminAPI::UpdateGlobalIsolationGroups
# Domain operations related API
- uber.cadence.api.v1.DomainAPI::DeprecateDomain
- uber.cadence.api.v1.DomainAPI::DescribeDomain
- uber.cadence.api.v1.DomainAPI::ListDomains
- uber.cadence.api.v1.DomainAPI::RegisterDomain
- uber.cadence.api.v1.DomainAPI::UpdateDomain
# Health check endpoint
- uber.cadence.api.v1.MetaAPI::Health
# Searching for workflows
- uber.cadence.api.v1.VisibilityAPI::CountWorkflowExecutions
- uber.cadence.api.v1.VisibilityAPI::GetSearchAttributes
- uber.cadence.api.v1.VisibilityAPI::ListArchivedWorkflowExecutions
- uber.cadence.api.v1.VisibilityAPI::ListClosedWorkflowExecutions
- uber.cadence.api.v1.VisibilityAPI::ListOpenWorkflowExecutions
- uber.cadence.api.v1.VisibilityAPI::ListWorkflowExecutions
- uber.cadence.api.v1.VisibilityAPI::ScanWorkflowExecutions
# Workflow execution related API endpoints
- uber.cadence.api.v1.WorkflowAPI::DescribeTaskList
- uber.cadence.api.v1.WorkflowAPI::DescribeWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::GetClusterInfo
- uber.cadence.api.v1.WorkflowAPI::GetTaskListsByDomain
- uber.cadence.api.v1.WorkflowAPI::GetWorkflowExecutionHistory
- uber.cadence.api.v1.WorkflowAPI::ListTaskListPartitions
- uber.cadence.api.v1.WorkflowAPI::QueryWorkflow
- uber.cadence.api.v1.WorkflowAPI::RefreshWorkflowTasks
- uber.cadence.api.v1.WorkflowAPI::RequestCancelWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::ResetWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::RestartWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::SignalWithStartWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::SignalWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::StartWorkflowExecution
- uber.cadence.api.v1.WorkflowAPI::TerminateWorkflowExecution
metrics:
statsd:
hostPort: "127.0.0.1:8125"
prefix: "cadence"
pprof:
port: 7936