getCloudMssqlInstanceList
- 印刷する
- PDF
getCloudMssqlInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Cloud DB for MSSQLインスタンスリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /getCloudMssqlInstanceList |
リクエストヘッダ
Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | 照会対象の Cloud DB for MSSQLインスタンスのリージョンコード
|
zoneCode | String | Optional | ゾーンコードでフィルタリング
|
vpcNo | String | Optional | VPC番号でフィルタリング |
subnetNo | String | Optional | Subnet番号でフィルタリング |
cloudMssqlServiceName | String | Optional | Cloud DB for MSSQLサービス名でフィルタリング |
cloudMssqlInstanceNoList.N | List<String> | Optional | Cloud DB for MSSQLインスタンス番号でフィルタリング
|
cloudMssqlServerName | String | Optional | Cloud DB for MSSQLサーバ名でフィルタリング |
cloudMssqlServerInstanceNoList.N | List<String> | Optional | Cloud DB for MSSQLサーバインスタンス番号でフィルタリング
|
pageNo | Integer | Optional | ページングされた結果のページ番号
|
pageSize | Integer | Conditional | ページごとに表示する結果数
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=59***
&subnetNo=140***
&cloudMssqlServiceName=mssql004
&cloudMssqlServerName=m-2522****-002
&pageNo=0
&pageSize=1
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、CloudMssqlInstanceListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
responseFormetType=json
の場合{ "getCloudMssqlInstanceListResponse": { "totalRows": 1, "cloudMssqlInstanceList": [ { "cloudMssqlInstanceNo": "2522****", "cloudMssqlServiceName": "mssql004", "cloudMssqlInstanceStatusName": "running", "cloudMssqlInstanceStatus": { "code": "CREAT", "codeName": "CLOUD DATABASE(VPC) Created State" }, "cloudMssqlInstanceOperation": { "code": "NULL", "codeName": "CLOUD DATABASE(VPC) Null OP" }, "cloudMssqlServerInstanceList": [ { "cloudMssqlServerInstanceNo": "2528****", "cloudMssqlServerName": "m-2522****-001", "cloudMssqlServerInstanceStatusName": "running", "cloudMssqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMssqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "vpcNo": "59***", "subnetNo": "140***", "dataStorageSize": 107374182400, "cpuCount": 2, "memorySize": 4294967296 }, { "cloudMssqlServerInstanceNo": "2528****", "cloudMssqlServerName": "m-2522****-002", "cloudMssqlServerInstanceStatusName": "running", "cloudMssqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMssqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "vpcNo": "59***", "subnetNo": "140***", "dataStorageSize": 107374182400, "cpuCount": 2, "memorySize": 4294967296 }, { "cloudMssqlServerInstanceNo": "2529****", "cloudMssqlServerName": "m-2522****-003", "cloudMssqlServerInstanceStatusName": "running", "cloudMssqlServerInstanceStatus": { "code": "RUN", "codeName": "CLOUD DATABASE(VPC) Server Running State" }, "cloudMssqlServerInstanceOperation": { "code": "NOOP", "codeName": "CLOUD DATABASE(VPC) Server Null OP" }, "vpcNo": "59***", "subnetNo": "140***", "dataStorageSize": 107374182400, "cpuCount": 2, "memorySize": 4294967296 } ] } ], "requestId": "cf2c1ae7-****-****-****-bcea41e82443", "returnCode": "0", "returnMessage": "success" } }
responseFormetType=xml
(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <getCloudMssqlInstanceListResponse> <requestId>cf2c1ae7-****-****-****-bcea41e82443</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <cloudMssqlInstanceList> <cloudMssqlInstance> <cloudMssqlInstanceNo>2522****</cloudMssqlInstanceNo> <cloudMssqlServiceName>mssql004</cloudMssqlServiceName> <cloudMssqlInstanceStatusName>running</cloudMssqlInstanceStatusName> <cloudMssqlInstanceStatus> <code>CREAT</code> <codeName>CLOUD DATABASE(VPC) Created State</codeName> </cloudMssqlInstanceStatus> <cloudMssqlInstanceOperation> <code>NULL</code> <codeName>CLOUD DATABASE(VPC) Null OP</codeName> </cloudMssqlInstanceOperation> <cloudMssqlServerInstanceList> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2522****-001</cloudMssqlServerName> <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName> <cloudMssqlServerInstanceStatus> <code>RUN</code> <codeName>CLOUD DATABASE(VPC) Server Running State</codeName> </cloudMssqlServerInstanceStatus> <cloudMssqlServerInstanceOperation> <code>NOOP</code> <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName> </cloudMssqlServerInstanceOperation> <vpcNo>59***</vpcNo> <subnetNo>140***</subnetNo> <dataStorageSize>107374182400</dataStorageSize> <cpuCount>2</cpuCount> <memorySize>4294967296</memorySize> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2528****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2522****-002</cloudMssqlServerName> <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName> <cloudMssqlServerInstanceStatus> <code>RUN</code> <codeName>CLOUD DATABASE(VPC) Server Running State</codeName> </cloudMssqlServerInstanceStatus> <cloudMssqlServerInstanceOperation> <code>NOOP</code> <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName> </cloudMssqlServerInstanceOperation> <vpcNo>59***</vpcNo> <subnetNo>140***</subnetNo> <dataStorageSize>107374182400</dataStorageSize> <cpuCount>2</cpuCount> <memorySize>4294967296</memorySize> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerInstanceNo>2529****</cloudMssqlServerInstanceNo> <cloudMssqlServerName>m-2522****-003</cloudMssqlServerName> <cloudMssqlServerInstanceStatusName>running</cloudMssqlServerInstanceStatusName> <cloudMssqlServerInstanceStatus> <code>RUN</code> <codeName>CLOUD DATABASE(VPC) Server Running State</codeName> </cloudMssqlServerInstanceStatus> <cloudMssqlServerInstanceOperation> <code>NOOP</code> <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName> </cloudMssqlServerInstanceOperation> <vpcNo>59***</vpcNo> <subnetNo>140***</subnetNo> <dataStorageSize>107374182400</dataStorageSize> <cpuCount>2</cpuCount> <memorySize>4294967296</memorySize> </cloudMssqlServerInstance> </cloudMssqlServerInstanceList> </cloudMssqlInstance> </cloudMssqlInstanceList> </getCloudMssqlInstanceListResponse>
この記事は役に立ちましたか?