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

Return to the regular view of this page.

Resource Manager

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Resourcemanager service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required		Resource Group 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required		SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource 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		Tag key
Example : tag-key
any of [string, null]None
queryvalue
optional		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required		Resource Group 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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		Resource Group ID
Example : 1486t61d84b354fb9135cc467owe1346
any of [string, null]None
queryname
optional		Resource Group name
Example : resource-group-1
any of [string, null]None
queryregion
optional		Region
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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		Resource ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
any of [string, null]None
queryresource_name
optional		Resource name
Example : resource-name-1
any of [string, null]None
queryservice_name
optional		Service name
Example : Virtual Server
any of [string, null]None
queryresource_type
optional		Resource type
Example : virtual-server
any of [string, null]None
queryregion
optional		Region
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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		Tag key
Example : tag-key
any of [string, null]None
queryvalue
optional		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querykey
optional		Tag key
Example : tag-key
any of [string, null]None
queryregion
optional		Region
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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		Account ID
Example : 1234ab567cd64769e8f9g490hi304891
any of [string, null]None
querykey
optional		Tag key
Example : tag-key
any of [string, null]None
queryvalue
optional		Tag value
Example : tag-value
any of [string, null]None
queryresource_identifier
optional		Resource ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
any of [string, null]None
queryresource_type
optional		Resource type
Example : virtual-server
any of [string, null]None
queryservice
optional		Service name
Example : virtualserver
any of [string, null]None
queryoffering
optional		SCP Offering
Example : dev2
any of [string, null]None
queryregion
optional		Region
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querykey
optional		Tag key
Example : tag-key
any of [string, null]None
queryregion
optional		Region
Example : kr-west1
any of [string, null]None
queryvalue
optional		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required		Resource Group 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathresource_group_id
required		Resource Group 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required		SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathregion
required		Region
Example : kr-west1
stringNone
pathservice
required		Service name
Example : virtualserver
stringNone
pathresource_type
required		Resource type
Example : virtual-server
stringNone
pathresource_identifier
required		Resource ID
Example : z95fa561-11u3-4frw-962g-3b123123c496
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsrn
required		SRN (base64 encoded SRN)
Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng==
stringNone
pathkey
required		Tag 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 = en-US",
"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

State ACTIVE (CURRENT)

VersionNot Before
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 = en-US",
"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		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Resource Group description
Example : resource group 1
any of [string, null]
id
required		Resource Group ID
Example : 1486t61d84b354fb9135cc467owe1346
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Resource Group name
Example : resource-group-1
any of [string, null]
region
required		Region
Example : kr-west1
any of [string, null]
resource_types
optional		Resource type list
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		Tag list
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.2 - Resource

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 1234ab567cd64769e8f9g490hi304891
any of [string, null]
created_at
required		Created At
Example : 2025-02-27T10:23:43Z
any of [string (date-time), null]
created_by
required		Created By
Example : 7123ke8439734e5789lj355b17ef5473
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
product_name
required		Product/Service
Example : Virtual Server
any of [string, null]
region
required		Region
Example : kr-west1
any of [string, null]
resource_name
required		Resource name
Example : resource-name-1
any of [string, null]
resource_type
required		Resource type
Example : virtual-server
any of [string, null]
resource_type_display_name
required		Resource type name
Example : Virtual Server
any of [string, null]
service
required		Service
Example : virtualserver
any of [string, null]
service_name
required		Service name
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		State
Example : Success
any of [string, null]
tags
required		Tag list
Example : [{"key1": "value1"}, {"key2": "value2"}]
any of [array[object], null]

2.3 - ResourceGroup

NameDescriptionSchemaDefault
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Resource Group description
Example : resource group 1
any of [string, null]
id
required		Resource Group ID
Example : 1486t61d84b354fb9135cc467owe1346
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Resource Group name
Example : resource-group-1
any of [string, null]
region
required		Region
Example : kr-west1
any of [string, null]
resource_types
optional		Resource type list
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional		Tag list
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.4 - ResourceGroupCreateRequest

NameDescriptionSchemaDefault
description
required		Resource Group description
Example : resource group 1
any of [string, null]
name
required		Resource Group name
Example : resource-group-1
Pattern : ^[가-힣ㄱ-ㅎㅏ-ㅣa-zA-Z0-9+=,.\@_-]+$
Minimum length : 3
Maximum length : 64
string
region
optional		Region
Example : kr-west1
any of [string, null]
resource_types
optional		Resource type list (service:resource_type)
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional		Tag list
Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}]
any of [array[Tag], null]

2.5 - ResourceGroupCreateResponse

NameDescriptionSchemaDefault
resource_group
required		Resource Group
CreateResourceGroup

2.6 - ResourceGroupPageResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
resource_groups
required		Resource Group list
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		Resource Group ID list
Example : ["8156q42h99z489mniehcpo103ekx5836", "1486t61d84b354fb9135cc467owe1346"]
any of [array[string], null]

2.8 - ResourceGroupShowResponse

NameDescriptionSchemaDefault
resource_group
required		Resource Group
CreateResourceGroup

2.9 - ResourceGroupUpdateRequest

NameDescriptionSchemaDefault
description
required		Resource Group description
Example : resource group 1
any of [string, null]
resource_types
optional		Resource type list (service:resource_type)
Example : ["resourcemanager:resource-group", "loggingaudit:trail"]
any of [array[string], null]
tags
optional		Tag list
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		Resource list
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
Resource

2.12 - SrnKeyValue

NameDescriptionSchemaDefault
key
required		Tag 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		Tag 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		Tag
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		Tag list
any of [array[Tag], null]

2.15 - Tag

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

2.16 - TagBaseResponse

NameDescriptionSchemaDefault
content
required		Tag list
object[array[Tag]]

2.17 - TagDeleteRequest

NameDescriptionSchemaDefault
tags
required		Tag key list
Example : {"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]}
object[array[string]]

2.18 - TagKeyResponse

NameDescriptionSchemaDefault
count
required		Count
Example : 6
integer
keys
required		Tag key list
Example : ["key1", "key2"]
array[string]

2.19 - TagListResponse

NameDescriptionSchemaDefault
content
required		Tag list
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		Tag list
array[Tag]

2.21 - TagShowListResponse

NameDescriptionSchemaDefault
content
required		Tag list
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		Tag
SrnTag

2.23 - TagsSetRequest

NameDescriptionSchemaDefault
tags
required		Tag list
object[array[Tag]]

2.24 - TagValue

NameDescriptionSchemaDefault
value
required		SRN
Example : tag-value
string

2.25 - TagValueResponse

NameDescriptionSchemaDefault
count
required		Count
Example : 6
integer
values
required		Tag value list
Example : ["value1", "value2"]
array[string]