This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: ApigatewayTriggerCreateRequest
2: CloudFunction
3: CloudFunctionCreateRequest
4: CloudFunctionCreateResponse
5: CloudFunctionForList
6: CloudFunctionListResponse
7: CloudFunctionShowResponse
8: Code
9: CodeFile
10: CodeSetRequest
11: Configuration
12: ConfigurationV1Dot2
13: CronjobTriggerCreateRequest
14: CronjobTriggerSetRequest
15: DuplicationShowResponse
16: Endpoint
17: EndpointCreateRequest
18: FunctionConfig
19: FunctionUrl
20: FunctionUrlRequest
21: FunctionUrlV1Dot3
22: FunctionVariable
23: FunctionVariables
24: Log
25: LogShowResponse
26: Metric
27: MetricShowResponse
28: PolicyDocument
29: PrivateLinkEndpoint
30: PrivateLinkEndpointApproval
31: PrivateLinkEndpointConnection
32: PrivateLinkEndpointCreateRequest
33: PrivateLinkEndpointList
34: PrivateLinkEndpointRequest
35: PrivateLinkService
36: PrivateLinkServicePutRequest
37: PrivateLinkServiceV1Dot3
38: ResourcePolicySetRequest
39: ResourcePolicyShowResponse
40: Runtime
41: RuntimeListResponse
42: SampleCode
43: SampleCodesListResponse
44: Statement
45: Tag
46: Trigger
47: TriggerCreateResponse
48: TriggerDeleteRequest
49: TriggerForList
50: TriggersResponse
51: TriggerUpdateResponse

1 - ApigatewayTriggerCreateRequest

Name	Description	Schema
apigateway_api_id required	Apigateway API ID Example : `31e749b7b260868f441e862b` Pattern : `^[0-9a-f]{24}$`	string
apigateway_stage_name required	Apigateway Stage Name Example : `sample` Pattern : `^[a-z0-9\-]+$`	string
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656` Pattern : `^[0-9a-f]{32}$`	string

2 - CloudFunction

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
function_url required	Cloud function Url Example : `https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello`	any of [string, null]
id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
name required	Cloud Functions name Example : `sample`	string
runtime required	Runtime Example : `Node.js:20`	string
state required	Cloud function state Example : `READY`	string
user_id required	User ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string

3 - CloudFunctionCreateRequest

Name	Description	Schema
content required	Code content Example : `sample`	string
name required	Name Example : `sample-function-name` Pattern : `^[a-z][a-z0-9-]$` Minimum length* : `3` Maximum length : `64`	string
runtime required	Runtime Example : `Node.js:20`	string
tags optional	Tag List	any of [array[Tag], null]

4 - CloudFunctionCreateResponse

Name	Description	Schema
id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
message required	Description Example : `Description`	string
state required	Cloud function state Example : `READY`	string

5 - CloudFunctionForList

Name	Description	Schema
account_id required	Account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string
created_at required	Created At Example : `2025-05-22T06:21:17.580522`	string (date-time)
function_url required	Cloud function Url Example : `https://33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/cloudfunctions-hello`	any of [string, null]
id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
name required	Cloud Functions name Example : `sample`	string
runtime required	Runtime Example : `Node.js:20`	string
state required	Cloud function state Example : `READY`	string
user_id required	User ID Example : `617b3d0e90c24a5fa1f65a3824861354`	string

6 - CloudFunctionListResponse

Name	Description	Schema	Default
cloud_functions required	Contents	array[CloudFunctionForList]
count required	Count Example : `20`	integer

7 - CloudFunctionShowResponse

Name	Description	Schema	Default
cloud_function required		CloudFunction

8 - Code

Name	Description	Schema
class_name optional	Class Name Example : `com.example.Handler`	any of [string, null]
code_text optional	Code Text Example : `ZXhwb3J0cy5oYW5kbGVSZXF1ZXN0ID0gYXN5bmM==`	any of [string, null]
code_type required	Code Type Example : `text`	string
file_name optional	File Name Example : `sample`	any of [string, null]
file_transfer_status optional	File Transfer Status Example : `sample`	any of [string, null]
file_upload_at optional	File Upload At Example : `2025-05-17 00:23:17`	any of [string, null]
method_name optional	Method Name Example : `handleRequest`	any of [string, null]
runtime required	Runtime Example : `Node.js:20`	string

9 - CodeFile

Name	Description	Schema
class_name required	Class Name Example : `com.example.Handler`	string
method_name required	Method Name Example : `handleRequest`	string
obs_url optional	Object Storage URL Example : `https://obs.kr-east1.scp-in.com:8443/sample/java-sample-1.0-SNAPSHOT.jar`	any of [string, null]

10 - CodeSetRequest

Name	Description	Schema	Default
content required	Code content Example : `print("Hello World")`	string

11 - Configuration

Name	Description	Schema
config required	Configuration	FunctionConfig
url required	Function URL	FunctionUrl
variables optional	Environment Variables	any of [array[FunctionVariable], null]

12 - ConfigurationV1Dot2

Name	Description	Schema
config required	Configuration	FunctionConfig
privatelink_endpoints optional	Endpoints	any of [array[Endpoint], null]
privatelink_service optional	PrivateLink Service	any of [PrivateLinkService, null]
url required	Function URL	FunctionUrl
variables optional	Environment Variables	any of [array[FunctionVariable], null]

13 - CronjobTriggerCreateRequest

Name	Description	Schema
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656` Pattern : `^[0-9a-f]{32}$`	string
schedule required	Schedule Example : `* * * * 0`	string
timezone required	Timezone Example : `Asia/Tokyo`	string

14 - CronjobTriggerSetRequest

Name	Description	Schema
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656` Pattern : `^[0-9a-f]{32}$`	string
schedule required	Schedule Example : `* * * * 0`	string
timezone required	Timezone Example : `Asia/Tokyo`	string

15 - DuplicationShowResponse

Name	Description	Schema	Default
result required	Result Example : `True`	boolean

16 - Endpoint

Name	Description	Schema
endpoint_alias optional	Alias Example : `sample`	any of [string, null]
endpoint_id required	Endpoint Id Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
service_id optional	Service Id Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
state required	State Example : `Active`	string

17 - EndpointCreateRequest

Name	Description	Schema	Default
alias required	Alias Example : `sample`	string
service_id required	Service Id Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

18 - FunctionConfig

Name	Description	Schema
max_scale required	Max Scale Example : `5`	integer
memory required	Memory Example : `256`	integer
min_scale required	Min Scale Example : `1`	integer
timeout required	Timeout Example : `100`	integer

19 - FunctionUrl

Name	Description	Schema
allow_ips optional	Allow Ips Example :	any of [array[string], null]
auth_type optional	Auth Type Example : `NONE`	any of [string, null]
public_endpoint_url optional	Public Endpoint Url Example : `https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function`	any of [string, null]
public_ip_acl_enabled optional	Public IP ACL Enabled Example : `True`	any of [boolean, null]
url_enabled required	URL Enabled Example : `True`	boolean

20 - FunctionUrlRequest

Name	Description	Schema
allow_ips optional	Allow Ips Example :	any of [array[string], null]
auth_type optional	Auth Type Example : `NONE`	any of [string, null]
public_ip_acl_enabled required	Public IP ACL Enabled Example : `True`	boolean
url_enabled required	URL Enabled Example : `True`	boolean

21 - FunctionUrlV1Dot3

Name	Description	Schema
allow_ips optional	Allow Ips Example :	any of [array[string], null]
auth_type optional	Auth Type Example : `NONE`	any of [string, null]
public_endpoint_url optional	Public Endpoint Url Example : `https://scf.33b532c466824bcf9324101a3c6f3015.kr-west1.dev2.samsungsdscloud.com/sample-function`	any of [string, null]
public_ip_acl_enabled optional	Public IP ACL Enabled Example : `True`	any of [boolean, null]
state optional	Function URL State Example : `CREATING`	any of [string, null]
url_enabled required	URL Enabled Example : `True`	boolean

22 - FunctionVariable

Name	Description	Schema	Default
key required	Key Example : `sample`	string
value required	Value Example : `sample`	string

23 - FunctionVariables

Name	Description	Schema	Default
variables required	Environment Variables	array[FunctionVariable]

24 - Log

Name	Description	Schema	Default
log required	Log Example : `[2025-05-12 11:04:12] START RequestId : 04680bac - ad76-4e0a-997e-e35b6275cb67 Version : $LATEST`	string
time required	Time Example : `2025-05-17 00:23:17`	string

25 - LogShowResponse

Name	Description	Schema	Default
count required	Count Example : `3`	integer
logs required	Log	array[Log]

26 - Metric

Name	Description	Schema	Default
metric_data required	Metric Data Example : `1.0033444816053512`	object
time required	Time Example : `16:37`	string

27 - MetricShowResponse

Name	Description	Schema
actual_pods required	Actual pods	array[Metric]
fail_count required	Fail count	array[Metric]
function_memory required	Function memory	array[Metric]
request_count required	Request count	array[Metric]
request_latency required	Request latency	array[Metric]
success_count required	Success count	array[Metric]

28 - PolicyDocument

Name	Description	Schema	Default
Statement required	Statement Example : `{'Statement': [{'Action': ['scf:InvokeFunction'], 'Condition': {'StringEquals': {'scf:CloudFunctionAuthType': ['SCP_IAM']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}`	array[Statement]
Version required	Version Example : `2024-07-01`	string

29 - PrivateLinkEndpoint

Name	Description	Schema	Default
endpoint required	Endpoint	Endpoint

30 - PrivateLinkEndpointApproval

Name	Description	Schema	Default
type required	Type Example : `APPROVE`	enum (APPROVE, REJECT)

31 - PrivateLinkEndpointConnection

Name	Description	Schema	Default
type required	Type Example : `RECONNECT`	enum (DISCONNECT, RECONNECT)

32 - PrivateLinkEndpointCreateRequest

Name	Description	Schema	Default
endpoint required	Endpoint	EndpointCreateRequest

33 - PrivateLinkEndpointList

Name	Description	Schema	Default
privatelink_endpoints required	Endpoints	any of [array[Endpoint], null]

34 - PrivateLinkEndpointRequest

Name	Description	Schema	Default
type required	Type Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

35 - PrivateLinkService

Name	Description	Schema
private_url optional	Private Url Example : `https://sample.scf.private.kr-west1.e.samsungsdscloud.com`	any of [string, null]
privatelink_service_enabled required	PrivateLink Service Enabled Example : `True`	boolean
privatelink_service_id optional	PrivateLink Service ID Example : `ba30549f550141ef9af6546543s`	any of [string, null]
privatelink_service_name optional	PrivateLink Service Name Example : `68216f8f56`	any of [string, null]
requested_endpoints optional	Endpoint	any of [array[Endpoint], null]

36 - PrivateLinkServicePutRequest

Name	Description	Schema	Default
privatelink_service_enabled required	PrivateLink Service Enabled Example : `True`	boolean

37 - PrivateLinkServiceV1Dot3

Name	Description	Schema
private_url optional	Private Url Example : `https://sample.scf.private.kr-west1.e.samsungsdscloud.com`	any of [string, null]
privatelink_service_auth_type optional	PrivateLink Service Auth Type Example : `SCP_IAM`	any of [string, null]
privatelink_service_enabled required	PrivateLink Service Enabled Example : `True`	boolean
privatelink_service_id optional	PrivateLink Service ID Example : `ba30549f550141ef9af6546543s`	any of [string, null]
privatelink_service_name optional	PrivateLink Service Name Example : `68216f8f56`	any of [string, null]
privatelink_service_state optional	State Example : `Active`	any of [string, null]
requested_endpoints optional	Endpoint	any of [array[Endpoint], null]

38 - ResourcePolicySetRequest

Name	Description	Schema	Default
policy_document required	Policy Document Example : `{'Statement': [{'Action': ['scf:InvokeFunction'], 'Condition': {'StringEquals': {'scf:CloudFunctionAuthType': ['SCP_IAM']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}`	PolicyDocument

39 - ResourcePolicyShowResponse

Name	Description	Schema	Default
policy_document optional	Policy Document Example : `{'Statement': [{'Action': ['scf:InvokeFunction'], 'Condition': {'StringEquals': {'scf:CloudFunctionAuthType': ['SCP_IAM']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:e::27bb070b564349f8a31cc60734cc36a5:kr-west1::scf:cloud-function/1a2afa4bfb854a828602c93009cf4447'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'}`	any of [PolicyDocument, null]

40 - Runtime

Name	Description	Schema
base_image_seq required	Base image sequence Example : `3`	integer
name required	Name Example : `sample`	string
version required	Version Example : `1.0.0`	string

41 - RuntimeListResponse

Name	Description	Schema	Default
count required	Count Example : `3`	integer
runtimes required	Runtimes List	array[Runtime]

42 - SampleCode

Name	Description	Schema
content required	Code content Example : `sample`	string
default required	Default Example : `False`	boolean
description required	Description Example : `sample`	string
name required	Name Example : `sample`	string
runtime required	Runtime Example : `Node.js:20`	string
seq required	Sequence Example : `3`	integer
version required	Version Example : `sample`	string

43 - SampleCodesListResponse

Name	Description	Schema	Default
count required	Count Example : `3`	integer
sample_codes required	Sample Codes List	array[SampleCode]

44 - Statement

Name	Description	Schema	Default
Action optional	Action Example : `['iam:*']`	any of [array[string], null]
Condition optional	Condition Example : `{'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}`	any of [object[object[array[object]]], null]
Effect required	Effect Example : `Allow`	enum (Allow, Deny)
NotAction optional	Not Action Example :	any of [array[string], null]
Principal optional	Principal Example :	any of [string, object[array[string]], null]
Resource optional	Resource Example : `['*']`	array[string]
Sid optional	Sid Example : `Statement1`	string	statement1

45 - Tag

Name	Description	Schema	Default
key required	Tag Key Example :	string
value required	Tag Value Example :	any of [string, null]

46 - Trigger

Name	Description	Schema
alias required	Alias Example : `$LATEST`	string
schedule optional	Schedule Example : `* * * * 0`	any of [string, null]
timezone optional	Timezone Example : `Asia/Tokyo`	any of [string, null]
trigger_id required	Trigger ID Example : `1`	integer
trigger_name required	Trigger name Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
trigger_sid required	Trigger target account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	any of [string, null]
trigger_target_account_id required	Trigger target account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	any of [string, null]
trigger_target_srn required	Trigger target SRN Example : `srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe`	any of [string, null]
trigger_target_uuid required	Trigger target UUID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
trigger_type required	Trigger type Example : `apigateway`	string

47 - TriggerCreateResponse

Name	Description	Schema
alias optional	Alias Example : `$LATEST`	any of [string, null]
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
triggers required	Triggers	array[TriggerForList]

48 - TriggerDeleteRequest

Name	Description	Schema	Default
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656` Pattern : `^[0-9a-f]{32}$`	string
trigger_type required	Trigger type Example : `apigateway`	string

49 - TriggerForList

Name	Description	Schema
schedule optional	Schedule Example : `* * * * 0`	any of [string, null]
timezone optional	Timezone Example : `Asia/Tokyo`	any of [string, null]
trigger_id optional	Trigger ID Example : `1`	any of [integer, null]
trigger_name required	Trigger name Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
trigger_target_account_id required	Trigger target account ID Example : `617b3d0e90c24a5fa1f65a3824861354`	any of [string, null]
trigger_target_srn required	Trigger target SRN Example : `srn:dev2::f32265726b694b32920aa3b111f4c715:::iam:user/9abd88ba08434777a8ca168e799eebbe`	any of [string, null]
trigger_target_uuid required	Trigger target UUID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
trigger_type required	Trigger type Example : `apigateway`	string

50 - TriggersResponse

Name	Description	Schema
alias required	Alias Example : `$LATEST`	string
count required	Count Example : `20`	integer
triggers required	Triggers	array[TriggerForList]

51 - TriggerUpdateResponse

Name	Description	Schema
alias optional	Alias Example : `$LATEST`	any of [string, null]
cloud_function_id required	Cloud Functions ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
triggers required	Triggers	array[TriggerForList]