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.

Version	Status	Not Before
1.1	CURRENT	-
1.0	SUPPORTED	20261031

OpenAPI URL

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

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

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.

1 - APIs

1.1 - Add Block Storages

1.1.1 - 1.1

post /v1/instance-groups/{instance_group_id}/block-storage-groups

Description

Add Block Storages.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		SqlserverAddBlockStoragesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/block-storage-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 = sqlserver 1.1"

Request body

{
    "role_type": "OS",
    "size_gb": 104,
    "volume_type": "SSD"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.1.2 - 1.0

post /v1/instance-groups/{instance_group_id}/block-storage-groups

Description

Add Block Storages.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		SqlserverAddBlockStoragesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/block-storage-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 = sqlserver 1.0"

Request body

{
    "role_type": "OS",
    "size_gb": 104,
    "volume_type": "SSD"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.2 - Add DR Secondary

1.2.1 - 1.1

post /v1/clusters/{cluster_id}/dr-secondaries

Description

Add DR Secondary.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
body	body required		SqlserverDrSecondaryCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/dr-secondaries

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "ad_user_id": "aduser123",
    "ad_user_password": "test123!",
    "license": "",
    "name": "",
    "region": "",
    "service_ip_address": "",
    "subnet_id": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.3 - Add Secondary

1.3.1 - 1.1

post /v1/clusters/{cluster_id}/add-secondary

Description

Add Secondary.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverAddSecondaryRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/add-secondary

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "ad_user_id": "",
    "ad_user_password": "test123!",
    "license": "",
    "name": "",
    "service_ip_address": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.3.2 - 1.0

post /v1/clusters/{cluster_id}/add-secondary

Description

Add Secondary.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverAddSecondaryRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/add-secondary

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "ad_user_id": "",
    "ad_user_password": "test123!",
    "license": "",
    "name": "",
    "service_ip_address": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.4 - Add/Remove Databases

1.4.1 - 1.1

post /v1/clusters/{cluster_id}/databases

Description

Add/Remove Databases.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverUpdateDatabasesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/databases

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "add_databases": [],
    "del_databases": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.4.2 - 1.0

post /v1/clusters/{cluster_id}/databases

Description

Add/Remove Databases.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverUpdateDatabasesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/databases

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "add_databases": [],
    "del_databases": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.5 - Create Cluster

1.5.1 - 1.1

post /v1/clusters

Description

Create Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SqlserverClusterCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "allowable_ip_addresses": [],
    "dbaas_engine_version_id": "c1b856dd12754c0ba2614a39d0ed3ad1",
    "ha_enabled": false,
    "init_config_option": {
        "ad_config": {
            "ad_dns_servers": [
                ""
            ],
            "ad_domain_name": "",
            "ad_netbios_name": "",
            "ad_user_id": "",
            "ad_user_password": "test123!",
            "failover_cluster_name": ""
        },
        "ad_enabled": false,
        "audit_enabled": false,
        "backup_option": {
            "archive_frequency_minute": "",
            "full_backup_day_of_week": "SUN",
            "retention_period_day": "7",
            "starting_time_hour": "2"
        },
        "database_collation": "SQL_Latin1_General_CP1_CI_AS",
        "database_name": "",
        "database_port": 2866,
        "database_service_name": "Sqldbadmin",
        "database_user_name": "mydatabaseusr",
        "database_user_password": "test123!",
        "databases": [
            {
                "database_name": "",
                "drive_letter": "E"
            }
        ],
        "license": "AAAAA-AAAAA-AAAAA-AAAAA"
    },
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "role_type": "OS",
                    "size_gb": 104,
                    "volume_type": "SSD"
                },
                {
                    "role_type": "DATA",
                    "size_gb": 56,
                    "volume_type": "SSD"
                }
            ],
            "instances": [
                {
                    "public_ip_id": "",
                    "role_type": "ACTIVE",
                    "service_ip_address": "192.168.10.10/32"
                }
            ],
            "role_type": "ACTIVE",
            "server_type_name": "db1v2m4"
        }
    ],
    "instance_name_prefix": "",
    "maintenance_option": {
        "period_hour": "5",
        "starting_day_of_week": "MON",
        "starting_time": "0000"
    },
    "name": "mycluster",
    "nat_enabled": false,
    "service_watch_log_collection": true,
    "subnet_id": "1ddd7f1e4a8a43ed8b82d70cade0b321",
    "tags": [],
    "timezone": "Asia/Seoul",
    "vip_public_ip_id": "",
    "virtual_ip_address": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.5.2 - 1.0

post /v1/clusters

Description

Create Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
body	body required		SqlserverClusterCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "dbaas_engine_version_id": "c1b856dd12754c0ba2614a39d0ed3ad1",
    "ha_enabled": false,
    "init_config_option": {
        "ad_config": {
            "ad_dns_servers": [
                ""
            ],
            "ad_domain_name": "",
            "ad_netbios_name": "",
            "ad_user_id": "",
            "ad_user_password": "test123!",
            "failover_cluster_name": ""
        },
        "ad_enabled": false,
        "audit_enabled": false,
        "backup_option": {
            "archive_frequency_minute": "",
            "full_backup_day_of_week": "SUN",
            "retention_period_day": "7",
            "starting_time_hour": "2"
        },
        "database_collation": "SQL_Latin1_General_CP1_CI_AS",
        "database_name": "",
        "database_port": 2866,
        "database_service_name": "Sqldbadmin",
        "database_user_name": "mydatabaseusr",
        "database_user_password": "test123!",
        "databases": [
            {
                "database_name": "",
                "drive_letter": "E"
            }
        ],
        "license": "AAAAA-AAAAA-AAAAA-AAAAA"
    },
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "role_type": "OS",
                    "size_gb": 104,
                    "volume_type": "SSD"
                },
                {
                    "role_type": "DATA",
                    "size_gb": 56,
                    "volume_type": "SSD"
                }
            ],
            "instances": [
                {
                    "public_ip_id": "",
                    "role_type": "ACTIVE",
                    "service_ip_address": "192.168.10.10/32"
                }
            ],
            "role_type": "ACTIVE",
            "server_type_name": "db1v2m4"
        }
    ],
    "instance_name_prefix": "",
    "maintenance_option": {
        "period_hour": "5",
        "starting_day_of_week": "MON",
        "starting_time": "0000"
    },
    "name": "mycluster",
    "nat_enabled": false,
    "subnet_id": "1ddd7f1e4a8a43ed8b82d70cade0b321",
    "tags": [],
    "timezone": "Asia/Seoul",
    "vip_public_ip_id": "",
    "virtual_ip_address": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.6 - Create Restore Cluster

1.6.1 - 1.1

post /v1/clusters/{cluster_id}/restore

Description

Create Restore Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		ClusterRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "allowable_ip_addresses": [],
    "backup_history_number": "202501010000",
    "backup_recovery_time": "",
    "block_storage_groups": [],
    "instance_name_prefix": "myprefix",
    "maintenance_option": {
        "period_hour": "5",
        "starting_day_of_week": "MON",
        "starting_time": "0000"
    },
    "name": "mycluster",
    "server_type_name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.6.2 - 1.0

post /v1/clusters/{cluster_id}/restore

Description

Create Restore Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		ClusterRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "allowable_ip_addresses": [],
    "backup_history_number": "202501010000",
    "backup_recovery_time": "",
    "block_storage_groups": [],
    "instance_name_prefix": "myprefix",
    "maintenance_option": {
        "period_hour": "5",
        "starting_day_of_week": "MON",
        "starting_time": "0000"
    },
    "name": "mycluster",
    "server_type_name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.7 - Export Log

1.7.1 - 1.1

post /v1/clusters/{cluster_id}/log-export-configs/{log_type}/export

Description

Export Log.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}/export

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.7.2 - 1.0

post /v1/clusters/{cluster_id}/log-export-configs/{log_type}/export

Description

Export Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}/export

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.8 - List Backup Histories

1.8.1 - 1.1

get /v1/clusters/{cluster_id}/backup-histories

Description

List Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
query	limit optional	Number of backup lists Example :	any of [integer, null]	None
query	page optional	Backup list page Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListApiResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_at": "",
            "backup_history_number": "",
            "backup_size_gb": "",
            "backup_start_at": "",
            "backup_state": "",
            "backup_state_detail": "",
            "software_version": ""
        }
    ],
    "total_count": ""
}

1.8.2 - 1.0

get /v1/clusters/{cluster_id}/backup-histories

Description

List Backup Histories.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
query	limit optional	Number of backup lists Example :	any of [integer, null]	None
query	page optional	Backup list page Example :	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListApiResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_at": "",
            "backup_history_number": "",
            "backup_size_gb": "",
            "backup_start_at": "",
            "backup_state": "",
            "backup_state_detail": "",
            "software_version": ""
        }
    ],
    "total_count": ""
}

1.9 - List Clusters

1.9.1 - 1.1

get /v1/clusters

Description

List Clusters.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	name optional	Cluster name Example :	any of [string, null]	None
query	service_state optional	Service state Example :	any of [string, null]	None
query	database_name optional	Database Name Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RdbClusterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "database_name": "",
            "ha_enabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "instance_count": 0,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "role_type": "ORIGIN",
            "service_state": "RUNNING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.9.2 - 1.0

get /v1/clusters

Description

List Clusters.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	name optional	Cluster name Example :	any of [string, null]	None
query	service_state optional	Service state Example :	any of [string, null]	None
query	database_name optional	Database Name Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RdbClusterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "database_name": "",
            "ha_enabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "instance_count": 0,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "role_type": "ORIGIN",
            "service_state": "RUNNING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.10 - List DR Secondaries

1.10.1 - 1.1

get /v1/clusters/{cluster_id}/dr-secondaries

Description

List DR Secondaries.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SqlserverDrSecondariesListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/dr-secondaries

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "check_time": "",
            "name": "",
            "region_nm": "",
            "state": "",
            "state_detail": ""
        }
    ],
    "count": ""
}

1.11 - List Engine Version Properties

1.11.1 - 1.1

get /v1/engine-versions/{dbaas_engine_version_id}/properties

Description

List Engine Version Properties.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EnginePropertyListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions/{dbaas_engine_version_id}/properties

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "name": "",
            "value": ""
        }
    ]
}

1.11.2 - 1.0

get /v1/engine-versions/{dbaas_engine_version_id}/properties

Description

List Engine Version Properties.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	EnginePropertyListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions/{dbaas_engine_version_id}/properties

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "name": "",
            "value": ""
        }
    ]
}

1.12 - List Engine Versions

1.12.1 - 1.1

get /v1/engine-versions

Description

List Engine Versions.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	id optional	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [enum (PostgreSQL Community, MariaDB Community, MySQL Community, EPAS, Microsoft SQL Server Enterprise, Microsoft SQL Server Standard, Redis OSS Sentinel, Valkey Sentinel, Kafka, Elasticsearch Enterprise, OpenSearch, Vertica Enterprise, Vertica Community, Scalable DB MariaDB Community), null]	None
query	eos_included optional	EoS included Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	EngineListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "end_of_service": false,
            "id": "",
            "major_version": "",
            "name": "",
            "os_type": "",
            "os_version": "",
            "product_image_type": "",
            "software_version": ""
        }
    ]
}

1.12.2 - 1.0

get /v1/engine-versions

Description

List Engine Versions.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
query	id optional	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [enum (PostgreSQL Community, MariaDB Community, MySQL Community, EPAS, Microsoft SQL Server Enterprise, Microsoft SQL Server Standard, Redis OSS Sentinel, Valkey Sentinel, Kafka, Elasticsearch Enterprise, OpenSearch, Vertica Enterprise, Vertica Community, Scalable DB MariaDB Community), null]	None
query	eos_included optional	EoS included Example : `False`	boolean	False

Responses

HTTP Code	Description	Schema
200	OK	EngineListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/engine-versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "end_of_service": false,
            "id": "",
            "major_version": "",
            "name": "",
            "os_type": "",
            "os_version": "",
            "product_image_type": "",
            "software_version": ""
        }
    ]
}

1.13 - List Log Export Configs

1.13.1 - 1.1

get /v1/clusters/{cluster_id}/log-export-configs

Description

List Log Export Configs.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
query	type optional	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LogExportConfigListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "bucket_name": "examplebucket",
            "delete_on_export": true,
            "is_bucket_deleted": false,
            "is_registered": true,
            "log_label": "DB Alert Log",
            "log_type": "alert",
            "schedule_day_of_month": "28",
            "schedule_day_of_week": "MON",
            "schedule_frequency_type": "DAY",
            "schedule_hour": "12"
        }
    ],
    "count": 1
}

1.13.2 - 1.0

get /v1/clusters/{cluster_id}/log-export-configs

Description

List Log Export Configs.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
query	type optional	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
200	OK	LogExportConfigListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "bucket_name": "examplebucket",
            "delete_on_export": true,
            "is_bucket_deleted": false,
            "is_registered": true,
            "log_label": "DB Alert Log",
            "log_type": "alert",
            "schedule_day_of_month": "28",
            "schedule_day_of_week": "MON",
            "schedule_frequency_type": "DAY",
            "schedule_hour": "12"
        }
    ],
    "count": 1
}

1.14 - List Parameter Groups

1.14.1 - 1.1

get /v1/parameter-groups

Description

List Parameter Groups.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	major_version optional	Software major version Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	ParameterGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameter-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 = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "id": "",
            "major_version": "",
            "name": "",
            "product_image_type": "",
            "product_type": ""
        }
    ],
    "sort": [
        ""
    ]
}

1.14.2 - 1.0

get /v1/parameter-groups

Description

List Parameter Groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
query	major_version optional	Software major version Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	ParameterGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameter-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 = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "id": "",
            "major_version": "",
            "name": "",
            "product_image_type": "",
            "product_type": ""
        }
    ],
    "sort": [
        ""
    ]
}

1.15 - List Parameter Values

1.15.1 - 1.1

get /v1/clusters/{cluster_id}/parameters

Description

List Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParametersResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "allows_value": "",
            "applied_value": "",
            "apply_type": "",
            "data_type": "",
            "default_value": "",
            "description": "",
            "id": "",
            "is_modifiable": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": "",
    "modified_at": ""
}

1.15.2 - 1.0

get /v1/clusters/{cluster_id}/parameters

Description

List Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParametersResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "allows_value": "",
            "applied_value": "",
            "apply_type": "",
            "data_type": "",
            "default_value": "",
            "description": "",
            "id": "",
            "is_modifiable": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": "",
    "modified_at": ""
}

1.16 - List Parameters

1.16.1 - 1.1

get /v1/parameters

Description

List Parameters.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	dbaas_parameter_group_id required	Parameter group ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParameterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameters?dbaas_parameter_group_id={dbaas_parameter_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 = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "dbaas_parameter_group_id": "",
            "default_value": "",
            "description": "",
            "id": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.16.2 - 1.0

get /v1/parameters

Description

List Parameters.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	name:asc
query	dbaas_parameter_group_id required	Parameter group ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	ParameterPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/parameters?dbaas_parameter_group_id={dbaas_parameter_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 = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "dbaas_parameter_group_id": "",
            "default_value": "",
            "description": "",
            "id": "",
            "name": "",
            "software_type": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.17 - List Server Types

1.17.1 - 1.1

get /v1/server-types

Description

List Server Types.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Server type name Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cpu_core": "",
            "description": "",
            "memory_gb": "",
            "name": "",
            "product_image_type": "",
            "product_type": "",
            "purpose": "",
            "type": ""
        }
    ]
}

1.17.2 - 1.0

get /v1/server-types

Description

List Server Types.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
query	name optional	Server type name Example :	any of [string, null]	None
query	product_image_type optional	Product image type Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerTypeListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-types

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "cpu_core": "",
            "description": "",
            "memory_gb": "",
            "name": "",
            "product_image_type": "",
            "product_type": "",
            "purpose": "",
            "type": ""
        }
    ]
}

1.18 - Manual Backup

1.18.1 - 1.1

post /v1/clusters/{cluster_id}/backups/manual

Description

Manual Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups/manual

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.19 - Patch Minor Version

1.19.1 - 1.1

put /v1/clusters/{cluster_id}/patch

Description

Patch Minor Version.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		MinorPatchRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/patch

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "software_version": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.19.2 - 1.0

put /v1/clusters/{cluster_id}/patch

Description

Patch Minor Version.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		MinorPatchRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/patch

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "software_version": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.20 - Promote DR Secondary

1.20.1 - 1.1

put /v1/clusters/{cluster_id}/dr-secondaries/promote

Description

Promote DR Secondary.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/dr-secondaries/promote

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.21 - Register Log Export Config

1.21.1 - 1.1

post /v1/clusters/{cluster_id}/log-export-configs

Description

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		LogExportConfigCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "access_key": "13952a8851244213f2de8d95069bf161",
    "bucket_name": "examplebucket",
    "delete_on_export": true,
    "log_type": "alert",
    "schedule_day_of_month": "28",
    "schedule_day_of_week": "MON",
    "schedule_frequency_type": "DAY",
    "schedule_hour": "12",
    "secret_key": "secretkey"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.21.2 - 1.0

post /v1/clusters/{cluster_id}/log-export-configs

Description

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		LogExportConfigCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "access_key": "13952a8851244213f2de8d95069bf161",
    "bucket_name": "examplebucket",
    "delete_on_export": true,
    "log_type": "alert",
    "schedule_day_of_month": "28",
    "schedule_day_of_week": "MON",
    "schedule_frequency_type": "DAY",
    "schedule_hour": "12",
    "secret_key": "secretkey"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.22 - Remove Backup Histories

1.22.1 - 1.1

put /v1/clusters/{cluster_id}/backup-histories

Description

Remove Backup Histories.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		BackupHistoryNumberRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "backup_history_number": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.22.2 - 1.0

put /v1/clusters/{cluster_id}/backup-histories

Description

Remove Backup Histories.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		BackupHistoryNumberRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "backup_history_number": [
        ""
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.23 - Restart Cluster

1.23.1 - 1.1

post /v1/clusters/{cluster_id}/restart

Description

Restart Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restart

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.23.2 - 1.0

post /v1/clusters/{cluster_id}/restart

Description

Restart Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/restart

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.24 - Set Audit Log

1.24.1 - 1.1

put /v1/clusters/{cluster_id}/audit-log

Description

Set Audit Log.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		AuditLogRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/audit-log

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "use_audit_log": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.24.2 - 1.0

put /v1/clusters/{cluster_id}/audit-log

Description

Set Audit Log.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		AuditLogRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/audit-log

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "use_audit_log": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.25 - Set Backup

1.25.1 - 1.1

post /v1/clusters/{cluster_id}/backups

Description

Set Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverBackupSettingRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "archive_frequency_minute": "",
    "full_backup_day_of_week": "SUN",
    "retention_period_day": "",
    "starting_time_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.25.2 - 1.0

post /v1/clusters/{cluster_id}/backups

Description

Set Backup.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		SqlserverBackupSettingRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "archive_frequency_minute": "",
    "full_backup_day_of_week": "SUN",
    "retention_period_day": "",
    "starting_time_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.26 - Set Block Storage Size

1.26.1 - 1.1

post /v1/block-storage-groups/{block_storage_group_id}/resize

Description

Set Block Storage Size.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	block_storage_group_id required	Block storage group ID Example : `afc33891202643ba8ba1a5298a1affff`	string	None
body	body required		ResizeBlockStorageGroupRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/block-storage-groups/{block_storage_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "size_gb": 16
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.26.2 - 1.0

post /v1/block-storage-groups/{block_storage_group_id}/resize

Description

Set Block Storage Size.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	block_storage_group_id required	Block storage group ID Example : `afc33891202643ba8ba1a5298a1affff`	string	None
body	body required		ResizeBlockStorageGroupRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/block-storage-groups/{block_storage_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "size_gb": 16
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.27 - Set Log Export Config

1.27.1 - 1.1

put /v1/clusters/{cluster_id}/log-export-configs/{log_type}

Description

Set Log Export Config.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None
body	body required		LogExportConfigModifyRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "access_key": "13952a8851244213f2de8d95069bf161",
    "delete_on_export": true,
    "schedule_day_of_month": "28",
    "schedule_day_of_week": "MON",
    "schedule_frequency_type": "DAY",
    "schedule_hour": "12",
    "secret_key": "secretkey"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.27.2 - 1.0

put /v1/clusters/{cluster_id}/log-export-configs/{log_type}

Description

Set Log Export Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None
body	body required		LogExportConfigModifyRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "access_key": "13952a8851244213f2de8d95069bf161",
    "delete_on_export": true,
    "schedule_day_of_month": "28",
    "schedule_day_of_week": "MON",
    "schedule_frequency_type": "DAY",
    "schedule_hour": "12",
    "secret_key": "secretkey"
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.28 - Set Maintenance

1.28.1 - 1.1

post /v1/clusters/{cluster_id}/maintenance

Description

Set Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		MaintenanceRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "start_day_of_week": "MON",
    "start_minute": "",
    "start_time": "",
    "term_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.28.2 - 1.0

post /v1/clusters/{cluster_id}/maintenance

Description

Set Maintenance.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		MaintenanceRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "start_day_of_week": "MON",
    "start_minute": "",
    "start_time": "",
    "term_hour": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.29 - Set Parameter Values

1.29.1 - 1.1

put /v1/clusters/{cluster_id}/parameters

Description

Set Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		ParametersRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "parameters": [
        {
            "id": "",
            "new_value": "",
            "old_value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.29.2 - 1.0

put /v1/clusters/{cluster_id}/parameters

Description

Set Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		ParametersRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "parameters": [
        {
            "id": "",
            "new_value": "",
            "old_value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.30 - Set Security Group Rules

1.30.1 - 1.1

post /v1/clusters/{cluster_id}/security-group-rules

Description

Set Security Group Rules.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		UpdateSecurityGroupRulesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "add_ip_addresses": [],
    "del_ip_addresses": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.30.2 - 1.0

post /v1/clusters/{cluster_id}/security-group-rules

Description

Set Security Group Rules.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
body	body required		UpdateSecurityGroupRulesRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/security-group-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "add_ip_addresses": [],
    "del_ip_addresses": []
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.31 - Set Server Type

1.31.1 - 1.1

post /v1/instance-groups/{instance_group_id}/resize

Description

Set Server Type.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		InstanceGroupResizeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Request body

{
    "server_type_name": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.31.2 - 1.0

post /v1/instance-groups/{instance_group_id}/resize

Description

Set Server Type.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	instance_group_id required	Instance group ID Example :	string	None
body	body required		InstanceGroupResizeRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/instance-groups/{instance_group_id}/resize

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Request body

{
    "server_type_name": ""
}

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.32 - Show Cluster

1.32.1 - 1.1

get /v1/clusters/{cluster_id}

Description

Show Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SqlserverClusterDetailResponseV1Dot1
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_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 = sqlserver 1.1"

Example HTTP response

Response 200

{
    "account_id": "",
    "allowable_ip_addresses": [],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dbaas_engine": "",
    "dbaas_engine_version_name": "",
    "ha_enabled": false,
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "init_config_option": {
        "ad_config": {
            "ad_dns_servers": [
                ""
            ],
            "ad_domain_name": "",
            "ad_netbios_name": "",
            "ad_user_id": "",
            "failover_cluster_name": ""
        },
        "ad_enabled": false,
        "audit_enabled": false,
        "backup_option": {
            "archive_frequency_minute": "",
            "full_backup_day_of_week": "SUN",
            "retention_period_day": "7",
            "starting_time_hour": "2"
        },
        "database_collation": "SQL_Latin1_General_CP1_CI_AS",
        "database_port": 2866,
        "database_service_name": "",
        "database_user_name": "",
        "databases": [
            {
                "database_name": "",
                "drive_letter": "E"
            }
        ]
    },
    "instance_count": 0,
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "drive_letter": "",
                    "id": "",
                    "name": "",
                    "role_type": "OS",
                    "size_gb": "",
                    "volume_type": "SSD"
                }
            ],
            "id": "",
            "instances": [
                {
                    "name": "",
                    "public_ip_address": "",
                    "public_ip_id": "",
                    "role_type": "",
                    "service_ip_address": "",
                    "service_state": "RUNNING"
                }
            ],
            "role_type": "",
            "server_type_name": ""
        }
    ],
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": "",
        "use_maintenance_option": false
    },
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "nat_enabled": false,
    "product_image_type": "",
    "product_type": "",
    "role_type": "ORIGIN",
    "service_state": "RUNNING",
    "service_watch_log_collection": false,
    "software_version": "",
    "subnet_id": "",
    "timezone": "",
    "vip_public_ip_address": "",
    "vip_public_ip_id": "",
    "virtual_ip_address": ""
}

1.32.2 - 1.0

get /v1/clusters/{cluster_id}

Description

Show Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SqlserverClusterDetailResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_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 = sqlserver 1.0"

Example HTTP response

Response 200

{
    "account_id": "",
    "allowable_ip_addresses": [],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dbaas_engine": "",
    "dbaas_engine_version_name": "",
    "ha_enabled": false,
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "init_config_option": {
        "ad_config": {
            "ad_dns_servers": [
                ""
            ],
            "ad_domain_name": "",
            "ad_netbios_name": "",
            "ad_user_id": "",
            "failover_cluster_name": ""
        },
        "ad_enabled": false,
        "audit_enabled": false,
        "backup_option": {
            "archive_frequency_minute": "",
            "full_backup_day_of_week": "SUN",
            "retention_period_day": "7",
            "starting_time_hour": "2"
        },
        "database_collation": "SQL_Latin1_General_CP1_CI_AS",
        "database_port": 2866,
        "database_service_name": "",
        "database_user_name": "",
        "databases": [
            {
                "database_name": "",
                "drive_letter": "E"
            }
        ]
    },
    "instance_count": 0,
    "instance_groups": [
        {
            "block_storage_groups": [
                {
                    "drive_letter": "",
                    "id": "",
                    "name": "",
                    "role_type": "OS",
                    "size_gb": "",
                    "volume_type": "SSD"
                }
            ],
            "id": "",
            "instances": [
                {
                    "name": "",
                    "public_ip_address": "",
                    "public_ip_id": "",
                    "role_type": "",
                    "service_ip_address": "",
                    "service_state": "RUNNING"
                }
            ],
            "role_type": "",
            "server_type_name": ""
        }
    ],
    "maintenance_option": {
        "period_hour": "",
        "starting_day_of_week": "MON",
        "starting_time": "",
        "use_maintenance_option": false
    },
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "",
    "nat_enabled": false,
    "product_image_type": "",
    "product_type": "",
    "role_type": "ORIGIN",
    "service_state": "RUNNING",
    "software_version": "",
    "subnet_id": "",
    "timezone": "",
    "vip_public_ip_address": "",
    "vip_public_ip_id": "",
    "virtual_ip_address": ""
}

1.33 - Show Instance

1.33.1 - 1.1

get /v1/clusters/{cluster_id}/instances/{instance_name}

Description

Show Instance.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None
path	instance_name required	Instance name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InstanceDetailResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/instances/{instance_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 200

{
    "account_id": "",
    "block_storages": [
        {
            "name": "",
            "role_type": "OS",
            "size_gb": "",
            "volume_type": "SSD"
        }
    ],
    "cluster_id": "",
    "cluster_name": "",
    "cpu_core": "",
    "created_at": "2024-01-15T10:30:00.000Z",
    "created_by": "",
    "dbaas_engine": "",
    "memory_gb": "",
    "modified_at": "2024-01-15T10:30:00.000Z",
    "modified_by": "",
    "name": "",
    "os_type": "",
    "os_version": "",
    "product_image_type": "",
    "product_type": "",
    "public_ip_address": "",
    "public_ip_id": "",
    "region": "",
    "role_type": "",
    "server_type_name": "",
    "service_ip_address": "",
    "service_state": "RUNNING",
    "software_version": "",
    "zone": ""
}

1.34 - Show Request

1.34.1 - 1.1

get /v1/requests/{request_id}

Description

Show Request.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	request_id required	Request ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RequestStateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/requests/{request_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 = sqlserver 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "state": ""
}

1.34.2 - 1.0

get /v1/requests/{request_id}

Description

Show Request.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	request_id required	Request ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	RequestStateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/requests/{request_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 = sqlserver 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "state": ""
}

1.35 - Start Cluster

1.35.1 - 1.1

post /v1/clusters/{cluster_id}/start

Description

Start Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.35.2 - 1.0

post /v1/clusters/{cluster_id}/start

Description

Start Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/start

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.36 - Stop Cluster

1.36.1 - 1.1

post /v1/clusters/{cluster_id}/stop

Description

Stop Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.36.2 - 1.0

post /v1/clusters/{cluster_id}/stop

Description

Stop Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/stop

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.37 - Switchover Cluster

1.37.1 - 1.1

post /v1/clusters/{cluster_id}/switchover

Description

Switchover Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/switchover

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.37.2 - 1.0

post /v1/clusters/{cluster_id}/switchover

Description

Switchover Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/switchover

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.38 - Synchronize Cluster State

1.38.1 - 1.1

post /v1/clusters/{cluster_id}/sync-state

Description

Synchronize Cluster State.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.38.2 - 1.0

post /v1/clusters/{cluster_id}/sync-state

Description

Synchronize Cluster State.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.39 - Synchronize DR Secondary State

1.39.1 - 1.1

post /v1/clusters/{cluster_id}/dr-secondaries/sync-state

Description

Synchronize DR Secondary State.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/dr-secondaries/sync-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.40 - Synchronize Parameter Values

1.40.1 - 1.1

post /v1/clusters/{cluster_id}/parameters/sync

Description

Synchronize Parameter Values.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters/sync

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.40.2 - 1.0

post /v1/clusters/{cluster_id}/parameters/sync

Description

Synchronize Parameter Values.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/parameters/sync

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.41 - Terminate Cluster

1.41.1 - 1.1

delete /v1/clusters/{cluster_id}

Description

Terminate Cluster.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_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 = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.41.2 - 1.0

delete /v1/clusters/{cluster_id}

Description

Terminate Cluster.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_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 = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.42 - Unregister Log Export Config

1.42.1 - 1.1

delete /v1/clusters/{cluster_id}/log-export-configs/{log_type}

Description

Unregister Log Export Config.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.42.2 - 1.0

delete /v1/clusters/{cluster_id}/log-export-configs/{log_type}

Description

Unregister Log Export Config.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None
path	log_type required	Log type Example : `alert`	any of [enum (alert, audit, slow), null]	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/log-export-configs/{log_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.43 - Unset Backup

1.43.1 - 1.1

delete /v1/clusters/{cluster_id}/backups

Description

Unset Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.43.2 - 1.0

delete /v1/clusters/{cluster_id}/backups

Description

Unset Backup.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.44 - Unset Maintenance

1.44.1 - 1.1

delete /v1/clusters/{cluster_id}/maintenance

Description

Unset Maintenance.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.1"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

1.44.2 - 1.0

delete /v1/clusters/{cluster_id}/maintenance

Description

Unset Maintenance.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261031

Parameters

Type	Name	Description	Schema	Default
path	cluster_id required	Cluster ID Example : `109a585ae67b4e8482fdafc8a4a5be74`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/clusters/{cluster_id}/maintenance

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = sqlserver 1.0"

Example HTTP response

Response 202

{
    "request_id": "req-4f668846-8a3d-49f1-8111-451ebccf445c",
    "resource": {
        "id": "109a585ae67b4e8482fdafc8a4a5be74"
    }
}

2 - Models

2.1 - AsyncResponse

Name	Description	Schema	Default
request_id required	Request ID Example : `req-4f668846-8a3d-49f1-8111-451ebccf445c`	string
resource required	Resource	ResourceInfo

2.2 - AuditLogRequest

Name	Description	Schema	Default
use_audit_log required	use_audit_log Example :	boolean

2.3 - BackupHistoryApiItem

Name	Description	Schema
backup_end_at required	Backup end time Example :	string
backup_history_number required	Backup id Example :	string
backup_size_gb required	Backup amount(GB) Example :	object
backup_start_at required	Backup start time Example :	string
backup_state required	Backup state Example :	string
backup_state_detail optional	Backup detail state Example :	any of [string, null]
software_version required	Software version Example :	string

2.4 - BackupHistoryListApiResponse

Name	Description	Schema	Default
contents required	backup list information	array[BackupHistoryApiItem]
total_count required	total number of backup history Example :	integer

2.5 - BackupHistoryNumberRequest

Name	Description	Schema	Default
backup_history_number required	Backup id	array[string]

2.6 - BlockStorageGroupRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

2.7 - BlockStorageResponse

Name	Description	Schema
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

2.8 - ClusterRestoreRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
backup_history_number optional	Backup id Example : `202501010000`	any of [string, null]
backup_recovery_time optional	Backup Recovery Time Example :	any of [string (date-time), null]
block_storage_groups optional	Block storage groups list	any of [array[BlockStorageGroupRequest], null]
instance_name_prefix required	Instance name prefix Example : `myprefix` Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `16`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
server_type_name required	Server type name Example :	string
tags optional	tag	any of [array[Tag], null]

2.9 - Engine

Name	Description	Schema
end_of_service optional	End of Service Example : `False`	boolean
id required	ID Example :	string
major_version required	Software major version Example :	string
name required	DBaaS engine version name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type optional	Product type Example :	any of [string, null]
software_version required	Software version Example :	string

2.10 - EngineListResponse

Name	Description	Schema	Default
contents required	DBaaS engine list	array[Engine]

2.11 - EngineProperty

Name	Description	Schema	Default
name required	DBaas engine property name Example :	string
value required	DBaas engine property value Example :	string

2.12 - EnginePropertyListResponse

Name	Description	Schema	Default
contents required	DBaas engine property list	array[EngineProperty]

2.13 - InstanceDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
block_storages required	Block storages	array[BlockStorageResponse]
cluster_id required	Cluster ID Example :	string
cluster_name required	Cluster name Example :	string
cpu_core required	Server type cpu core Example :	integer
created_at required	Creation time Example :	string (date-time)
created_by required	Creator Example :	string
dbaas_engine required	DBaaS engine Example :	string
memory_gb required	Server type memory Example :	integer
modified_at required	Modification time Example :	string (date-time)
modified_by required	Modifier Example :	string
name required	Name Example :	string
os_type required	OS type Example :	string
os_version required	OS version Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
public_ip_address optional	Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
region required	Region Example :	string
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
server_type_name required	Server type name Example :	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
zone required	Availability Zone Example :	string

2.14 - InstanceGroupResizeRequest

Name	Description	Schema	Default
server_type_name required	Server type name Example :	string

2.15 - InstanceResponse

Name	Description	Schema
name required	Name Example :	string
public_ip_address optional	Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, STANDBY, PRIMARY, SECONDARY, MASTER, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, READ_REPLICA)
service_ip_address optional	User subnet IP address Example :	any of [string, null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

2.16 - LogExportConfig

Name	Description	Schema
bucket_name required	Bucket name Example : `examplebucket`	any of [string, null]
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
is_bucket_deleted required	Bucket deleted Example : `False`	any of [boolean, null]
is_registered required	Log type registration state Example : `True`	boolean
log_label required	Log label Example : `DB Alert Log`	string
log_type required	Log type Example : `alert`	string
schedule_day_of_month required	Schedule day of month Example : `28`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12`	any of [string, null]

2.17 - LogExportConfigCreateRequest

Name	Description	Schema
access_key required	Access key Example : `13952a8851244213f2de8d95069bf161`	any of [string, null]
bucket_name required	Bucket name Example : `examplebucket`	string
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
log_type required	Log type Example : `alert`	string
schedule_day_of_month required	Schedule day of month Example : `28` Pattern : `^(-1\|[1-9]\|1[0-9]\|2[0-9]\|3[0-1])$`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12` Pattern : `^(\d\|1\d\|2[0-3])$`	any of [string, null]
secret_key required	Secret key Example : `secretkey`	any of [string, null]

2.18 - LogExportConfigListResponse

Name	Description	Schema	Default
contents required	Log export config contents	array[LogExportConfig]
count required	Log export config count Example : `1`	integer

2.19 - LogExportConfigModifyRequest

Name	Description	Schema
access_key required	Access key Example : `13952a8851244213f2de8d95069bf161`	any of [string, null]
delete_on_export required	Delete on export Example : `True`	any of [boolean, null]
schedule_day_of_month required	Schedule day of month Example : `28` Pattern : `^(-1\|[1-9]\|1[0-9]\|2[0-9]\|3[0-1])$`	any of [string, null]
schedule_day_of_week required	Schedule day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
schedule_frequency_type required	Schedule frequency type Example : `DAY`	any of [string, null]
schedule_hour required	Schedule hour Example : `12` Pattern : `^(\d\|1\d\|2[0-3])$`	any of [string, null]
secret_key required	Secret key Example : `secretkey`	any of [string, null]

2.20 - MaintenanceOption

Name	Description	Schema
period_hour optional	Period in hours Example : `5` Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string
starting_day_of_week optional	Starting day of week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
starting_time optional	Starting time Example : `0000`	string

2.21 - MaintenanceRequest

Name	Description	Schema
start_day_of_week required	start_day_of_week Example : `MON`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)
start_minute required	start_minute Example :	string
start_time required	start_time Example :	string
term_hour required	term_hour Example : Pattern : `^(0\.5\|[1-5]\.5\|[1-9]\|1[0-9]\|2[0-4])$`	string

2.22 - MaintenanceResponseOption

Name	Description	Schema
period_hour optional	Period in hours Example :	any of [string, null]
starting_day_of_week optional	Starting day of week Example : `MON`	any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
starting_time optional	Starting time Example :	any of [string, null]
use_maintenance_option optional	Maintenance period usage state Example : `False`	boolean

2.23 - MinorPatchRequest

Name	Description	Schema	Default
software_version required	software_version Example :	string

2.24 - ParameterDTO

Name	Description	Schema
allows_value required	Parameter allows value Example :	string
applied_value required	Parameter applied value Example :	string
apply_type required	Parameter apply type Example :	string
data_type required	Parameter data type Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	any of [string, null]
id required	Parameter id Example :	string
is_modifiable required	Parameter is_modifiable Example :	boolean
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

2.25 - ParameterGroup

Name	Description	Schema
id required	Parameter group ID Example :	string
major_version required	Software major version Example :	string
name required	Parameter group name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string

2.26 - ParameterGroupListResponse

Name	Description	Schema	Default
contents required	Parameter group list	array[ParameterGroup]
sort optional	sort Example :	any of [array[string], null]

2.27 - ParameterPageResponse

Name	Description	Schema
contents required	Parameter list	array[Parameters]
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.28 - ParameterRequest

Name	Description	Schema
id required	Parameter id Example :	string
new_value required	Parameter new value Example :	string
old_value required	Parameter old value Example :	string

2.29 - Parameters

Name	Description	Schema
dbaas_parameter_group_id required	Parameter id Example :	string
default_value required	Parameter default value Example :	string
description required	Parameter description Example :	string
id required	Parameter id Example :	string
name required	Parameter name Example :	string
software_type required	Parameter software type Example :	any of [string, null]

2.30 - ParametersRequest

Name	Description	Schema	Default
parameters required	Parameter request list	array[ParameterRequest]

2.31 - ParametersResponse

Name	Description	Schema
contents required	Parameter contents	array[ParameterDTO]
count required	Parameter count Example :	integer
modified_at required	Modification time Example :	string

2.32 - RdbClusterPageResponse

Name	Description	Schema
contents required	Clusters list	any of [array[RdbClusterResponse], null]
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.33 - RdbClusterResponse

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
database_name required	Database Name Example :	any of [string, null]
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
instance_count optional	Instance Count Example : `0`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)

2.34 - RequestStateResponse

Name	Description	Schema	Default
request_id required	Request ID Example :	string
state required	Request state Example :	string

2.35 - ResizeBlockStorageGroupRequest

Name	Description	Schema	Default
size_gb required	Size in GB Example : `16` Minimum : `16` Maximum : `5120`	integer

2.36 - ResourceInfo

Name	Description	Schema	Default
id required	request resource id Example : `109a585ae67b4e8482fdafc8a4a5be74`	string

2.37 - ServerType

Name	Description	Schema
cpu_core required	Server type cpu core Example :	integer
description required	Server type description Example :	string
memory_gb required	Server type memory Example :	integer
name required	Server type name Example :	string
product_image_type required	Product image type Example :	string
product_type required	Product type Example :	string
purpose required	Server type purpose Example :	string
type required	Server type class Example :	string

2.38 - ServerTypeListResponse

Name	Description	Schema	Default
contents required	Server type list	array[ServerType]

2.39 - SqlserverAdConfigRequest

Name	Description	Schema
ad_dns_servers required	AD DNS Servers	array[string]
ad_domain_name required	AD Domain Name Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_netbios_name required	AD NetBIOS Name Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `1` Maximum length : `15`	string
ad_user_id required	AD User ID Example : Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_user_password required	AD User Password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
failover_cluster_name optional	Failover Cluster Name Example : Pattern : `^[a-zA-Z0-9.\-]+$`	any of [string, null]

2.40 - SqlserverAdConfigResponse

Name	Description	Schema
ad_dns_servers optional	AD DNS Servers Example :	any of [array[string], null]
ad_domain_name optional	AD Domain Name Example :	any of [string, null]
ad_netbios_name optional	AD NetBIOS Name Example :	any of [string, null]
ad_user_id optional	AD User ID Example :	any of [string, null]
failover_cluster_name optional	Failover Cluster Name Example :	any of [string, null]

2.41 - SqlserverAddBlockStoragesRequest

Name	Description	Schema	Default
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example : `104` Minimum : `16` Maximum : `5120`	integer
volume_type optional	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)	SSD

2.42 - SqlserverAddSecondaryRequest

Name	Description	Schema
ad_user_id optional	AD User ID Example : Pattern : `^[a-zA-Z0-9.\-]+$`	any of [string, null]
ad_user_password optional	AD User Password Example : `test123!`	any of [string, null]
license required	license Example :	string
name required	Secondary Name Example : Pattern : `^[a-z][a-z0-9\-][a-z0-9]$` Minimum length* : `3` Maximum length : `15`	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]

2.43 - SqlserverBackupOption

Name	Description	Schema	Default
archive_frequency_minute required	Backup starting time (minute) Example : Pattern : `^(5\|10\|30\|60)$`	string
full_backup_day_of_week optional	Full backup day of week Example : `SUN`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)	SUN
retention_period_day optional	Backup retention period (day) Example : `7`	any of [string, null]
starting_time_hour optional	Backup starting time (hour) Example : `2`	any of [string, null]

2.44 - SqlserverBackupSettingRequest

Name	Description	Schema	Default
archive_frequency_minute required	Backup starting time (minute) Example : Pattern : `^(5\|10\|30\|60)$`	string
full_backup_day_of_week optional	Full backup day of week Example : `SUN`	enum (MON, TUE, WED, THU, FRI, SAT, SUN)	SUN
retention_period_day required	Backup retention period (day) Example : Pattern : `^([7-9]\|^[1-2]\d\|^3[0-5])$`	string
starting_time_hour required	Backup starting time (hour) Example : Pattern : `^(\d\|1\d\|2[0-3])$`	string

2.45 - SqlserverBlockStorageGroupResponse

Name	Description	Schema
drive_letter required	Drive letter Example :	string
id required	ID Example :	string
name required	Name Example :	string
role_type required	Role type Example : `OS`	enum (OS, DATA, ARCHIVE, TEMP, BACKUP)
size_gb required	Size in GB Example :	integer
volume_type required	Volume type Example : `SSD`	enum (SSD, SSD_KMS, HDD, HDD_KMS)

2.46 - SqlserverClusterCreateRequest

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example : `c1b856dd12754c0ba2614a39d0ed3ad1`	string
ha_enabled optional	HA availability Example : `False`	boolean
init_config_option required	DB initial configuration option	SqlserverInitConfigOptionRequest
instance_groups required	Instance groups list	array[SqlserverInstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `12`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example : `1ddd7f1e4a8a43ed8b82d70cade0b321`	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example : `Asia/Seoul`	string
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

2.47 - SqlserverClusterCreateRequestV1Dot1

Name	Description	Schema
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
dbaas_engine_version_id required	DBaaS engine version ID. The ID can be obtained via the “GET /v1/engine-versions” endpoint. Example : `c1b856dd12754c0ba2614a39d0ed3ad1`	string
ha_enabled optional	HA availability Example : `False`	boolean
init_config_option required	DB initial configuration option	SqlserverInitConfigOptionRequest
instance_groups required	Instance groups list	array[SqlserverInstanceGroupRequest]
instance_name_prefix required	Instance name prefix Example : Pattern : `^[a-z][a-zA-Z0-9\-]$` Minimum length* : `3` Maximum length : `12`	string
maintenance_option optional	Maintenance option	any of [MaintenanceOption, null]
name required	Cluster name Example : `mycluster` Pattern : `^[a-zA-Z]$` Minimum length* : `3` Maximum length : `20`	string
nat_enabled optional	NAT availability Example : `False`	boolean
service_watch_log_collection required	ServiceWatch log collection Example : `True`	any of [boolean, null]
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example : `1ddd7f1e4a8a43ed8b82d70cade0b321`	string
tags optional	tag	any of [array[Tag], null]
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example : `Asia/Seoul`	string
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

2.48 - SqlserverClusterDetailResponse

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example :	string
dbaas_engine_version_name required	DBaaS engine version name Example :	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required		SqlserverInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required		array[SqlserverInstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example : `False`	boolean
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `QOS`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
software_version required	Software version Example :	string
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example :	string
vip_public_ip_address optional	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

2.49 - SqlserverClusterDetailResponseV1Dot1

Name	Description	Schema
account_id required	Account ID Example :	string
allowable_ip_addresses optional	Allowed IP addresses list	array[string]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
dbaas_engine required	DBaaS engine Example :	string
dbaas_engine_version_name required	DBaaS engine version name Example :	string
ha_enabled optional	HA availability Example : `False`	boolean
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
init_config_option required		SqlserverInitConfigOptionResponse
instance_count optional	Instance Count Example : `0`	integer
instance_groups required		array[SqlserverInstanceGroupResponse]
maintenance_option optional	Maintenance option	any of [MaintenanceResponseOption, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Cluster name Example :	string
nat_enabled optional	NAT availability Example : `False`	boolean
product_image_type required	Product image type Example :	string
product_type required	Product type Example : `QOS`	enum (QOS, PostgreSQL Community, EPAS, MariaDB, MySQL, Redis, Microsoft SQL Server, Search Engine, Event Streams, Vertica, Scalable DB)
role_type required	Role type Example : `ORIGIN`	any of [enum (ORIGIN, REPLICA, RECOVERY, SECONDARY, MIGRATION, RESTORE, DR_REPLICA, DR_SECONDARY), null]
service_state required	Service state Example : `RUNNING`	enum (RUNNING, STOPPED, UNKNOWN, ERROR, FAILED, TERMINATED, CREATING, STOPPING, STARTING, RESTARTING, EDITING, SYNCHRONIZING, UPGRADING, TERMINATING, MIGRATING)
service_watch_log_collection optional	ServiceWatch log collection Example : `False`	boolean
software_version required	Software version Example :	string
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string
timezone required	Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. Example :	string
vip_public_ip_address optional	(VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
vip_public_ip_id optional	(VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
virtual_ip_address optional	Virtual IP address Example :	any of [string, null]

2.50 - SqlserverDatabaseOption

Name	Description	Schema	Default
database_name required	Database Name Example : Pattern : `^[a-zA-Z][a-zA-Z0-9._]$` Minimum length* : `3` Maximum length : `20`	string
drive_letter optional	Drive letter Example : `E` Pattern : `[E-Z]`	string	E

2.51 - SqlserverDrSecondariesListResponse

Name	Description	Schema	Default
contents required	DR Secondaries list	array[SqlserverDrSecondaryItem]
count required	DR Secondary count Example :	integer

2.52 - SqlserverDrSecondaryCreateRequest

Name	Description	Schema
ad_user_id required	AD User ID Example : `aduser123` Pattern : `^[a-zA-Z0-9.\-]+$` Minimum length : `3` Maximum length : `20`	string
ad_user_password required	AD User Password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
license required	license Example :	string
name required	Secondary Name Example : Minimum length : `3` Maximum length : `15`	string
region required	Region Example :	string
service_ip_address optional	User subnet IP address Example :	any of [string, null]
subnet_id required	Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. Example :	string

2.53 - SqlserverDrSecondaryItem

Name	Description	Schema
check_time required	DR Secondary check time Example :	any of [string, null]
name required	Server name Example :	string
region_nm required	DR Secondary region Example :	any of [string, null]
state required	DR Secondary state Example :	any of [string, null]
state_detail required	DR Secondary detail state Example :	any of [string, null]

2.54 - SqlserverInitConfigOptionRequest

Name	Description	Schema	Default
ad_config optional	AD Configuration	any of [SqlserverAdConfigRequest, null]
ad_enabled optional	AD Enabled Example : `False`	boolean
audit_enabled optional	Audit usage state Example : `False`	boolean
backup_option optional	Backup setting option	any of [SqlserverBackupOption, null]
database_collation optional	Example : `SQL_Latin1_General_CP1_CI_AS`	enum (SQL_Latin1_General_CP1_CI_AS, Korean_Wansung_CS_AS, Chinese_PRC_CI_AS)	SQL_Latin1_General_CP1_CI_AS
database_name optional	Example : `{}`	object
database_port optional	Database service port Example : `2866` Minimum : `1200` Maximum : `65535`	integer	2866
database_service_name required	Database Service Name Example : `Sqldbadmin` Pattern : `^[A-Z][a-zA-Z]$` Minimum length* : `1` Maximum length : `15`	string
database_user_name required	Database User Name Example : `mydatabaseusr` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `2` Maximum length : `20`	string
database_user_password required	Database user password Example : `test123!` Minimum length : `8` Maximum length : `30`	string
databases required	Databases	array[SqlserverDatabaseOption]
license required	license Example : `AAAAA-AAAAA-AAAAA-AAAAA`	string

2.55 - SqlserverInitConfigOptionResponse

Name	Description	Schema	Default
ad_config optional		any of [SqlserverAdConfigResponse, null]
ad_enabled optional	AD Enabled Example : `False`	boolean
audit_enabled optional	Audit usage state Example : `False`	boolean
backup_option optional	Backup setting option	any of [SqlserverBackupOption, null]
database_collation optional	Example : `SQL_Latin1_General_CP1_CI_AS`	enum (SQL_Latin1_General_CP1_CI_AS, Korean_Wansung_CS_AS, Chinese_PRC_CI_AS)	SQL_Latin1_General_CP1_CI_AS
database_port optional	Database service port Example : `2866` Minimum : `1024` Maximum : `65535`	integer	2866
database_service_name required	Database Service Name Example :	string
database_user_name required	Database User Name Example :	string
databases required	Databases	array[SqlserverDatabaseOption]

2.56 - SqlserverInstanceGroupRequest

Name	Description	Schema
block_storage_groups required	Block storage groups list Example : `[{'role_type': 'OS', 'size_gb': 104, 'volume_type': 'SSD'}, {'role_type': 'DATA', 'size_gb': 56, 'volume_type': 'SSD'}]`	array[BlockStorageGroupRequest]
instances required	Instances list	array[SqlserverInstanceRequest]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, PRIMARY_SECONDARY)
server_type_name required	Server type name Example : `db1v2m4`	string

2.57 - SqlserverInstanceGroupResponse

Name	Description	Schema
block_storage_groups required		array[SqlserverBlockStorageGroupResponse]
id required	ID Example :	string
instances required	Instances list	array[InstanceResponse]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, ACTIVE_STANDBY, PRIMARY_SECONDARY, MASTER, MASTER_REPLICA, REPLICA, SENTINEL, MASTER_DATA, DATA, KIBANA, DASHBOARDS, ZOOKEEPER_BROKER, BROKER, ZOOKEEPER, AKHQ, CONSOLE, PRIMARY, PRIMARY_NODE, READ_NODE)
server_type_name required	Server type name Example :	string

2.58 - SqlserverInstanceRequest

Name	Description	Schema
public_ip_id optional	Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. Example :	any of [string, null]
role_type required	Role type Example : `ACTIVE`	enum (ACTIVE, PRIMARY, SECONDARY)
service_ip_address optional	User subnet IP address Example : `192.168.10.10/32`	any of [string, null]

2.59 - SqlserverUpdateDatabasesRequest

Name	Description	Schema	Default
add_databases optional	Databases	any of [array[SqlserverDatabaseOption], null]
del_databases optional	Databases	any of [array[SqlserverDatabaseOption], null]

2.60 - Tag

Name	Description	Schema	Default
key optional	Example :	string
value optional	Example :	any of [string, null]

2.61 - UpdateSecurityGroupRulesRequest

Name	Description	Schema	Default
add_ip_addresses optional	Allowed IP addresses list	array[string]
del_ip_addresses optional	Allowed IP addresses list	array[string]