Resource Manager

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Resourcemanager 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

VersionStatusSupported Until
1.0CURRENT-

OpenAPI URL

https://resourcemanager.{environment}.samsungsdscloud.com

Environment and Region List

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

1 - APIs

1.1 - CreateResourceGroup

1.1.1 - 1.0

post /v1/resource-groups

Description

create a resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ResourceGroupCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedResourceGroupCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resource-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 = resourcemanager 1.0"

Request body

{
    "description": "resource group 1",
    "name": "resource-group-1",
    "region": "kr-west1",
    "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
    "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}

Example HTTP response

Response 201

{
    "resource_group": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "resource group 1",
        "id": "1486t61d84b354fb9135cc467owe1346",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "resource-group-1",
        "region": "kr-west1",
        "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
    }
}

1.2 - DeleteComponentsTag

1.2.1 - 1.0

delete /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Description

delete a specific components tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone

Responses

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

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Request header

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

Example HTTP response

Response 204

1.3 - DeleteComponentsTags

1.3.1 - 1.0

delete /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}

Description

delete components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone

Responses

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

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}

Request header

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

Example HTTP response

Response 204

1.4 - DeleteResourceGroup

1.4.1 - 1.0

delete /v1/resource-groups/{resource_group_id}

Description

delete a specific resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone

Example HTTP request

Request path

/v1/resource-groups/{resource_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 = resourcemanager 1.0"

Example HTTP response

Response 204

1.5 - DeleteResourceGroups

1.5.1 - 1.0

delete /v1/resource-groups

Description

delete a specific resource_groups

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ResourceGroupsDeleteRequest

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone

Example HTTP request

Request path

/v1/resource-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 = resourcemanager 1.0"

Request body

{
    "ids": "[\"8156q42h99z489mniehcpo103ekx5836\", \"1486t61d84b354fb9135cc467owe1346\"]"
}

Example HTTP response

Response 204

1.6 - DeleteResourceTag

1.6.1 - 1.0

delete /v1/tags/{srn}/{key}

Description

delete a specific resource tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone

Responses

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

Example HTTP request

Request path

/v1/tags/{srn}/{key}

Request header

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

Example HTTP response

Response 204

1.7 - DeleteResourceTags

1.7.1 - 1.0

delete /v1/tags/{srn}

Description

delete resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone

Responses

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

Example HTTP request

Request path

/v1/tags/{srn}

Request header

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

Example HTTP response

Response 204

1.8 - DeleteTags

1.8.1 - 1.0

delete /v1/tags

Description

delete tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TagDeleteRequest

Responses

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

Example HTTP request

Request path

/v1/tags

Request header

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

Request body

{
    "tags": "{\"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m\": [\"key1\", \"key4\"]}"
}

Example HTTP response

Response 204

1.9 - ListComponentsTags

1.9.1 - 1.0

get /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}

Description

get components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
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
querykey
optional
태그 key
Example : tag-key
any of [string, null]None
queryvalue
optional
태그 value
Example : tag-value
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKTagShowListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}

Request header

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

Example HTTP response

Response 200

{
    "content": {
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tags": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    },
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.10 - ListResourceGroupResources

1.10.1 - 1.0

get /v1/resource-groups/{resource_group_id}/resources

Description

list a specific resource_group_resources

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
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

Responses

HTTP CodeDescriptionSchema
200OKResourcePageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resource-groups/{resource_group_id}/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "resources": [
        {
            "account_id": "1234ab567cd64769e8f9g490hi304891",
            "created_at": "2025-02-27T10:23:43Z",
            "created_by": "7123ke8439734e5789lj355b17ef5473",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "product_name": "Virtual Server",
            "region": "kr-west1",
            "resource_name": "resource-name-1",
            "resource_type": "virtual-server",
            "resource_type_display_name": "Virtual Server",
            "service": "virtualserver",
            "service_name": "Virtual Server",
            "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
            "state": "Success",
            "tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.11 - ListResourceGroups

1.11.1 - 1.0

get /v1/resource-groups

Description

get resource_groups list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
any of [string, null]None
queryname
optional
리소스 그룹명
Example : resource-group-1
any of [string, null]None
queryregion
optional
리전
Example : kr-west1
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKResourceGroupPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resource-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 = resourcemanager 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "resource_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "resource group 1",
            "id": "1486t61d84b354fb9135cc467owe1346",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "resource-group-1",
            "region": "kr-west1",
            "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
            "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.12 - ListResources

1.12.1 - 1.0

get /v1/resources

Description

get resources list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
any of [string, null]None
queryresource_name
optional
자원명
Example : resource-name-1
any of [string, null]None
queryservice_name
optional
서비스 명
Example : Virtual Server
any of [string, null]None
queryresource_type
optional
자원 유형
Example : virtual-server
any of [string, null]None
queryregion
optional
리전
Example : kr-west1
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKResourcePageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "resources": [
        {
            "account_id": "1234ab567cd64769e8f9g490hi304891",
            "created_at": "2025-02-27T10:23:43Z",
            "created_by": "7123ke8439734e5789lj355b17ef5473",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "product_name": "Virtual Server",
            "region": "kr-west1",
            "resource_name": "resource-name-1",
            "resource_type": "virtual-server",
            "resource_type_display_name": "Virtual Server",
            "service": "virtualserver",
            "service_name": "Virtual Server",
            "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
            "state": "Success",
            "tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.13 - ListResourceTags

1.13.1 - 1.0

get /v1/tags/{srn}

Description

get resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
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
querykey
optional
태그 key
Example : tag-key
any of [string, null]None
queryvalue
optional
태그 value
Example : tag-value
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKTagShowListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{srn}

Request header

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

Example HTTP response

Response 200

{
    "content": {
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tags": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    },
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.14 - ListTagKeys

1.14.1 - 1.0

get /v1/tags/keys

Description

get tag key list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querykey
optional
태그 key
Example : tag-key
any of [string, null]None
queryregion
optional
리전
Example : kr-west1
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKTagKeyResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/keys

Request header

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

Example HTTP response

Response 200

{
    "count": 6,
    "keys": "[\"key1\", \"key2\"]"
}

1.15 - ListTags

1.15.1 - 1.0

get /v1/tags

Description

get tag list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

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
queryaccount_id
optional
어카운트 ID
Example : 1234ab567cd64769e8f9g490hi304891
any of [string, null]None
querykey
optional
태그 key
Example : tag-key
any of [string, null]None
queryvalue
optional
태그 value
Example : tag-value
any of [string, null]None
queryresource_identifier
optional
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
any of [string, null]None
queryresource_type
optional
자원 유형
Example : virtual-server
any of [string, null]None
queryservice
optional
서비스 명
Example : virtualserver
any of [string, null]None
queryoffering
optional
SCP 운영 단위
Example : dev2
any of [string, null]None
queryregion
optional
리전
Example : kr-west1
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKTagListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags

Request header

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

Example HTTP response

Response 200

{
    "content": [
        {
            "key": "tag-key",
            "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
            "value": "tag-value"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.16 - ListTagValues

1.16.1 - 1.0

get /v1/tags/values

Description

get tag value list

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querykey
optional
태그 key
Example : tag-key
any of [string, null]None
queryregion
optional
리전
Example : kr-west1
any of [string, null]None
queryvalue
optional
태그 value
Example : tag-value
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKTagValueResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/values

Request header

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

Example HTTP response

Response 200

{
    "count": 6,
    "values": "[\"value1\", \"value2\"]"
}

1.17 - SetResourceGroup

1.17.1 - 1.0

put /v1/resource-groups/{resource_group_id}

Description

set resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
stringNone
bodybody
required

ResourceGroupUpdateRequest

Responses

HTTP CodeDescriptionSchema
200OKResourceGroupCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resource-groups/{resource_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 = resourcemanager 1.0"

Request body

{
    "description": "resource group 1",
    "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
    "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}

Example HTTP response

Response 200

{
    "resource_group": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "resource group 1",
        "id": "1486t61d84b354fb9135cc467owe1346",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "resource-group-1",
        "region": "kr-west1",
        "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
    }
}

1.18 - ShowComponentsTag

1.18.1 - 1.0

get /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Description

get a specific components tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTagShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Request header

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

Example HTTP response

Response 200

{
    "content": {
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tag": {
            "key": "tag-key",
            "value": "tag-value"
        }
    }
}

1.19 - ShowResource

1.19.1 - 1.0

get /v1/resources/{srn}

Description

get a specific resource

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resources/{srn}

Request header

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

Example HTTP response

Response 200

{
    "resource": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2025-02-27T10:23:43Z",
        "created_by": "7123ke8439734e5789lj355b17ef5473",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "product_name": "Virtual Server",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "state": "Success",
        "tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
    }
}

1.20 - ShowResourceByComponents

1.20.1 - 1.0

get /v1/resources/{region}/{service}/{resource_type}/{resource_identifier}

Description

get a specific resource

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resources/{region}/{service}/{resource_type}/{resource_identifier}

Request header

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

Example HTTP response

Response 200

{
    "resource": {
        "account_id": "1234ab567cd64769e8f9g490hi304891",
        "created_at": "2025-02-27T10:23:43Z",
        "created_by": "7123ke8439734e5789lj355b17ef5473",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "product_name": "Virtual Server",
        "region": "kr-west1",
        "resource_name": "resource-name-1",
        "resource_type": "virtual-server",
        "resource_type_display_name": "Virtual Server",
        "service": "virtualserver",
        "service_name": "Virtual Server",
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "state": "Success",
        "tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
    }
}

1.21 - ShowResourceGroup

1.21.1 - 1.0

get /v1/resource-groups/{resource_group_id}

Description

show a specific resource_group

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
stringNone

Responses

HTTP CodeDescriptionSchema
200OKResourceGroupShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/resource-groups/{resource_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 = resourcemanager 1.0"

Example HTTP response

Response 200

{
    "resource_group": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "resource group 1",
        "id": "1486t61d84b354fb9135cc467owe1346",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "resource-group-1",
        "region": "kr-west1",
        "resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
    }
}

1.22 - ShowResourceTag

1.22.1 - 1.0

get /v1/tags/{srn}/{key}

Description

get a specific resource tag

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone

Responses

HTTP CodeDescriptionSchema
200OKTagShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{srn}/{key}

Request header

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

Example HTTP response

Response 200

{
    "content": {
        "srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
        "tag": {
            "key": "tag-key",
            "value": "tag-value"
        }
    }
}

1.23 - UpdateComponentsTags

1.23.1 - 1.0

put /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/bulk

Description

update components tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
bodybody
required

TagSetRequest

Responses

HTTP CodeDescriptionSchema
200OKTagBaseResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/bulk

Request header

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

Request body

{
    "tags": [
        {
            "key": "tag-key",
            "value": "tag-value"
        }
    ]
}

Example HTTP response

Response 200

{
    "content": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

1.24 - UpdateComponentsTagValue

1.24.1 - 1.0

put /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Description

update components tag value

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required
리전
Example : kr-west1
stringNone
pathservice
required
서비스 명
Example : virtualserver
stringNone
pathresource_type
required
자원 유형
Example : virtual-server
stringNone
pathresource_identifier
required
자원 ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone
bodybody
required

TagValue

Responses

HTTP CodeDescriptionSchema
200OKTagBaseResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}

Request header

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

Request body

{
    "value": "tag-value"
}

Example HTTP response

Response 200

{
    "content": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

1.25 - UpdateResourceTags

1.25.1 - 1.0

put /v1/tags/{srn}/bulk

Description

update resource tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
bodybody
required

TagSetRequest

Responses

HTTP CodeDescriptionSchema
200OKTagBaseResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{srn}/bulk

Request header

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

Request body

{
    "tags": [
        {
            "key": "tag-key",
            "value": "tag-value"
        }
    ]
}

Example HTTP response

Response 200

{
    "content": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

1.26 - UpdateResourceTagValue

1.26.1 - 1.0

put /v1/tags/{srn}/{key}

Description

update resource tag value

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required
SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required
태그 key (base64 encoded KEY)
Example : dGFnLWtleQ==
stringNone
bodybody
required

TagValue

Responses

HTTP CodeDescriptionSchema
200OKTagBaseResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/{srn}/{key}

Request header

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

Request body

{
    "value": "tag-value"
}

Example HTTP response

Response 200

{
    "content": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

1.27 - UpdateTags

1.27.1 - 1.0

put /v1/tags/bulk

Description

update tags

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

TagsSetRequest

Responses

HTTP CodeDescriptionSchema
200OKTagBaseResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/tags/bulk

Request header

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

Request body

{
    "tags": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

Example HTTP response

Response 200

{
    "content": {
        "": [
            {
                "key": "tag-key",
                "value": "tag-value"
            }
        ]
    }
}

2 - Models

2.1 - CreateResourceGroup

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
리소스 그룹 설명
Example : resource group 1
any of [string, null]
id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
리소스 그룹명
Example : resource-group-1
any of [string, null]
region
required
리전
Example : kr-west1
any of [string, null]
resource_types
optional
자원 유형 목록
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
srn
required
SRN
Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
string
tags
optional
태그 목록
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.2 - Resource

NameDescriptionSchemaDefault
account_id
required
어카운트ID
Example : 1234ab567cd64769e8f9g490hi304891
any of [string, null]
created_at
required
생성 일시
Example : 2025-02-27T10:23:43Z
any of [string (date-time), null]
created_by
required
생성자
Example : 7123ke8439734e5789lj355b17ef5473
any of [string, null]
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
product_name
required
상품/서비스
Example : Virtual Server
any of [string, null]
region
required
리전
Example : kr-west1
any of [string, null]
resource_name
required
자원명
Example : resource-name-1
any of [string, null]
resource_type
required
자원 유형
Example : virtual-server
any of [string, null]
resource_type_display_name
required
자원 유형명
Example : Virtual Server
any of [string, null]
service
required
SERVICE
Example : virtualserver
any of [string, null]
service_name
required
서비스 명
Example : Virtual Server
any of [string, null]
srn
required
SRN
Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
any of [string, null]
state
required
상태
Example : Success
any of [string, null]
tags
required
태그 목록
Example : [{"key1": "value1"}, {"key2": "value2"}]
any of [array[object], null]

2.3 - ResourceGroup

NameDescriptionSchemaDefault
created_at
required
생성 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
생성자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required
리소스 그룹 설명
Example : resource group 1
any of [string, null]
id
required
리소스 그룹 ID
Example : 1486t61d84b354fb9135cc467owe1346
string
modified_at
required
수정 시간
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
수정자
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
리소스 그룹명
Example : resource-group-1
any of [string, null]
region
required
리전
Example : kr-west1
any of [string, null]
resource_types
optional
자원 유형 목록
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional
태그 목록
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.4 - ResourceGroupCreateRequest

NameDescriptionSchemaDefault
description
required
리소스 그룹 설명
Example : resource group 1
any of [string, null]
name
required
리소스 그룹명
Example : resource-group-1
Pattern : ^[가-힣ㄱ-ㅎㅏ-ㅣa-zA-Z0-9+=,.\@_-]+$
Minimum length : 3
Maximum length : 64
string
region
optional
리전
Example : kr-west1
any of [string, null]
resource_types
optional
자원 유형 목록 (service:resource_type)
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional
태그 목록
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.5 - ResourceGroupCreateResponse

NameDescriptionSchemaDefault
resource_group
required
리소스 그룹
CreateResourceGroup

2.6 - ResourceGroupPageResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
resource_groups
required
리소스 그룹 목록
array[ResourceGroup]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

2.7 - ResourceGroupsDeleteRequest

NameDescriptionSchemaDefault
ids
optional
리소스 그룹 ID 목록
Example : ["8156q42h99z489mniehcpo103ekx5836", "1486t61d84b354fb9135cc467owe1346"]
any of [array[string], null]

2.8 - ResourceGroupShowResponse

NameDescriptionSchemaDefault
resource_group
required
리소스 그룹
CreateResourceGroup

2.9 - ResourceGroupUpdateRequest

NameDescriptionSchemaDefault
description
required
리소스 그룹 설명
Example : resource group 1
any of [string, null]
resource_types
optional
자원 유형 목록 (service:resource_type)
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional
태그 목록
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.10 - ResourcePageResponse

NameDescriptionSchemaDefault
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
resources
optional
자원 목록
array[Resource]
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

2.11 - ResourceShowResponse

NameDescriptionSchemaDefault
resource
optional
자원
Resource

2.12 - SrnKeyValue

NameDescriptionSchemaDefault
key
required
태그 key
Example : tag-key
Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$
Minimum length : 1
Maximum length : 128
string
srn
required
SRN
Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
string
value
required
태그 value
Example : tag-value
Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$
Maximum length : 256
string

2.13 - SrnTag

NameDescriptionSchemaDefault
srn
required
SRN
Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
string
tag
required
태그
any of [Tag, null]

2.14 - SrnTagList

NameDescriptionSchemaDefault
srn
required
SRN
Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496
string
tags
optional
태그 목록
any of [array[Tag], null]

2.15 - Tag

NameDescriptionSchemaDefault
key
required
태그 key
Example : tag-key
Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$
Minimum length : 1
Maximum length : 128
string
value
required
태그 value
Example : tag-value
Pattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$
any of [string, null]

2.16 - TagBaseResponse

NameDescriptionSchemaDefault
content
required
태그 목록
object[array[Tag]]

2.17 - TagDeleteRequest

NameDescriptionSchemaDefault
tags
required
태그 키 목록
Example : {"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]}
object[array[string]]

2.18 - TagKeyResponse

NameDescriptionSchemaDefault
count
required
개수
Example : 6
integer
keys
required
태그 key 목록
Example : ["key1", "key2"]
array[string]

2.19 - TagListResponse

NameDescriptionSchemaDefault
content
required
태그 목록
array[SrnKeyValue]
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

2.20 - TagSetRequest

NameDescriptionSchemaDefault
tags
required
태그 목록
array[Tag]

2.21 - TagShowListResponse

NameDescriptionSchemaDefault
content
required
태그 목록
SrnTagList
count
required
count
Example : 20
integer
page
required
page
Example : 0
integer
size
required
size
Example : 20
integer
sort
optional
sort
Example : ['created_at:asc']
any of [array[string], null]

2.22 - TagShowResponse

NameDescriptionSchemaDefault
content
required
태그
SrnTag

2.23 - TagsSetRequest

NameDescriptionSchemaDefault
tags
required
태그 목록
object[array[Tag]]

2.24 - TagValue

NameDescriptionSchemaDefault
value
required
SRN
Example : tag-value
string

2.25 - TagValueResponse

NameDescriptionSchemaDefault
count
required
개수
Example : 6
integer
values
required
태그 value 목록
Example : ["value1", "value2"]
array[string]