Microsoft SQL Server(DBaaS)

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 Microsoft SQL Server(DBaaS) 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.

OpenAPI URL

https://sqlserver.{region}.{environment}.samsungsdscloud.com

Environment and Region List

API Version History

1.1

API version 1.1 release for Microsoft SQL Server(DBaaS)

Changes

• [New] POST /sqlserver/v1.1/clusters/<dr_secondary_cluster_id>/dr-secondaries - CreateDrSecondary API has been added.
• [New] POST /sqlserver/v1.1/clusters/<dr_secondary_cluster_id>/dr-secondaries/sync-state - SyncDrSecondaryState API has been added.
• [New] GET /sqlserver/v1.1/clusters/{cluster_id}/dr-secondaries - ListDrSecondaries API has been added.
• [New] POST /sqlserver/v1.1/clusters/<dr_secondary_cluster_id>/dr-secondaries/promote - PromoteDrSecondary API has been added.
• [New] POST /sqlserver/1.1/clusters/{cluster_id}/backups/manual - CreateManualBackup API has been added.
• [New] GET /sqlserver/1.1/clusters/{cluster_id}/instances/{instance_name} - ShowInstance API has been added.
• [Changed] POST /sqlserver/v1.1/clusters/{cluster_id}/add-secondary - AddSecondary API has been changed.
  • The following fields are added to the request:
    • ad_user_id
    • ad_user_password
• [Changed] POST /sqlserver/1.1/clusters - CreateCluster API has been changed.
  • The following fields are added to the request:
    • service_watch_log_collection
    • ad_enabled
    • ad_config
• [Changed] GET /sqlserver/1.1/clusters/{cluster_id} - ShowCluster API has been changed.
  • The following fields are added to the response:
    • service_watch_log_collection
    • ad_enabled
    • ad_config

1.0

Initial API release for Microsoft SQL Server(DBaaS)

Changes

• [New] POST /sqlserver/1.0/block-storage-groups/{block_storage_group_id}/resize - SetBlockStorageSize 1.0 API has been added.
• [New] GET /sqlserver/1.0/clusters - ListClusters 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters - CreateCluster 1.0 API has been added.
• [New] DELETE /sqlserver/1.0/clusters/{cluster_id} - DeleteCluster 1.0 API has been added.
• [New] GET /sqlserver/1.0/clusters/{cluster_id} - ShowCluster 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/add-secondary - AddSecondary 1.0 API has been added.
• [New] PUT /sqlserver/1.0/clusters/{cluster_id}/audit-log - SetAuditLog 1.0 API has been added.
• [New] GET /sqlserver/1.0/clusters/{cluster_id}/backup-histories - ListBackupHistories 1.0 API has been added.
• [New] PUT /sqlserver/1.0/clusters/{cluster_id}/backup-histories - RemoveBackupHistories 1.0 API has been added.
• [New] DELETE /sqlserver/1.0/clusters/{cluster_id}/backups - UnsetBackup 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/backups - SetBackup 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/databases - SetDatabases 1.0 API has been added.
• [New] GET /sqlserver/1.0/clusters/{cluster_id}/log-export-configs - ListLogExportConfigs 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/log-export-configs - RegisterLogExportConfig 1.0 API has been added.
• [New] DELETE /sqlserver/1.0/clusters/{cluster_id}/log-export-configs/{log_type} - UnregisterLogExportConfig 1.0 API has been added.
• [New] PUT /sqlserver/1.0/clusters/{cluster_id}/log-export-configs/{log_type} - SetLogExportConfig 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/log-export-configs/{log_type}/export - ExportLog 1.0 API has been added.
• [New] DELETE /sqlserver/1.0/clusters/{cluster_id}/maintenance - UnsetMaintenance 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/maintenance - SetMaintenance 1.0 API has been added.
• [New] GET /sqlserver/1.0/clusters/{cluster_id}/parameters - ListParameterValues 1.0 API has been added.
• [New] PUT /sqlserver/1.0/clusters/{cluster_id}/parameters - SetParameterValues 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/parameters/sync - SyncParameterValues 1.0 API has been added.
• [New] PUT /sqlserver/1.0/clusters/{cluster_id}/patch - PatchMinorVersion 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/restart - RestartCluster 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/restore - CreateRestore 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/security-group-rules - SetSecurityGroupRules 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/start - StartCluster 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/stop - StopCluster 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/switchover - SwitchoverCluster 1.0 API has been added.
• [New] POST /sqlserver/1.0/clusters/{cluster_id}/sync-state - SyncClusterState 1.0 API has been added.
• [New] GET /sqlserver/1.0/engine-versions - ListEngineVersions 1.0 API has been added.
• [New] GET /sqlserver/1.0/engine-versions/{dbaas_engine_version_id}/properties - ListEngineVersionProperties 1.0 API has been added.
• [New] POST /sqlserver/1.0/instance-groups/{instance_group_id}/block-storage-groups - AddBlockStorages 1.0 API has been added.
• [New] POST /sqlserver/1.0/instance-groups/{instance_group_id}/resize - SetServerType 1.0 API has been added.
• [New] GET /sqlserver/1.0/parameter-groups - ListParameterGroups 1.0 API has been added.
• [New] GET /sqlserver/1.0/parameters - ListParameters 1.0 API has been added.
• [New] GET /sqlserver/1.0/requests/{request_id} - ShowRequest 1.0 API has been added.
• [New] GET /sqlserver/1.0/server-types - ListServerTypes 1.0 API has been added.