- HOME
- API overview
- API overview
- Calling and authenticating API
- API data types
- VPC
- Platform
- Account
- AppliedCreditHistory
- AppliedProductDiscountHistory
- Coin
- CoinHistory
- CoinHistoryList
- CoinUseHistory
- Contract
- ContractList
- ContractDemandCost
- ContractDemandCostList
- ContractProduct
- ContractSummary
- ContractSummaryList
- ContractUsageList
- ContractUsageByDaily
- ContractUsageListByDaily
- CostRelationCode
- CostRelationCodeList
- CountryPeriodUnit
- CountryUnit
- Credit
- CreditHistory
- CreditHistoryList
- CreditUseHistory
- DemandCost
- DemandCostList
- Discount
- DiscountList
- PackageUnit
- PeriodUnit
- Price
- PriceList
- Product(For Billing)
- ProductList(For Billing)
- ProductCategoryList
- ProductDemandCost
- ProductDemandCostList
- ProductDemandCostByDiscount
- ProductDemandCostByDiscountList
- ProductDemandType
- ProductDiscount
- ProductDiscountHistory
- ProductDiscountHistoryList
- ProductDiscountUseHistory
- ProductPrice
- ProductPriceList
- Region(For Billing)
- RegionList(For Billing)
- SectionPrice
- SectionPriceList
- ShareCoinSnapshot
- Usage
- UseDate
- Compute
- AccessControlGroup
- AccessControlGroupList
- AccessControlGroupNoList
- AccessControlGroupRule
- AccessControlGroupRuleList
- ActivityLog
- ActivityLogList
- AdjustmentType
- AdjustmentTypeList
- AutoScalingGroup
- AutoScalingGroupList
- BlockDevicePartition
- BlockStorageInstance
- BlockStorageInstanceList
- BlockStorageMapping
- BlockStorageSnapshotInstance
- BlockStorageSnapshotInstanceList
- BlockStorageVolumeType
- BlockStorageVolumeTypeList
- CommonCode
- CommonResponse
- FlowLogConfiguration
- FlowLogConfigurationList
- HypervisorTypeList
- InAutoScalingGroupServerInstance
- InitScript
- InitScriptList
- KeyName
- LaunchConfiguration
- LaunchConfigurationList
- LoginKey
- LoginKeyList
- MemberServerImage
- MemberServerImageInstance
- MemberServerImageInstanceList
- NetworkInterface
- NetworkInterfaceList
- NetworkInterfaceNoList
- PlacementGroup
- PlacementGroupList
- PrivateKey
- Process
- ProcessList
- Product
- ProductList
- ProtocolType
- PublicIpInstance
- PublicIpInstanceList
- Raid
- RaidList
- Region
- RegionList
- RootPassword
- RootPasswordServerInstance
- RootPasswordServerInstanceList
- ScalingPolicy
- ScalingPolicyList
- ScheduledUpdateGroupAction
- ScheduledUpdateGroupActionList
- SecondaryIpList
- ServerImage
- ServerImageList
- ServerInstance
- ServerInstanceList
- ServerInstanceNoList
- ServerSpec
- ServerSpecList
- SharedLoginIdList
- SuspendedProcess
- Zone
- ZoneList
- Storage
- Networking
- HostHeaderCondition
- HostHeaderList
- HostHeaderList
- IpList
- LoadBalancerInstance
- LoadBalancerInstanceList
- LoadBalancerIpList
- LoadBalancerListener
- loadBalancerListenerCertificate
- LoadBalancerListenerNoList
- LoadBalancerRule
- loadBalancerListenerCertificateList
- LoadBalancerListenerList
- LoadBalancerRuleAction
- LoadBalancerRuleNoList
- LoadBalancerSubnet
- LoadBalancerRuleCondition
- LoadBalancerRuleList
- NatGatewayInstance
- NatGatewayInstanceList
- NetworkAcl
- NetworkAclDenyAllowGroup
- NetworkAclRule
- NetworkAclDenyAllowGroupList
- NetworkAclList
- NetworkAclRuleList
- PathPatternCondition
- PathPatternList
- PolicyDetailResponse
- PolicyListResponse
- PolicyRequest
- ProfileDetailResponse
- ProfileListResponse
- ProfileRequest
- RedirectionAction
- Route
- RouteList
- RouteTable
- RouteTableList
- Subnet
- SubnetList
- SubnetNoList
- Target
- TargetGroup
- TargetNoList
- TargetSubnet
- TargetGroupAction
- TargetGroupNoList
- TargetGroupWeight
- TargetGroupList
- TargetList
- TargetSubnetList
- TargetVpc
- TargetVpcList
- Vpc
- VpcList
- VpcPeeringInstance
- VpcPeeringInstanceList
- CipherSuiteList
- Database
- CloudDbProduct
- CloudDbProductList
- Cloud DB for MySQL
- CloudMysqlBackup
- CloudMysqlBackupList
- CloudMysqlBackupDetail
- CloudMysqlBackupDetailList
- CloudMysqlConfigList
- CloudMysqlDatabase
- CloudMysqlDatabaseList
- CloudMysqlDbServerLog
- CloudMysqlDbServerLogList
- CloudMysqlEventHistory
- CloudMysqlEventHistoryList
- CloudMysqlInstance
- CloudMysqlInstanceList
- CloudMysqlInstanceForHiveMetaStore
- CloudMysqlInstanceListForHiveMetaStore
- CloudMysqlRecoveryTime
- CloudMysqlServerInstance
- CloudMysqlUser
- CloudMysqlUserList
- CloudMysqlUserForHiveMetaStore
- CloudMysqlUserListForHiveMetaStore
- Cloud DB for Redis
- CloudRedisBackup
- CloudRedisBackupList
- CloudRedisBackupDetail
- CloudRedisBackupDetailList
- CloudRedisBucket
- CloudRedisBucketList
- CloudRedisConfigGroup
- CloudRedisConfigGroupList
- CloudRedisConfigGroupVersion
- CloudRedisConfigGroupVersionList
- CloudRedisInstance
- CloudRedisInstanceList
- CloudRedisServerInstance
- Cloud DB for MSSQL
- CloudMssqlBackup
- CloudMssqlBackupList
- CloudMssqlBackupDetail
- CloudMssqlBackupDetailList
- CloudMssqlBucket
- CloudMssqlBucketList
- CloudMssqlCharacterSet
- CloudMssqlCharcterSetList
- CloudMssqlConfigGroup
- CloudMssqlConfigGroupList
- CloudMssqlFolder
- CloudMssqlFolderList
- CloudMssqlInstance
- CloudMssqlInstanceList
- CloudMssqlLogBackupFile
- CloudMssqlLogBackupFileList
- CloudMssqlLogFile
- CloudMssqlLogFileList
- CloudMssqlServerInstance
- Cloud DB for MongoDB
- Cloud DB for PostgreSQL
- CloudPostgresqlBackup
- CloudPostgresqlBackupList
- CloudPostgresqlBackupDetail
- CloudPostgresqlBackupDetailList
- CloudPostgresqlBucket
- CloudPostgresqlBucketList
- CloudPostgresqlConfigList
- CloudPostgresqlDatabase
- CloudPostgresqlDatabaseList
- CloudPostgresqlDbServerLog
- CloudPostgresqlDbServerLogList
- CloudPostgresqlInstance
- CloudPostgresqlInstanceList
- CloudPostgresqlServerInstance
- CloudPostgresqlUser
- CloudPostgresqlUserList
- AI·NAVER API
- Application Services
- GeoLocation
- Cloud Outbound Mailer
- AddressBookRequest
- AddressBookResponse
- AttachFile
- Category
- CountByStatus
- EmailRecipientType
- EmailReservationStatus
- EmailStatus
- HistoryActionType
- MailListResponse
- NesDateTime
- Recipient
- RecipientForRequest
- RecipientGroupFilter
- RequesterType
- RequestListResponse
- SendBlockHistoryResponse
- Sort
- TemplateBackupStatus
- TemplateExportRequestResponse
- TemplateStructureResponse
- UnsubscribersListResponse
- GeolocationList
- Big Data & Analytics
- Cloud Hadoop (VPC)
- CloudHadoopAddOn
- CloudHadoopAddOnList
- CloudHadoopBucket
- CloudHadoopBucketList
- CloudHadoopClusterType
- CloudHadoopClusterTypeList
- CloudHadoopInstance
- CloudHadoopInstanceList
- CloudHadoopLoginKey
- CloudHadoopLoginKeyList
- CloudHadoopNotebookBucket
- CloudHadoopNotebookBucketList
- CloudHadoopNotebookComponent
- CloudHadoopNotebookComponentList
- CloudHadoopNotebookInstance
- CloudHadoopNotebookInstanceList
- CloudHadoopNotebookServerInstance
- CloudHadoopNotebookVersion
- CloudHadoopObject
- CloudHadoopObjectList
- CloudHadoopServerInstance
- CloudHadoopVersion
- Data Forest
- AccountResponse
- AiAppContainer
- AiAppData
- AiAppDocker
- AiAppResource
- AiAppResponse
- AiAppTypeSpec
- AiWorkspaceConfig
- AiWorkspaceResponse
- AppComponentRequest
- AppComponentResponse
- AppContainerResponse
- AppResponse
- CreateAppRequest
- DependableApp
- GetAccountDetailResponse
- GetAccountListResponse
- GetAiAppDetailResponse
- GetAiAppListResponse
- GetAiWorkspaceConfigurationListResponse
- GetAiWorkspaceDetailResponse
- GetAiWorkspaceListResponse
- GetAppBasicSettingResponse
- GetAppDetailResponse
- GetAppListResponse
- QuotaResponse
- SubmitAiAppResponse
- Cloud Hadoop (VPC)
- Platform
- Classic
- Platform
- Account
- AppliedCreditHistory
- AppliedProductDiscountHistory
- Coin
- CoinHistory
- CoinHistoryList
- CoinUseHistory
- Contract
- ContractList
- ContractDemandCost
- ContractDemandCostList
- ContractProduct
- ContractSummary
- ContractSummaryList
- ContractUsageList
- ContractUsageByDaily
- ContractUsageListByDaily
- CostRelationCode
- CostRelationCodeList
- CountryPeriodUnit
- CountryUnit
- Credit
- CreditHistory
- CreditHistoryList
- CreditUseHistory
- DemandCost
- DemandCostList
- Discount
- DiscountList
- PackageUnit
- PeriodUnit
- Price
- PriceList
- Product (For Billing)
- ProductList (For Billing)
- ProductCategoryList
- ProductDemandCost
- ProductDemandCostList
- ProductDemandCostByDiscount
- ProductDemandCostByDiscountList
- ProductDemandType
- ProductDiscount
- ProductDiscountHistory
- ProductDiscountHistoryList
- ProductDiscountUseHistory
- ProductPrice
- ProductPriceList
- Region(For Billing)
- RegionList(For Billing)
- SectionPrice
- SectionPriceList
- ShareCoinSnapshot
- Usage
- UseDate
- Compute
- AccessControlGroup
- AccessControlGroupList
- AccessControlRule
- AccessControlRuleList
- ActivityLog
- ActivityLogList
- AsgPolicy
- AutoScalingGroup
- AutoScalingGroupList
- BlockDevicePartition
- BlockStorageInstance
- BlockStorageInstanceList
- BlockStorageSnapshotInstance
- BlockStorageSnapshotInstanceList
- CollectingInfo
- CollectingInfoList
- CommonCode
- CommonResponse
- ConfigurationLog
- ConfigurationLogList
- InAutoScalingGroupServerInstance
- InitScript
- InitScriptList
- InstanceTag
- InstanceTagList
- LaunchConfiguration
- LaunchConfigurationList
- LoginKey
- LoginKeyList
- MemberServerImage
- MemberServerImageList
- PortForwardingConfiguration
- PortForwardingConfigurationList
- PortForwardingRule
- PortForwardingRuleList
- PrivateKey
- Process
- ProcessList
- Product
- ProductList
- PublicIpInstance
- PublicIpInstanceList
- Raid
- RaidList
- Region
- RegionList
- RootPassword
- RootPasswordServerInstance
- RootPasswordServerInstanceList
- ScalingPolicy
- ScalingPolicyList
- ScheduledUpdateGroupAction
- ScheduledUpdateGroupActionList
- ServerInstance
- ServerInstanceList
- ServerInstanceNoList
- SharedLoginIdList
- SuspendedProcess
- Zone
- ZoneList
- Storage
- Networking
- DomainCreateRequest
- DomainDetailResponse
- DomainListResponse
- DomainQueryResponse
- DomainResponse
- DomainUsage
- LbRecordResponse
- LoadBalancedServerInstance
- LoadBalancerInstance
- LoadBalancerInstanceList
- LoadBalancerInstanceSummary
- LoadBalancerRule
- RecordCreateRequest
- RecordResponse
- RecordUpdateRequest
- ServerHealthCheckStatus
- SslCertificate
- SslCertificateList
- Application Services
- GeoLocation
- Cloud Outbound Mailer
- AddressBookRequest
- AddressBookResponse
- AttachFile
- Category
- CountByStatus
- EmailRecipientType
- EmailReservationStatus
- EmailStatus
- HistoryActionType
- MailListResponse
- NesDateTime
- Recipient
- RecipientForRequest
- RecipientGroupFilter
- RequesterType
- RequestListResponse
- SendBlockHistoryResponse
- Sort
- TemplateBackupStatus
- TemplateExportRequestResponse
- TemplateStructureResponse
- UnsubscribersListResponse
- Big Data & Analytics
- AggregatedResult
- AggregateSchema
- AutocompleteSearchQuery
- AutocompleteSearchSchema
- BuildInfo
- Container
- DocProperty
- GroupBySchema
- Index
- IndexProcessor
- QueryAnalysisField
- Schema
- SearchAggregate
- SearchHighlighting
- SearchPassage
- SearchQuery
- SearchResultProcessing
- SearchScope
- SearchSetting
- Section
- UserDbUpload
- Management & Governance
- ChartDataWidgetDto
- CreateOrUpdateMetricsGrpDto
- CreateOrUpdateRuleGroupDto
- DataQueryRequest
- DataQueryRequestMetricInfo
- DeleteRuleGroupItemDto
- DimensionDto
- DimensionsSelected
- DirectRuleGroupCreateDto
- EventSearchRequest
- EventSearchRequestById
- FieldDto
- MetricListRequest
- MetricsGroupItem
- MonitorGroupItem
- MonitorGrpDto
- PersonalRecipientNotification
- PMCreateUpdateDto
- RecipientNotification
- RuleGroupItemDto
- SuspendRuleItemDto
- TypeGroupRelatedRuleDto
- WidgetMetricInfoDto
- Platform
- VPC
- Platform
- Compute
- Server (VPC)
- Server (VPC) overview
- Server
- Login Key
- Placement Group
- getServerInstanceList
- getServerInstanceDetail
- createServerInstances
- startServerInstances
- stopServerInstances
- rebootServerInstances
- terminateServerInstances
- changeServerInstanceSpec
- getRootPassword
- getRootPasswordServerInstanceList
- setProtectServerTermination
- interruptServerInstance
- Server Image
- removeServerImageSharingPermission
- addServerImageSharingPermission
- getServerImageList
- getServerImageDetail
- createServerImageFromSnapshot
- createServerImage
- deleteServerImage
- getMemberServerImageInstanceList
- getMemberServerImageInstanceDetail
- createMemberServerImageInstance
- deleteMemberServerImageInstances
- setMemberServerImageSharingPermission
- addMemberServerImageSharingPermission
- removeMemberServerImageSharingPermission
- Storage
- Snapshot
- Public IP
- Init Script
- Network Interface
- getNetworkInterfaceList
- unassignSecondaryIps
- assignSecondaryIps
- getNetworkInterfaceDetail
- createNetworkInterface
- deleteNetworkInterface
- attachNetworkInterface
- detachNetworkInterface
- addNetworkInterfaceAccessControlGroup
- removeNetworkInterfaceAccessControlGroup
- enableFlowLog
- disableFlowLog
- getFlowLogConfigurationList
- ACG
- Common
- Server (VPC) metrics
- Server
- Server Overview
- getServerProductList
- getServerImageProductList
- getRaidList
- getZoneList
- getRegionList
- getInitScriptList
- getLoginKeyList
- createLoginKey
- deleteLoginKey
- importLoginKey
- getAccessControlGroupList
- getAccessControlGroupServerInstanceList
- getAccessControlRuleList
- getServerInstanceList
- createServerInstances
- recreateServerInstance
- terminateServerInstances
- changeServerInstanceSpec
- rebootServerInstances
- startServerInstances
- stopServerInstances
- getRootPassword
- getRootPasswordServerInstanceList
- getMemberServerImageList
- createMemberServerImage
- deleteMemberServerImages
- getBlockStorageInstanceList
- createBlockStorageInstance
- deleteBlockStorageInstances
- changeBlockStorageVolumeSize
- attachBlockStorageInstance
- detachBlockStorageInstances
- createBlockStorageSnapshotInstance
- deleteBlockStorageSnapshotInstances
- getBlockStorageSnapshotInstanceList
- getPublicIpTargetServerInstanceList
- createPublicIpInstance
- associatePublicIpWithServerInstance
- disassociatePublicIpFromServerInstance
- deletePublicIpInstances
- getPortForwardingRuleList
- getPublicIpInstanceList
- deletePortForwardingRules
- createInstanceTags
- deleteInstanceTags
- getInstanceTagList
- addPortForwardingRules
- getPortForwardingConfigurationList
- setMemberServerImageSharingPermission
- addMemberServerImageSharingPermission
- removeMemberServerImageSharingPermission
- setProtectServerTermination
- interruptServerInstance
- Server metrics
- Auto Scaling (VPC)
- Auto Scaling Overview
- Launch Configuration
- Auto Scaling Group
- getAutoScalingGroupList
- getAutoScalingGroupDetail
- createAutoScalingGroup
- updateAutoScalingGroup
- deleteAutoScalingGroup
- setDesiredCapacity
- getScheduledActionList
- putScheduledUpdateGroupAction
- deleteScheduledUpdateGroupAction
- getScalingProcessTypeList
- suspendProcesses
- resumeProcesses
- getAutoScalingActivityLogList
- getAutoScalingPolicyList
- getAdjustmentTypeList
- putScalingPolicy
- deleteScalingPolicy
- executePolicy
- Auto Scaling (VPC) metrics
- Auto Scaling
- Auto Scaling Overview
- setServerInstanceHealth
- putScheduledUpdateGroupAction
- updateAutoScalingGroup
- resumeProcesses
- executePolicy
- deletePolicy
- deleteScheduledAction
- getLaunchConfigurationList
- terminateServerInstanceInAutoScalingGroup
- getAutoScalingGroupList
- deleteAutoScalingLaunchConfiguration
- getScheduledActionList
- putScalingPolicy
- getAutoScalingActivityLogList
- createLaunchConfiguration
- getScalingProcessTypeList
- suspendProcesses
- getAutoScalingConfigurationLogList
- getAdjustmentTypeList
- createAutoScalingGroup
- getAutoScalingPolicyList
- deleteAutoScalingGroup
- setDesiredCapacity
- Auto Scaling metrics
- Cloud Functions
- Cloud Functions overview
- v2.1
- Get package list
- Get package
- Put Package
- Delete package
- Get action list
- Get action
- Put Action
- Post action
- Delete action
- Get action's activation list
- Get action's activation detail
- Get Trigger List
- Get trigger
- Put Trigger
- Post trigger
- Delete trigger
- Post Trigger Link Action
- Delete Trigger Link Action
- Get trigger's activation list
- Get trigger's activation detail
- Get activation list
- v2.0
- Get package list
- Get package
- Put package
- Delete package
- Get action list
- Get action
- Put Action
- Post action
- Delete action
- Get action's activation list
- Get action's activation detail
- Get trigger list
- Get trigger
- Put Trigger
- Post trigger
- Delete trigger
- Post trigger link action
- Delete trigger link action
- Get trigger's activation list
- Get trigger's activation detail
- Get activation list
- Metadata (VPC)
- Server (VPC)
- Containers
- Container Registry
- Ncloud Kubernetes Service (VPC)
- Ncloud Kubernetes Service overview
- Get cluster list
- Get cluster
- Create cluster
- Upgrade cluster version
- Set cluster audit log
- Add cluster subnet
- Set cluster OIDC
- View cluster OIDC
- Set cluster IP ACL
- View cluster IP ACL
- Edit cluster LB subnet
- Set cluster termination protection
- Set cluster secret encryption
- Set cluster authentication mode
- Get cluster IAM access list
- Get cluster IAM access
- Create cluster IAM access
- Edit cluster IAM access
- Delete cluster IAM access
- Delete cluster
- View WorkerNode
- Delete WorkerNode
- View NodePool
- Create NodePool
- Edit NodePool
- Edit NodePool subnet
- Edit NodePool label
- Edit NodePool taint
- Upgrade NodePool
- Delete NodePool
- View kubeconfig
- Reset kubeconfig
- View supported K8s versions
- View server image
- View server specifications
- Ncloud Kubernetes Service (VPC) metrics
- Storage
- Object Storage
- Object Storage overview
- ListBuckets
- PutBucket
- ListObjects
- ListObjectsV2
- HeadBucket
- DeleteBucket
- PutBucketACL
- GetBucketACL
- PutBucketCORS
- GetBucketCORS
- DeleteBucketCORS
- ListMultipartUploads
- PutObject
- PutObject (Copy)
- GetObject
- HeadObject
- DeleteObject
- DeleteMultipleObjects
- PutObjectACL
- GetObjectACL
- OptionsObjectCORS
- InitiateMultipartUpload
- UploadPart
- ListParts
- CompleteMultipartUpload
- AbortMultipartUpload
- Object Storage metrics
- Archive Storage
- NAS (VPC)
- NAS
- Object Storage
- Networking
- VPC
- VPC Overview
- VPC Management
- Subnet Management
- Network ACL
- getNetworkAclList
- getNetworkAclDetail
- createNetworkAcl
- deleteNetworkAcl
- setSubnetNetworkAcl
- getNetworkAclRuleList
- addNetworkAclInboundRule
- addNetworkAclOutboundRule
- removeNetworkAclInboundRule
- removeNetworkAclOutboundRule
- setNetworkAclDescription
- getNetworkAclDenyAllowGroupList
- getNetworkAclDenyAllowGroupDetail
- createNetworkAclDenyAllowGroup
- deleteNetworkAclDenyAllowGroup
- setNetworkAclDenyAllowGroupIpList
- setNetworkAclDenyAllowGroupDescription
- NAT Gateway
- VPC Peering
- Route Table
- Load Balancer (VPC)
- Load Balancer Overview
- Load Balancer
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- setLoadBalancerDescription
- setLoadBalancerInstanceSubnet
- deleteLoadBalancerInstances
- getLoadBalancerInstanceDetail
- getLoadBalancerInstanceList
- createLoadBalancerListener
- changeLoadBalancerListenerConfiguration
- deleteLoadBalancerListeners
- getLoadBalancerListenerList
- getLoadBalancerRuleList
- addLoadBalancerListenerCertificate
- removeLoadBalancerListenerCertificate
- getLoadBalancerListenerCertificateList
- Target Group
- Load Balancer metrics
- Load Balancer
- Load Balancer Overview
- createLoadBalancerInstance
- changeLoadBalancerInstanceConfiguration
- changeLoadBalancedServerInstances
- deleteLoadBalancerInstances
- getLoadBalancerInstanceList
- getLoadBalancedServerInstanceList
- getLoadBalancerTargetServerInstanceList
- addLoadBalancerSslCertificate
- deleteLoadBalancerSslCertificate
- getLoadBalancerSslCertificateList
- Load Balancer metrics
- Global DNS
- Global Traffic Manager
- Profile
- Policy
- Policy overview
- Create traffic policy
- Edit traffic policy
- Delete traffic policy
- View traffic policy
- View traffic policy details
- View traffic policy resource details
- Edit traffic policy resource
- Edit specific resource of traffic policy
- Edit traffic policy health check
- Delete traffic policy health check
- View traffic policy resource type
- View traffic policy health check region
- View traffic policy Load Balancer type
- Geo / CIDR Map
- Monitoring
- VPC
- Database
- Cloud DB
- CloudDB Overview
- createCloudDBInstance
- deleteCloudDBServerInstance
- getCloudDBInstanceList
- getCloudDBConfigGroupList
- getCloudDBImageProductList
- getCloudDBProductList
- rebootCloudDBServerInstance
- flushCloudDBInstance
- setObjectStorageInfo
- downloadDmsFile
- uploadDmsFile
- getObjectStorageBackupList
- getBackupList
- restoreDmsDatabase
- restoreDmsTransactionLog
- getDmsOperation
- getCloudDBBackupDetailList
- exportBackupToObjectStorage
- getDbServerLogList
- exportDbServerLogToObjectStorage
- Cloud DB for Redis metrics
- Cloud DB for PostgreSQL (VPC)
- Cloud DB for PostgreSQL (on VPC) overview
- addCloudPostgresqlDatabaseList
- addCloudPostgresqlUserList
- changeCloudPostgresqlUserList
- createCloudPostgresqlInstance
- createCloudPostgresqlReadReplicaInstance
- deleteCloudPostgresqlDatabaseList
- deleteCloudPostgresqlInstance
- deleteCloudPostgresqlReadReplicaInstance
- deleteCloudPostgresqlUserList
- exportBackupToObjectStorage
- exportDbServerLogToObjectStorage
- getCloudPostgresqlBackupDetailList
- getCloudPostgresqlBackupList
- getCloudPostgresqlBucketList
- getCloudPostgresqlDatabaseList
- getCloudPostgresqlImageProductList
- getCloudPostgresqlInstanceDetail
- getCloudPostgresqlInstanceList
- getCloudPostgresqlProductList
- getCloudPostgreSqlTargetSubnetList
- getCloudPostgresqlTargetVpcList
- getCloudPostgresqlUserList
- getDbServerLogList
- rebootCloudPostgresqlServerInstance
- Cloud DB for PostgreSQL (VPC) metrics
- Cloud DB for MySQL (VPC)
- Cloud DB for MySQL (VPC) overview
- addCloudMysqlDatabaseList
- addCloudMysqlUserList
- changeCloudMysqlServerSpec
- changeCloudMysqlUserList
- createCloudMysqlInstance
- createCloudMysqlRecoveryInstance
- createCloudMysqlSlaveInstance
- deleteCloudMysqlDatabaseList
- deleteCloudMysqlInstance
- deleteCloudMysqlServerInstance
- deleteCloudMysqlUserList
- exportBackupToObjectStorage
- exportDbServerLogToObjectStorage
- getCloudMysqlBackupDetailList
- getCloudMysqlBackupList
- getCloudMysqlDatabaseList
- getCloudMysqlEventHistoryList
- getCloudMysqlImageProductList
- getCloudMysqlInstanceDetail
- getCloudMysqlInstanceList
- getCloudMysqlProductList
- getCloudMysqlRecoveryTime
- getCloudMysqlTargetSubnetList
- getCloudMysqlTargetVpcList
- getCloudMysqlUserList
- getDbServerLogList
- rebootCloudMysqlServerInstance
- Cloud DB for MySQL (VPC) metrics
- Cloud DB for Redis (VPC)
- Cloud DB for Redis (on VPC) Overview
- createCloudRedisConfigGroup
- createCloudRedisInstance
- deleteCloudRedisConfigGroup
- deleteCloudRedisInstance
- getCloudRedisBackupDetailList
- getCloudRedisBackupList
- getCloudRedisConfigGroupList
- getCloudRedisImageProductList
- getCloudRedisInstanceDetail
- getCloudRedisInstanceList
- getCloudRedisProductList
- getCloudRedisManualBackupList
- flushAllCloudRedisServerInstance
- createCloudRedisManualBackup
- deleteCloudRedisManualBackup
- getCloudRedisConfigGroupVersionList
- getCloudRedisTargetSubnetList
- getCloudRedisTargetVpcList
- exportBackupToObjectStorage
- getCloudRedisBucketList
- rebootCloudRedisServerInstance
- getCloudRedisManualBackupDetailList
- Cloud DB for Redis (VPC) metrics
- Cloud DB for MSSQL (VPC)
- Cloud DB for MSSQL (VPC) overview
- createCloudMssqlInstance
- createCloudMssqlSlaveInstance
- deleteCloudMssqlInstance
- deleteCloudMssqlServerInstance
- exportBackupToObjectStorage
- exportDbServerLogsToObjectStorage
- getCloudMssqlLogBackupFileList
- getCloudMssqlBackupDetailList
- getCloudMssqlBackupList
- getCloudMssqlCharacterSetList
- getCloudMssqlConfigGroupList
- getCloudMssqlImageProductList
- getCloudMssqlInstanceDetail
- getCloudMssqlInstanceList
- getCloudMssqlProductList
- getCloudMssqlTargetSubnetList
- getCloudMssqlTargetVpcList
- getCloudMssqlBucketList
- getCloudMssqlFolderList
- getCloudMssqlLogFileList
- rebootCloudMssqlServerInstance
- Cloud DB for MSSQL (VPC) metrics
- Cloud DB for MongoDB (VPC)
- Cloud DB for MongoDB (VPC) 概述
- exportDbServerLogToObjectStorage
- getDbServerLogList
- addCloudMongoDbUserList
- changeCloudMongoDbConfigCount
- changeCloudMongoDbMongosCount
- changeCloudMongoDbShardCount
- changeCloudMongoDbSecondaryCount
- changeCloudMongoDbUserList
- createCloudMongoDbInstance
- deleteCloudMongoDbInstance
- deleteCloudMongoDbUserList
- getCloudMongoDbBucketList
- exportBackupToObjectStorage
- getCloudMongoDbBackupDetailList
- getCloudMongoDbBackupList
- getCloudMongoDbImageProductList
- getCloudMongoDbInstanceDetail
- getCloudMongoDbInstanceList
- getCloudMongoDbProductList
- getCloudMongoDbTargetSubnetList
- getCloudMongoDbTargetVpcList
- getCloudMongoDbUserList
- rebootCloudMongoDbServerInstance
- Cloud DB for MongoDB (VPC) metrics
- Cloud DB
- Security
- Secure Zone
- Secure Zone overview
- addAddressGroup
- addPolicy
- checkAddressGroupNameDuplicated
- checkPolicyNameDuplicated
- deleteAddressGroup
- deletePolicy
- getAddressGroup
- getAddressGroupList
- getDefaultDenyEventLogStatus
- getHourlyTrafficUsageList
- getIpsecAddress
- getMemberActionLog
- getMemberInfo
- getPolicy
- getPolicyList
- getTrafficLog
- getTrafficUsage
- rearrangePolicy
- setDefaultDenyEventLogStatus
- updateAddressGroup
- updatePolicy
- File Safer
- Security Monitoring
- Web Security Checker
- Key Management Service
- Key Management Service overview
- KMS API 1.0
- KMS API 2.0
- Account Auth API
- Create Key
- Get Key Info
- Get Key List
- Get Public Key
- Delete Key
- Enable Key
- Disable Key
- Enable Key Version
- Disable Key Version
- Rotate Key
- Request Key Deletion
- Cancel Key Deletion
- Enable IP ACL
- Disable IP ACL
- Get ACL Rule List
- Add ACL Rule
- Delete ACL Rule
- Create Token Generator
- Get Token Generator
- Update Token Generator
- Delete Token Generator
- Create Token Set
- Get Key Activity Logs
- Get Latest Use Info
- Get Key Version List
- Update Memo
- Update Rotation Period
- Enable Auto Rotation
- Disable Auto Rotation
- Encrypt
- Decrypt
- Create Custom Key
- Re-encrypt
- Sign
- Verify
- Token Auth API
- Account Auth API
- Certificate Manager
- PrivateCA
- Private CA overview
- Activate Sub CA
- Add CA User
- Create CA
- Create Ocsp
- Delete CA
- Delete CA User
- Delete Ocsp
- Get CA
- Get CA Chain
- Get CA Crl
- Get CA List
- Get CA User List
- Get Crl Config
- Get End Cert
- Get End Cert List
- Get Sub Csr
- Issue End Cert
- Revoke End Cert
- Rotate CRL
- Sign End Csr
- Sign Sub Csr
- Trim Ca
- Update CA
- Update Crl Config
- Webshell Behavior Detector
- Secret Manager
- Secret Manager overview
- Secret Management
- Create Secret
- Get Secret List
- Get Secret Detail
- Get Secret Value
- Update Secret Value
- Update Secret Stage Value
- Get Protection Key List
- Update Protection Key
- Update Secret Memo
- Update Rotation Period
- Update Rotation Trigger
- Delete Rotation Trigger
- Execute Rotation Job
- Cancel Rotation Job
- Retry Rotation Job
- Rollback Rotation Job
- Enable Secret
- Disable Secret
- Enable Auto Rotation
- Disable Auto Rotation
- Request Secret Deletion
- Cancel Secret Deletion
- Delete Secret
- Secret Rotate Control
- Secure Zone
- AI Services
- AiTEMS
- CLOVA Chatbot
- CLOVA OCR
- NCLUE
- NCLUE overview
- Get feature
- Get feature list
- Create feature
- Delete feature
- Get task
- Get task list
- Create task
- Delete task
- Get task run
- Get task run list
- Create task run
- Delete task run
- Get shopping intent
- Get shopping intent list
- Create shopping intent
- Delete shopping intent
- Download shopping intent
- Get custom attributes
- Get custom attributes list
- Create custom attributes
- Delete custom attributes
- CLOVA Speech
- CLOVA Studio
- CLOVA GreenEye
- Papago Translation
- Papago Image Translation
- AI·NAVER API
- Application Services
- GeoLocation
- Simple & Easy Notification Service
- API Gateway
- API Gateway overview
- API
- API Key
- Authorizer
- Canary Test
- Dashboard API Key
- Dashboard Event
- Dashboard Product
- Document
- Export
- Gateway Response
- Gateway Response Header
- Gateway Response Template
- Method
- Method Request Body
- Method Request Parameter
- Method Response
- Method Response Body
- Method Response Header
- Model
- Product
- Published Product
- Resource
- Stage
- Stage Deployment
- Stage Resource
- Usage Plan
- API Gateway Release Notes
- Cloud Outbound Mailer
- Cloud Outbound Mailer Overview
- createMailRequest
- getMail
- getMailList
- getMailRequestList
- getMailRequestStatus
- createFile
- getFile
- deleteFile
- createTemplate
- createTemplateExportRequest
- getTemplate
- getTemplateExportRequestList
- getTemplateStructure
- updateTemplate
- updateTemplateLocationOrName
- exportTemplate
- importTemplate
- deleteTemplate
- restoreTemplate
- createCategory
- updateCategory
- deleteCategory
- createAddressBook
- getAddressBook
- deleteAddressBook
- deleteAddress
- deleteRecipientGroup
- deleteRecipientGroupRelation
- deleteRecipientGroupRelationEmpty
- getSendBlockList
- registerUnsubscribers
- getUnsubscribersList
- deleteUnsubscribers
- createConfig
- getConfig
- Big Data & Analytics
- Cloud Hadoop (VPC)
- Cloud Hadoop (VPC) Overview
- backupClusterConfiguration
- changeCloudHadoopNodeCount
- changeCloudHadoopNodeSpec
- createCloudHadoopInstance
- createCloudHadoopNotebookInstance
- deleteCloudHadoopInstance
- deleteCloudHadoopNotebookInstance
- getCloudHadoopAddOnList
- getCloudHadoopBucketList
- getCloudHadoopClusterTypeList
- getCloudHadoopImageProductList
- getCloudHadoopInstanceDetail
- getCloudHadoopInstanceList
- getCloudHadoopLoginKeyList
- getCloudHadoopMysqlInstanceList
- getCloudHadoopMysqlUserList
- getCloudHadoopNotebookBucketList
- getCloudHadoopNotebookComponentList
- getCloudHadoopNotebookImageProductList
- getCloudHadoopNotebookInstanceDetail
- getCloudHadoopNotebookInstanceList
- getCloudHadoopNotebookProductList
- getCloudHadoopObjectList
- getCloudHadoopProductList
- getCloudHadoopTargetSubnetList
- getCloudHadoopTargetVpcList
- saveExternalHiveMetaStore
- testConnectExternalHiveMetaStore
- Cloud Hadoop (VPC) metrics
- Cloud Hadoop
- Cloud Search
- Cloud Search overview
- Get domain list
- Delete domain
- Create domain
- Edit domain
- Get domain
- Check domain name
- Change Default Ranking
- View Ranking List
- Delete Ranking
- Create Ranking
- View Ranking
- Get autocomplete
- View temporary domain lists
- Delete temporary domain
- Create temporary domain
- Edit temporary domain
- Temporary domain view
- Validate schema
- Edit schema
- Get schema history
- Get schema
- Search documents
- Document management
- Manage Object Storage documents
- Query Analysis Count
- Query Analysis Group By Count
- Query Analysis Time Series
- View DB Connection
- DB Connection check (VPC)
- Map DB table
- Map DB table (VPC)
- Search DB table
- Search DB table (VPC)
- Run DB upload
- Run DB upload (VPC)
- Search DB upload
- Search autocomplete
- Enable and edit autocomplete
- Get autocomplete history
- Change container count
- Get container list
- Change container type
- Get monitoring data
- Get stop word policy list
- Delete stop word policy
- Set stop word policy
- Get stop word policy
- Get available language
- Get morphological analysis options - available languages
- Get morphological analyzer - specific language
- Search thesaurus list
- Search thesaurus version
- Delete thesaurus
- Thesaurus settings
- Edit thesaurus
- Search thesaurus name
- Synonym dictionary view
- Confirm duplicate thesaurus
- Change usage limits
- Get usage limits
- Cloud Search metrics
- Search Engine Service (VPC)
- Overview of the Search Engine Service
- Cluster
- Create search engine cluster
- Get Search Engine version
- Search OS product
- Search node product
- Search VPC list
- Search subnet list
- Delete Search Engine Cluster
- Add Search Engine Cluster node
- Restart Search Engine Cluster
- Reset Search Engine User password
- Get Elasticsearch Cluster list
- Get Search Engine Cluster Data node
- Get Search Engine Cluster ACG
- Search the specifications of each Search Engine Cluster node group
- Search the specifications that can be changed for each Search Engine Cluster node group
- Change the node specifications of the Search Engine Cluster
- Change search engine cluster node type
- Search authentication key list
- Rolling Upgrade Pre Check
- Rolling Upgrade Cluster
- View Rolling Upgrade progress status
- Dashboard
- Monitoring
- Snapshot
- Import
- Search Engine Service metrics
- Cloud Data Streaming Service(VPC)
- Overview of the Cloud data streaming service
- Cluster
- View Cluster Rolling restart progress status
- Cluster Rolling restart requests
- Cluster Rolling restart precheck
- View Rolling Upgrade progress status
- Rolling UpGrade requests
- Rolling Upgrade precheck
- Creating a cloud data streaming service cluster
- Creating a Cloud Data Streaming Service Cluster (Return ID)
- Search Cloud Data Streaming Service Version
- Get OS product
- Search node product
- Search VPC list
- Search subnet list
- Delete Cloud Data Streaming Service Cluster
- Add Cloud Data Streaming Service Cluster node
- Restart all services
- Restart CMAK
- Restart Kafka
- Restart Kafka by node
- Reset CMAK connection password
- Search Cloud Data Streaming Service Cluster list
- Search single Cloud Data Streaming Service cluster
- Search Cloud Data Streaming Service Cluster node
- Cloud Data Streaming Service Cluster Get an ACG
- Check cluster status
- Check broker node information
- Download certificate
- Enable public domain
- Disable public domain
- View a list of load balancers
- Enable the broker node's public endpoint
- Disable the broker node's public endpoint
- Search the specifications by node group
- Search the specifications that can be changed for each node group
- Change Node specifications
- Monitoring
- ConfigGroup
- Create config group
- Delete Config Group
- View Config Group information
- Modify Config Group description
- View list of ConfigGroup for each Kafka version
- Get list of clusters using config group
- View list of Config Group Kafka properties
- Save Config Group Kafka properties settings
- Apply Config Group to cluster
- Cloud Data Streaming Service metrics
- Data Forest
- Data Forest Overview
- Accounts
- Notebooks
- getVpcList
- getVpcDetail
- getSubnetList
- getSubnetDetail
- getTypeList
- getServerTypeList
- getList
- getDetail
- getUserConfigurationSpecList
- checkAvailableName
- getLoginKeyList
- getObjectStorageBucketDetail
- getObjectStorageBucketList
- getAcgRuleList
- restart
- delete
- create
- setUserConfigurationList
- setObjectStorageBucket
- Apps
- AI workspaces
- AI Apps
- Data Box Frame
- Data Box Frame overview
- Data Box Frame Code
- get-data-box-frame-list
- get-data-box-frame-detail
- get-data-box-frame-infra-list
- get-data-box-list
- get-data-box-summary-info
- get-data-box-infra-list
- get-hadoop-cluster-info
- get-linux-info
- get-tensor-flow-info
- get-bucket-list
- get-import-apply-list
- get-import-apply-detail
- get-target-nas-list
- get-export-apply-list
- get-export-apply-detail
- get-ssl-vpn-account-list
- get-source-nas-list
- get-export-file-approve-list
- get-export-file-approve-detail
- return-data-box-frame
- change-data-box-frame-nas-volume-size
- return-data-box
- change-data-box-nas-volume-size
- set-block-external-network
- apply-file-import
- apply-file-export
- return-file-export-apply
- export-file-approve
- export-file-reject
- modify-data-box-frame-admin-infra
- modify-data-box
- create-data-box
- Data Catalog
- Data Flow
- Data Query
- Cloud Data Box
- Cloud Hadoop (VPC)
- Blockchain
- Blockchain Service
- Blockchain Service overview
- Get network list
- Get network information
- Get organization list
- Get organization information
- Download organization connection information
- Get orderer list
- Get orderer information
- Download orderer connection information
- Get orderer pod log
- Get orderer pod usage
- Get peer list
- Get peer information
- Get peer pod log
- Get peer pod usage
- Get CA list
- Get CA information
- Get CA identity
- Download CA identity
- Get CA pod log
- Get CA pod usage
- Blockchain Service
- Business Applications
- Content Delivery
- Developer Tools
- SourceCommit
- SourceBuild
- SourceBuild Overview
- Project List
- View project details
- Create Project
- Change Project Settings
- Delete Project
- Start Build
- Cancel build
- build history
- Operating System List
- compute type list
- runtime type list
- runtime version list
- Docker Engine List
- SourceCommit Repository Lookup
- SourceCommit Branch Lookup
- Object Storage Bucket List
- Container Registry List
- SourceDeploy
- SourceDeploy Overview
- Project List
- Create Project
- Delete Project
- Stage List
- Stage Detail
- Stage Create
- Stage Update
- Stage Delete
- Scenario List
- Scenario details
- Create scenario
- Edit scenario
- Delete Scenario
- Start Deployment
- Cancel Deployment
- Request Deployment Approval
- Approve Deployment
- Deployment Rejection
- Approve Canary Deployment
- Canary Deployment Rejection
- Deployment History List
- Deployment History Details
- Querying the Canary
- Canary Analysis Report
- Server list
- AutoScalingGroup List Lookup
- KubernetesService Cluster List
- targetGroup list(VPC)
- SourceCommit Repository list
- SourceCommit Branch list
- SourceBuild list
- ObjectStorage Bucket List
- ObjectStorage Object List
- SourcePipeline
- SourcePipeline Overview
- Project List
- Project details
- Project creation
- Edit project
- Delete Project
- Run Pipeline
- Pipeline cancel
- Execution History List
- Running history details
- SourceCommit repository list
- SourceCommit branch list
- SourceBuild project list
- SourceDeploy project list
- SourceDeploy stage list
- SourceDeploy scenario list
- List of scheduled trigger time zones
- Digital Twin
- Gaming
- GAMEPOT
- GAMEPOT overview
- User Lookup
- Searching blocked user
- User stop settings
- Daily access (DAU) inquiry
- New User (NRU) Lookup
- Simultaneous access (CCU) inquiry
- Payment inquiry
- Payment cancellation inquiry
- Billing Sales Statistics Inquiry
- Character inquiry
- General coupon usage inquiry
- Using coupon
- Post notice
- Leaderboard
- Manage friend
- Advance reservation participation
- Advance reservation verification code sending
- Advance reservation verification code check
- Identity authentication result query
- Game Chat
- GAMEPOT
- Hybrid & Private Cloud
- Management & Governance
- Cloud Log Analytics
- Sub Account
- Sub Account overview
- Subaccounts
- Get sub account list
- Get sub account
- Create sub account
- Edit sub account
- Delete sub account
- Get access key
- Create access key
- Delete access key
- Set access key status
- Get login access key
- Set login access key
- Check login ID
- Check login password
- Get idle session expiration time
- Set idle session expiration time
- Get login password expiration date
- Set login password expiration date
- Reset login password
- Assign policy
- Delete policy
- Add group
- Delete group
- Get console access rule
- Edit console access rule
- Get API access rule
- Edit sub account API access rule
- Get two-factor authentication information
- Get tag
- Add tag
- Delete tag
- Get user ID
- Get user information
- Groups
- Policies
- Roles
- Get role list
- Get role
- Create role
- Edit role
- Delete role
- Assign policy
- Delete policy
- Get role (Account) application target
- Add role (Account) application target
- Delete role (Account) application target
- Add role (Server, Service) application target
- Delete role (Server, Service) application target
- Set role list status
- Set role status
- Get tag
- Add tag
- Remove tag
- Get switchable role
- Register switchable role
- Edit switchable role
- Delete switchable role
- External access
- Get trust anchor list
- Get trust anchor
- Create trust anchor
- Edit trust anchor
- Enable trust anchor
- Disable trust anchor
- Delete trust anchor
- Get profile list
- Get profile
- Create profile
- Edit profile
- Enable profile
- Disable profile
- Delete profile
- Get subject list
- Get subject
- Get subject activity list
- Get CRL list
- Get CRL
- Create CRL
- Edit CRL
- Enable CRL
- Disable CRL
- Delete CRL
- Secure Token Service
- Web service Monitoring System
- Effective Log Search & Analytics
- Network Traffic Monitoring
- Cloud Activity Tracer
- Resource Manager
- Cloud Insight
- Cloud Insight overview
- Dashboard
- Event
- Event Rule
- CopyRuleGroup
- CreateMetricsGrp
- CreateMonitorGrp
- CreateRuleDirectly
- CreateRuleGroup
- DeleteMetricGroupForce
- DeleteMetricsGrp
- DeleteMetricsGrpByProdKeyAndId
- DeleteMonitorGroupForce
- DeleteMonitorGrp
- DeleteRuleGroup
- DeleteRuleGroupByProdKeyAndId
- GetAllMonitorGrp
- GetMetricsGroup
- GetMetricsGroupList
- GetMonitorGrp
- GetNotificationRecipientList
- GetRuleGroup
- GetRuleGroupByMetricGroupIds
- GetRuleGroupByMonitorGroupIds
- GetRuleGroupList
- RemoveResourceFromRules
- SearchMetricList
- UpdateMetricsGroup
- UpdateMonitorGrp
- UpdateRuleGroup
- Schema
- Custom Resource
- Planned Maintenance
- Plugin
- Server
- Data
- Integration
- Cloud Insight metrics
- Ncloud Single Sign-On
- Ncloud Single Sign-On overview
- Application
- Tenant
- External IdP
- Viewing external IDP
- Registering external IDP
- Editing external IDP
- Deleting external IDP
- Viewing attribute mapper
- Editing attribute mapper
- External IDP metadata parsing
- Viewing metadata of Ncloud Single Sign-On
- Viewing URL data of Ncloud Single Sign-On
- Set login with external IDP
- Connecting Organization
- SSO User
- Viewing user list
- Viewing single user
- Creating user
- Creating users in batch
- Editing user
- Deleting user list
- Deleting user
- User login ID validation
- Viewing User Access Rules
- Editing User Access Rules
- Viewing user profile
- Viewing list of groups including user
- Viewing single group including user
- Adding user to group
- Deleting user from group
- Changing user status
- Viewing user session
- Expire user session
- Viewing list of assignments to which user belongs
- Deleting user from assignment
- View MFA device owned by user
- Add MFA device to user
- Delete MFA device from user
- Group
- Permission Set
- Viewing Permission Set list
- View single permission set
- Creating Permission Set
- Editing Permission Set
- Deleting multiple Permission Sets
- Delete permission set
- Validating Permission Set name
- Deleting policies in Permission Set
- Viewing list of policies in Permission Set
- Checking whether Permission Set has policy
- Assignment
- Viewing assignment list
- Viewing single assignment
- Creating assignment
- Edit assignment
- Deleting assignment
- Assignment status change
- View assignment target
- Add Assignment Target
- Deleting assignment target
- Viewing list of IP ACLs in assignment
- Adding IP ACL to assignment
- Deleting IP ACL in assignment
- Viewing account list
- Checking whether account has user-defined policy
- IP ACL
- Cloud Advisor (VPC)
- Cloud Advisor overview
- Search for check categories
- Search for checklist status
- Search for checklist
- Search for a summary of the results
- Request for check
- Search for a summary of check results
- Search for details of check results
- Check results detailed inclusion settings
- Check results detailed exclusion settings
- Download check results
- Organization
- Media
- Live Station
- Live Station overview
- Channel Management
- Quality Profile
- Quality Setting
- Recording
- Re-Stream Management
- VOD to Live Management
- Event
- Live Station error codes
- VOD Station
- Video Player Enhancement
- One Click Multi DRM
- B2B Prism Live Studio
- Media Connect Center
- Live Station
- Migration
Cloud Search provides API through API Gateway of NAVER Cloud Platform.
Access Key and Secret Key are required for API authentication,
see API Gateway User Guide - Making API Calls for API key creation and usage instructions.
See Common Guide - API Overview regarding Access Key and Secret Key.
Cloud Search provides various APIs, and you can check the API specifications and perform simple tests through the Swagger page. Cloud Search's Swagger documentation can be accessed through the following steps.
- Console access
- Select Services > API Gateway service
- Select Published APIs > CloudSearch > Catalog
- After selecting CloudSearch, select API Documentation at the bottom.
The screen that appears at this time is Cloud Search's Swagger page, and the link displayed at the top of the page ashttps://cloudsearch.apigw.ntruss.com/CloudSearch/real
is the API address of Cloud Search.
Common settings
Cloud Search API URL
https://cloudsearch.apigw.ntruss.com/CloudSearch/real
Request header
Header name | Description |
---|---|
x-ncp-apigw-timestamp | It indicates the time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds and the request is considered invalid if the time difference from the API Gateway server is greater than 5 minutesx-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | Access Key ID value issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Specify Request body content type as application/jsonContent-Type: application/json |
Search service creation example
In this example, we can explain how to use the API by creating a search portal service that provides information on various car models from around the world.
Before creating a domain, let's define the search settings (Schema) that can be configured when creating the domain.
Search settings creation
Let's assume that each car model has the following information. In the search engine, a bundle of information that represents the subject of a search is referred to as a Document.
Thus, the bundle of information below becomes one document:
- docid: the item that becomes the key for individual documents
- brand: car brand
- name: car name
- price: price
- type: car model
Section
In Cloud Search, each item here is referred to as a section. And among them, the section that can identify this document,
in other words, the section that becomes the key, is called the main section. For example, the following JSON file is one document, and the key for this document is "car-10001".
{
"docid": "car-10001",
"brand": "Hyundai",
"name": "2018 Santa Fe",
"price": "2815",
"type": "Mid-size"
}
To insert a document like this, you need to add "docid, brand, name, price, and type" as sections.
You can omit the data type of the section if strings are regular. However, if it's not, you must specify one of the following data types: float, uint8, uint16, uint32, uint64, int8, int16, int32, int64, string, mstring, muint8, and muint32.
You can give various attributes to each section, and if you assign the name dp_price to the section named price, you can utilize it for additional search features in Document search.
{
"docProperties":[
{
"type":"uint32",
"name":"dp_price"
}
],
"name":"price"
}
Index
When searching for cars, there are cases where you search only by brand name and cases where you search by brand name, car name, and car type together. When you want to search with different sections that serve as the target for searching or with different search characteristics depending on the purpose, you need to create indexes for each purpose. If you don't want to make a special distinction, you can create an index by including all sections.
The example below creates an index called brand_name for the brand and name sections.
You can configure various language morphological analyzers when creating an index. In this example, a Korean morphological analyzer is specified for the brand_name index. The support for morphological analysis in other languages can be checked through Morphological analysis option inquiry - list of supported languages.
When you define sections and indexes as shown below in the search settings, i.e., Schema, you can send it to the Schema validation request to check its validity.
{
"document":{
"primarySectionName":"docid",
"sections":[
{
"name":"docid"
},
{
"name":"brand"
},
{
"name":"name"
},
{
"docProperties":[
{
"type":"uint32",
"name":"dp_price"
}
],
"name":"price"
},
{
"docProperties":[
{
"type":"string",
"name":"dp_type"
}
],
"name":"type"
}
],
"indexes":[
{
"documentTermWeight":"sum_wgt",
"buildInfos":[
{
"indexProcessors":[
{
"type":"hanaterm",
"method":"sgmt",
"option":"+korea +josacat +eomicat"
}
],
"sectionTermWeight":"1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
"sections":[
"brand",
"name"
],
"name":"index_build"
}
],
"name":"brand_name"
}
]
}
}
If you do not receive a response like "valid" as shown below, you need to modify the Schema.
{
"status": "valid",
"message": "OK",
"response": "{\"status\":{\"code\":0,\"message\":\"ok\"}}\n"
}
If you received a response like "valid" in the above request, you need to configure the search settings you created when making the create Domain request.
Create domain
Since we are still in the process of developing the portal service, let's create a domain named "car_dev". Cloud Search users
can easily manage development, testing, and production environments by creating domains named "car_stage" and "car_production" when setting up stage and production environments in the future. In Cloud Search, the concept of domain is used to distinguish environments in this way.
Referring to the search settings used above and Create domain API, if you define parameters in JSON file as shown in the example below and make a POST request to /v1/domain, a domain named "car_dev" is created.
{
"name": "car_dev",
"type": "small",
"indexerCount": 1,
"searcherCount": 1,
"description": "search engine for cars",
"schema":{
"document":{
"primarySectionName":"docid",
"sections":[
{
"name":"docid"
},
{
"name":"brand"
},
{
"name":"name"
},
{
"docProperties":[
{
"type":"uint32",
"name":"dp_price"
}
],
"name":"price"
},
{
"docProperties":[
{
"type":"string",
"name":"dp_type"
}
],
"name":"type"
}
],
"indexes":[
{
"documentTermWeight":"sum_wgt",
"buildInfos":[
{
"indexProcessors":[
{
"type":"hanaterm",
"method":"sgmt",
"option":"+english +revert +korea +josacat +eomicat"
}
],
"sectionTermWeight":"1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
"sections":[
"brand",
"name"
],
"name":"index_build"
}
],
"name":"brand_name"
}
]
}
}
}
View domain
To confirm that the domain has been created, you can make View domain API call and receive a response like the one below.
If there are already other domains created, you can receive responses for multiple domains.
{
"name": "car_dev",
"description": "search engine for cars",
"domainStatus": "RUNNING",
"containerChangeable": "ENABLE",
"schemaChangeable": "ENABLE",
"autoCompleteChangeable": "ENABLE",
"type": "small",
"indexerCount": 1,
"searcherCount": 1,
"schema": {
"document": {
"primarySectionName": "docid",
"sections": [
{
"name": "docid"
},
{
"name": "brand"
},
{
"name": "name"
},
{
"docProperties": [
{
"type": "uint32",
"name": "dp_price"
}
],
"name": "price"
},
{
"docProperties": [
{
"type": "string",
"name": "dp_type"
}
],
"name": "type"
}
],
"indexes": [
{
"documentTermWeight": "sum_wgt",
"buildInfos": [
{
"indexProcessors": [
{
"type": "hanaterm",
"method": "sgmt",
"option": "+english +revert +korea +josacat +eomicat"
}
],
"sectionTermWeight": "1.0 * stw_2p(tf, 0.5, 0.25, 0., length / 128.0)",
"sections": [
"brand",
"name"
],
"name": "index_build"
}
],
"name": "brand_name"
}
]
}
},
"autocompleteSchema": null,
"createdDate": "2019-03-05T08:15:11.587Z",
"updatedDate": "2019-03-05T08:15:18.000Z"
}
Upload document
Add documents to the newly created domain "car_dev". See download example file.
Able to insert, update, upsert, or delete documents as needed, and for detailed usage, see Document management.
Able to add multiple documents in one request, and you can also combine insert, update, upsert, and delete requests to send multiple requests at once.
Able to send requests to Document management to insert, update, upsert, or delete documents.
Next, request to add 3 documents.
Since it is for adding to the "car_dev" domain, you can make a call to /v1/domain/car_dev/document/manage.
{
"requests": [
{
"type": "insert",
"key": "car-10001",
"content": {
"docid": "car-10001",
"brand": "Hyundai",
"name": "2018 Santa Fe",
"price": "2815",
"type": "Mid-size"
}
},
{
"type": "insert",
"key": "car-10002",
"content": {
"docid": "car-10002",
"brand": "Hyundai",
"name": "2018 Grandeur",
"price": "2615",
"type": "Mid-size"
}
},
{
"type": "insert",
"key": "car-3",
"content": {
"docid": "car-3",
"brand": "Chevrolet",
"name": "2018 Malibu",
"price": "2388",
"type": "Mid-size"
}
}
]
}
Search
Now, you can search documents added to car_dev. For detailed information on search API, see Document Search.
Perform a simple brand name search. Create the request as shown below and then make a POST call to /v1/domain/car_dev/document/search.
{
"search": {
"brand_name": {
"main": {
"query": "Hyundai"
}
}
}
}
Results like the ones shown below can be obtained:
{
"type": "response",
"version": "1.1.3",
"status": 200,
"time_zone": "+09:00",
"elapsed_time": 0.000787,
"term": {
"brand_name": {
"main": {
"term_count": 1,
"term_list": [
"Hyundai"
]
}
}
},
"result": {
"start": 1,
"display": 20,
"ranking": "clous",
"sort_by": "qds",
"total_count": 2,
"removed_count": 0,
"item_count": 2,
"items": [
{
"_rank": 1,
"_key": "car-10001",
"_qds": 0.8729686141014099,
"brand": "<b>Hyundai</b>",
"docid": "car-10001",
"name": "2018 Santa Fe",
"price": 2815,
"type": "Mid-size"
},
{
"_rank": 2,
"_key": "car-10002",
"_qds": 0.8729686141014099,
"brand": "<b>Hyundai</b>",
"docid": "car-10002",
"name": "2018 Grandeur",
"price": 2615,
"type": "Mid-size"
}
]
}
}
In addition, auto complete settings and stop word policy settings are supported. For detailed information, see the respective page.