이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

이 페이지의 일반 화면으로 돌아가기.

Security Group

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다. 본 가이드는 Security Group 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20270131

OpenAPI URL

https://security-group.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.1

Security Group API 버전 1.1이 출시되었습니다.

변경사항

  • [변경] GET /v1/security-group-rules - API 가 변경되었습니다.
    • 응답 모델이 SecurityGroupRuleListResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [변경] POST /v1/security-group-rules - API 가 변경되었습니다.
    • 요청 모델이 SecurityGroupRuleCreateRequestV1Dot1 로 변경되었습니다.
      • 요청 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id
    • 응답 모델이 SecurityGroupRuleShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [변경] GET /v1/security-group-rules/{security_group_rule_id} - API가 변경되었습니다.
    • 응답 모델이 SecurityGroupRuleShowResponseV1Dot1 로 변경되었습니다.
      • 응답 시, 아래와 같은 필드가 추가됩니다.
      • remote_address_group_id, remote_address_group_name
  • [신규] GET /v1/address-groups - API가 추가되었습니다.
  • [신규] POST /v1/address-groups - API가 추가되었습니다.
  • [신규] GET /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/address-groups/{address_group_id} - API가 추가되었습니다.
  • [신규] GET /v1/address-groups/{address_group_id}/addresses - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id}/add_addresses - API가 추가되었습니다.
  • [신규] PUT /v1/address-groups/{address_group_id}/remove_addresses - API가 추가되었습니다.

1.0

Security Group API가 출시되었습니다.

변경사항

  • [신규] GET /v1/security-groups - API가 추가되었습니다.
  • [신규] POST /v1/security-groups - API가 추가되었습니다.
  • [신규] SHOW /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] PUT /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/security-groups/{security_group_id} - API가 추가되었습니다.
  • [신규] GET /v1/security-group-rules - API가 추가되었습니다.
  • [신규] POST /v1/security-group-rules - API가 추가되었습니다.
  • [신규] GET /v1/security-group-rules/{security_group_rule_id} - API가 추가되었습니다.
  • [신규] DELETE /v1/security-group-rules/{security_group_rule_id} - API가 추가되었습니다.

1 - APIs

1.1 - Add Address Group IPs

1.1.1 - 1.1

put /v1/address-groups/{address_group_id}/add_addresses

Description

Address Group에 대상 주소를 추가한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required
AddressGroupCidrsAddRequest

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrsAddRequest
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/add_addresses

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

1.2 - Create Address Group

1.2.1 - 1.1

post /v1/address-groups

Description

Address Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
AddressGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAddressGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
409ConflictNone

Example HTTP request

Request path

/v1/address-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "description": "Example Description for Address Group",
    "name": "ExampleAG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

1.3 - Create Security Group

1.3.1 - 1.1

post /v1/security-groups

Description

Security Group을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecurityGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

1.3.2 - 1.0

post /v1/security-groups

Description

Security Group을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecurityGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

1.4 - Create Security Group Rule

1.4.1 - 1.1

post /v1/security-group-rules

Description

Security Group rule을 생성한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecurityGroupRuleCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupRuleShowResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "description": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

1.4.2 - 1.0

post /v1/security-group-rules

Description

Security Group rule을 생성한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecurityGroupRuleCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecurityGroupRuleShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Request body

{
    "description": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

1.5 - Delete Address Group

1.5.1 - 1.1

delete /v1/address-groups/{address_group_id}

Description

Address Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 204

1.6 - Delete Security Group

1.6.1 - 1.1

delete /v1/security-groups/{security_group_id}

Description

Security Group을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 204

1.6.2 - 1.0

delete /v1/security-groups/{security_group_id}

Description

Security Group을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 204

1.7 - Delete Security Group Rule

1.7.1 - 1.1

delete /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 204

1.7.2 - 1.0

delete /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 204

1.8 - List Address Group IPs

1.8.1 - 1.1

get /v1/address-groups/{address_group_id}/addresses

Description

Address Group 대상 주소 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryaddress
optional		Address Group 대상 주소
Example : 10.1.1.1/32
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/addresses

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.9 - List Address Groups

1.9.1 - 1.1

get /v1/address-groups

Description

Address Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
queryname
optional		Address Group 이름
Example : ExampleAG1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/address-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "address_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "address_count": 10,
            "address_limit": 1000,
            "addresses": [
                "10.1.1.1/32",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Address Group",
            "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleAG1",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.10 - List Security Group Rules

1.10.1 - 1.1

get /v1/security-group-rules

Description

Security Group rule 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
querysecurity_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
queryremote_ip_prefix
optional		Security Group Rule IP 주소
Example : 1.1.1.1/32
stringNone
queryremote_group_id
optional		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
querydescription
optional		Security Group Rule 설명
Example : Example Description for Security Group Rule
stringNone
querydirection
optional		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
stringNone
queryservice
optional		Security Group Rule 서비스
Example : TCP 22
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleListResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "remote_address_group_name": "ExampleAG1",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

1.10.2 - 1.0

get /v1/security-group-rules

Description

Security Group rule 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
querysecurity_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
queryremote_ip_prefix
optional		Security Group Rule IP 주소
Example : 1.1.1.1/32
stringNone
queryremote_group_id
optional		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
stringNone
querydescription
optional		Security Group Rule 설명
Example : Example Description for Security Group Rule
stringNone
querydirection
optional		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
stringNone
queryservice
optional		Security Group Rule 서비스
Example : TCP 22
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

1.11 - List Security Groups

1.11.1 - 1.1

get /v1/security-groups

Description

Security Group 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		Security Group ID
Example :
stringNone
queryname
optional		Security Group 이름
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

1.11.2 - 1.0

get /v1/security-groups

Description

Security Group 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryid
optional		Security Group ID
Example :
stringNone
queryname
optional		Security Group 이름
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupListResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone

Example HTTP request

Request path

/v1/security-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

1.12 - Remove Address Group IPs

1.12.1 - 1.1

put /v1/address-groups/{address_group_id}/remove_addresses

Description

Address Group에서 대상 주소를 삭제한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required
AddressGroupCidrsAddRequest

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupCidrsAddRequest
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/remove_addresses

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

1.13 - Set Address Group

1.13.1 - 1.1

put /v1/address-groups/{address_group_id}

Description

Address Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone
bodybody
required
AddressGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "description": "Example Description for Address Group"
}

Example HTTP response

Response 200

1.14 - Set Security Group

1.14.1 - 1.1

put /v1/security-groups/{security_group_id}

Description

Security Group을 수정한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone
bodybody
required
SecurityGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

1.14.2 - 1.0

put /v1/security-groups/{security_group_id}

Description

Security Group을 수정한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone
bodybody
required
SecurityGroupSetRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

1.15 - Show Address Group

1.15.1 - 1.1

get /v1/address-groups/{address_group_id}

Description

Address Group을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaddress_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKAddressGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/address-groups/{address_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

1.16 - Show Security Group

1.16.1 - 1.1

get /v1/security-groups/{security_group_id}

Description

Security Group 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

1.16.2 - 1.0

get /v1/security-groups/{security_group_id}

Description

Security Group 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_id
required		Security Group ID
Example :
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-groups/{security_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

1.17 - Show Security Group Rule

1.17.1 - 1.1

get /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
queryfields
optional		필드명
Example :
any of [array[object], string, null]None

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleShowResponseV1Dot1
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.1"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

1.17.2 - 1.0

get /v1/security-group-rules/{security_group_rule_id}

Description

Security Group rule을 상세 조회한다.

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathsecurity_group_rule_id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
stringNone
queryfields
optional		필드명
Example :
any of [array[object], string, null]None

Responses

HTTP CodeDescriptionSchema
200OKSecurityGroupRuleShowResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/security-group-rules/{security_group_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

2 - Models

2.1 - AddressGroup

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
address_count
optional		Address Group 대상 주소 개수
Example : 10
integer
address_limit
required		Address Group 대상 주소 최대 개수
Example : 1000
integer
addresses
required		Address Group 대상 주소
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		설명
Example : Example Description for Address Group
any of [string, null]
id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Address Group 이름
Example : ExampleAG1
string
state
required		Address Group 상태
Example : ACTIVE
string

2.2 - AddressGroupCidrListResponse

NameDescriptionSchemaDefault
addresses
required		Address Group 대상 주소 목록
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

2.3 - AddressGroupCidrsAddRequest

NameDescriptionSchemaDefault
addresses
required		Address Group 대상 주소 목록
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
array[string]

2.4 - AddressGroupCreateRequest

NameDescriptionSchemaDefault
addresses
optional		Address Group 대상 주소
Example : ['10.1.1.1/32', '10.1.2.0/24', '10.1.3.0/24']
any of [array[string], null]
description
optional		Address Group 설명
Example : Example Description for Address Group
any of [string, null]
name
required		Address Group 이름
Example : ExampleAG1
string
tags
optional		태그 목록
array[Tag]

2.5 - AddressGroupListResponse

NameDescriptionSchemaDefault
address_groups
required
array[AddressGroup]
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]

2.6 - AddressGroupSetRequest

NameDescriptionSchemaDefault
description
optional		Address Group 설명
Example : Example Description for Address Group
any of [string, null]

2.7 - AddressGroupShowResponse

NameDescriptionSchemaDefault
address_group
required
AddressGroup

2.8 - SecurityGroup

NameDescriptionSchemaDefault
account_id
required		Security Group Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Security Group 설명
Example : Example Description for Security Group
any of [string, null]
id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string
loggable
required		Security Group 로깅 여부
Example : False
boolean
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Security Group 이름
Example : ExampleSG1
string
rule_count
optional		Security Group Rule 수
Example : 200
integer
state
required		Security Group 상태
Example : ACTIVE
string

2.9 - SecurityGroupCreateRequest

NameDescriptionSchemaDefault
description
optional		Security Group 설명
Example : Example Description for Security Group
any of [string, null]
loggable
optional		Security Group 로깅 여부
Example : False
any of [boolean, null]
name
required		Security Group 이름
Example : ExampleSG1
Maximum length : 255
string
tags
optional		태그 목록
array[Tag]

2.10 - SecurityGroupListResponse

NameDescriptionSchemaDefault
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_groups
required
array[SecurityGroup]

2.11 - SecurityGroupRule

NameDescriptionSchemaDefault
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
enum (ingress, egress)
ethertype
optional		Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
port_range_max
required		Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
required		Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
required		Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_group_id
required		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_group_name
optional		Security Group Rule 원격 그룹 이름
Example : ExampleSG2
any of [string, null]
remote_ip_prefix
required		Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

2.12 - SecurityGroupRuleCreateRequest

NameDescriptionSchemaDefault
description
optional		Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
string
ethertype
optional		Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
port_range_max
optional		Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
optional		Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
optional		Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_group_id
optional		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_ip_prefix
optional		Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

2.13 - SecurityGroupRuleCreateRequestV1Dot1

NameDescriptionSchemaDefault
description
optional		Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
string
ethertype
optional		Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
port_range_max
optional		Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
optional		Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
optional		Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_address_group_id
optional		Security Group Rule 주소 그룹 ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
any of [string, null]
remote_group_id
optional		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_ip_prefix
optional		Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

2.14 - SecurityGroupRuleListResponse

NameDescriptionSchemaDefault
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_group_rules
required
array[SecurityGroupRule]

2.15 - SecurityGroupRuleListResponseV1Dot1

NameDescriptionSchemaDefault
count
optional		전체 개수
Example : 20
any of [integer, null]
links
optional		links
Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]
any of [array[object], null]
security_group_rules
required
array[SecurityGroupRuleV1Dot1]

2.16 - SecurityGroupRuleShowResponse

NameDescriptionSchemaDefault
security_group_rule
required
SecurityGroupRule

2.17 - SecurityGroupRuleShowResponseV1Dot1

NameDescriptionSchemaDefault
security_group_rule
required
SecurityGroupRuleV1Dot1

2.18 - SecurityGroupRuleV1Dot1

NameDescriptionSchemaDefault
created_at
required		생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Security Group Rule 설명
Example : Example Description for Security Group Rule
any of [string, null]
direction
required		Security Group Rule 방향 (Ingress, Egress)
Example : Ingress
enum (ingress, egress)
ethertype
optional		Security Group Rule Ethertype (IPV4)
Example : IPv4
any of [string, null]IPv4
id
required		Security Group Rule ID
Example : 10d8250e-f4eb-453a-96af-b50b5b514a1a
string
modified_at
required		수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
port_range_max
required		Security Group Rule 포트 범위 최대값(None/1-65535). For ICMP and IP Protocol, None
Example : 22
any of [integer, null]
port_range_min
required		Security Group Rule 포트 범위 최소값(None, 1-65535). For ICMP, 0-255. For IP Protocol, None
Example : 22
any of [integer, null]
protocol
required		Security Group Rule 프로토콜 (None, TCP, UDP, ICMP, IP Protocol Number 1-254)
Example : TCP
any of [string, null]
remote_address_group_id
required		Address Group ID
Example : 4b18494930bf4c5dbb97a9eb2ef68fe1
any of [string, null]
remote_address_group_name
required		Address Group 이름
Example : ExampleAG1
any of [string, null]
remote_group_id
required		Security Group Rule 원격 그룹 ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
any of [string, null]
remote_group_name
optional		Security Group Rule 원격 그룹 이름
Example : ExampleSG2
any of [string, null]
remote_ip_prefix
required		Security Group Rule IP 주소
Example : 1.1.1.1/32
any of [string, null]
security_group_id
required		Security Group ID
Example : 06e5d676-f330-485a-94e9-47ac91cce09a
string

2.19 - SecurityGroupSetRequest

NameDescriptionSchemaDefault
description
optional		Security Group 설명
Example : Example Description for Security Group
any of [string, null]
loggable
optional		Security Group 로깅 여부
Example : False
any of [boolean, null]

2.20 - SecurityGroupShowResponse

NameDescriptionSchemaDefault
security_group
required
SecurityGroup

2.21 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string