getCloudDBConfigGroupList
- 印刷する
- PDF
getCloudDBConfigGroupList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
使用できるCloudDB Config groupを照会します。
現在、MSSQLのみ使用できます。
リクエスト
リクエストヘッダ
ヘッダ名 | 説明 |
---|---|
x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。x-ncp-apigw-timestamp:{Timestamp} |
x-ncp-apigw-api-key | APIGWで発行されたキーの値、v2を使用する場合、api-keyは使いません。x-ncp-apigw-api-key:{API Gateway API Key} |
x-ncp-iam-access-key | Naverクラウドプラットフォームで発行されたAccess Key ID値x-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Access Key ID値とSecret Keyで暗号化した署名x-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Request body content typeをapplication/jsonに指定Content-Type: application/json |
リクエストパラメータ
パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
dbKindCode | Y | String | MSSQL | DBタイプコード |
responseFormatType | N | String | responseの結果format設定 |
dbKindCode
- 照会するCloudDBの種類を選択する必要があるが、MySQLの場合は今後サポートする予定であり、
現在はMSSQLのみ選択可能です。
- 照会するCloudDBの種類を選択する必要があるが、MySQLの場合は今後サポートする予定であり、
responseFormatType
- APIの実行結果をレスポンスするformatを決めます。xmlとjsonの中で選択できます。
レスポンス
フィールド名 | タイプ | 説明 | 備考 |
---|---|---|---|
requestId | String | リクエストID値 | |
returnMessage | String | レスポンスメッセージ | |
totalRows | Integer | レスポンス結果rowの数 | |
cloudDBConfigGroupList[] | String | Config Groupリスト情報 |
例示
リクエスト例示
curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json"
-H "accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
-H "x-ncp-apigw-timestamp: 1546398302273"
-H "x-ncp-apigw-signature-v2: VXjaLhHB2CdowCrqDNYg7w7GR3TYxZzM2eIZ+i3IH0Q="
https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBConfigGroupList?dbKindCode=MSSQL&responseFormatType=json
リクエストサンプル
- Cloud DB for MSSQLで使用できるConfig groupリスト照会
{
"dbKindCode": "MSSQL",
"responseFormatType": "json"
}
レスポンス例示
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Mon, 24 Dec 2018 08:59:40 GMT
server: nginx
transfer-encoding: chunked
x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2
{
"getCloudDBConfigGroupListResponse": {
"returnCode": "0",
"returnMessage": "success",
"totalRows": 2,
"cloudDBConfigGroupList": [
{
"configGroupNo": "0",
"configGroupType": "system",
"configGroupName": "mssql_2016_default"
},
{
"configGroupNo": "91",
"configGroupType": "user",
"configGroupName": "test-group"
}
]
}
}
エラーコード
Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。
エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。
エラーコード | レスポンスメッセージ | 説明 |
---|---|---|
200 | Ok | |
500 | Server Error |
この記事は役に立ちましたか?