V2Api.md

\V2Api

All URIs are relative to https://nks.apigw.ntruss.com/vnks/v2

Method	HTTP request	Description
ClustersGet	Get /clusters
ClustersPost	Post /clusters
ClustersUuidAddSubnetPatch	Patch /clusters/{uuid}/add-subnet
ClustersUuidDelete	Delete /clusters/{uuid}
ClustersUuidGet	Get /clusters/{uuid}
ClustersUuidIpAclGet	Get /clusters/{uuid}/ip-acl
ClustersUuidIpAclPatch	Patch /clusters/{uuid}/ip-acl
ClustersUuidKubeconfigGet	Get /clusters/{uuid}/kubeconfig
ClustersUuidKubeconfigResetPatch	Patch /clusters/{uuid}/kubeconfig/reset
ClustersUuidLbSubnetPatch	Patch /clusters/{uuid}/lb-subnet
ClustersUuidLogPatch	Patch /clusters/{uuid}/log
ClustersUuidNodePoolGet	Get /clusters/{uuid}/node-pool
ClustersUuidNodePoolInstanceNoDelete	Delete /clusters/{uuid}/node-pool/{instanceNo}
ClustersUuidNodePoolInstanceNoLabelsPut	Put /clusters/{uuid}/node-pool/{instanceNo}/labels
ClustersUuidNodePoolInstanceNoPatch	Patch /clusters/{uuid}/node-pool/{instanceNo}
ClustersUuidNodePoolInstanceNoSubnetsPatch	Patch /clusters/{uuid}/node-pool/{instanceNo}/subnets
ClustersUuidNodePoolInstanceNoTaintsPut	Put /clusters/{uuid}/node-pool/{instanceNo}/taints
ClustersUuidNodePoolInstanceNoUpgradePatch	Patch /clusters/{uuid}/node-pool/{instanceNo}/upgrade
ClustersUuidNodePoolPost	Post /clusters/{uuid}/node-pool
ClustersUuidNodesGet	Get /clusters/{uuid}/nodes
ClustersUuidNodesInstanceNoDelete	Delete /clusters/{uuid}/nodes/{instanceNo}
ClustersUuidOidcGet	Get /clusters/{uuid}/oidc
ClustersUuidOidcPatch	Patch /clusters/{uuid}/oidc
ClustersUuidReturnProtectionPatch	Patch /clusters/{uuid}/return-protection
ClustersUuidUpgradePatch	Patch /clusters/{uuid}/upgrade
OptionServerImageGet	Get /option/server-image
OptionServerProductCodeGet	Get /option/server-product-code
OptionVersionGet	Get /option/version
RootGet	Get /

ClustersGet

ClustersRes ClustersGet()

Required Parameters

This endpoint does not need any parameter.

Return type

*ClustersRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersPost

CreateClusterRes ClustersPost(body)

Required Parameters

Name	Type	Description	Notes
body	*ClusterInputBody

Return type

*CreateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidAddSubnetPatch

UpdateClusterRes ClustersUuidAddSubnetPatch(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*AddSubnetDto		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidDelete

ClustersUuidDelete(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

(empty response body)

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidGet

ClusterRes ClustersUuidGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*ClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidIpAclGet

IpAclsRes ClustersUuidIpAclGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*IpAclsRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidIpAclPatch

UpdateClusterRes ClustersUuidIpAclPatch(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*IpAclsDto		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidKubeconfigGet

KubeconfigRes ClustersUuidKubeconfigGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*KubeconfigRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidKubeconfigResetPatch

UpdateClusterRes ClustersUuidKubeconfigResetPatch(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidLbSubnetPatch

UpdateClusterLbSubnetRes ClustersUuidLbSubnetPatch(uuid, lbSubnetNo, optional)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid	lbSubnetNo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
uuid	string	uuid	lbSubnetNo

Return type

*UpdateClusterLbSubnetRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidLogPatch

UpdateClusterRes ClustersUuidLogPatch(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*AuditLogDto		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolGet

NodePoolRes ClustersUuidNodePoolGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*NodePoolRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoDelete

ClustersUuidNodePoolInstanceNoDelete(uuid, instanceNo)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid	instanceNo

Return type

(empty response body)

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoLabelsPut

UpdateNodePoolRes ClustersUuidNodePoolInstanceNoLabelsPut(body, uuid, instanceNo)

Required Parameters

Name	Type	Description	Notes
body	*UpdateNodepoolLabelDto		uuid

Return type

*UpdateNodePoolRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoPatch

ClustersUuidNodePoolInstanceNoPatch(body, uuid, instanceNo)

Required Parameters

Name	Type	Description	Notes
body	*NodePoolUpdateBody		uuid

Return type

(empty response body)

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoSubnetsPatch

UpdateNodePoolRes ClustersUuidNodePoolInstanceNoSubnetsPatch(body, uuid, instanceNo)

Required Parameters

Name	Type	Description	Notes
body	*UpdateNodepoolSubnetDto		uuid

Return type

*UpdateNodePoolRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoTaintsPut

UpdateNodePoolRes ClustersUuidNodePoolInstanceNoTaintsPut(body, uuid, instanceNo)

Required Parameters

Name	Type	Description	Notes
body	*UpdateNodepoolTaintDto		uuid

Return type

*UpdateNodePoolRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolInstanceNoUpgradePatch

UpdateNodePoolRes ClustersUuidNodePoolInstanceNoUpgradePatch(uuid, instanceNo, k8sVersion, optional)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid	instanceNo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
uuid	string	uuid	instanceNo

Return type

*UpdateNodePoolRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodePoolPost

UpdateClusterRes ClustersUuidNodePoolPost(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*NodePoolCreationBody		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodesGet

WorkerNodeRes ClustersUuidNodesGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*WorkerNodeRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidNodesInstanceNoDelete

ClustersUuidNodesInstanceNoDelete(uuid, instanceNo, optional)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid	instanceNo
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
uuid	string	uuid	instanceNo

Return type

(empty response body)

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidOidcGet

OidcRes ClustersUuidOidcGet(uuid)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid

Return type

*OidcRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidOidcPatch

UpdateClusterRes ClustersUuidOidcPatch(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*UpdateOidcDto		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidReturnProtectionPatch

UpdateClusterRes ClustersUuidReturnProtectionPatch(body, uuid)

Required Parameters

Name	Type	Description	Notes
body	*ReturnProtectionDto		uuid

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClustersUuidUpgradePatch

UpdateClusterRes ClustersUuidUpgradePatch(uuid, k8sVersion, optional)

Required Parameters

Name	Type	Description	Notes
uuid	string	uuid	k8sVersion
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
uuid	string	uuid	k8sVersion

Return type

*UpdateClusterRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OptionServerImageGet

OptionsRes OptionServerImageGet(optional)

Required Parameters

Name	Type	Description	Notes
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
hypervisorCode	string

Return type

*OptionsRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OptionServerProductCodeGet

OptionsResForServerProduct OptionServerProductCodeGet(softwareCode, optional)

Required Parameters

Name	Type	Description	Notes
softwareCode	string
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
softwareCode	string		hypervisorCode

Return type

*OptionsResForServerProduct

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

OptionVersionGet

OptionsRes OptionVersionGet(optional)

Required Parameters

Name	Type	Description	Notes
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
from	string		hypervisorCode

Return type

*OptionsRes

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RootGet

RootGet()

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

x-ncp-iam

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]