getCloudMssqlLogFileList

Prev Next

VPC環境で利用できます。

使用可能な Cloud DB for MSSQLログファイルリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /getCloudMssqlLogFileList

リクエストヘッダ

Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MSSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMssqlInstanceNo String Required Cloud DB for MSSQLインスタンス番号
cloudMssqlServerInstanceNo String Required Cloud DB for MSSQLサーバインスタンス番号
fileType String Required ログファイルタイプ
  • errorLog | agentLog | traceLog | auditLog | xeBaselineLog
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlLogFileList
?regionCode=KR
&cloudMssqlInstanceNo=2522****
&cloudMssqlServerInstanceNo=2528****
&fileType=agentLog
&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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、CloudMssqlLogFileListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormetType=jsonの場合

    {
        "getCloudMssqlLogFileListResponse": {
            "totalRows": 4,
            "cloudMssqlLogFileList": [
                {
                    "fileName": "SQLAGENT.OUT",
                    "fileSize": 3164,
                    "fileDate": "2024-07-01T14:58:13+0900"
                },
                {
                    "fileName": "SQLAGENT.1",
                    "fileSize": 4428,
                    "fileDate": "2024-07-01T14:58:06+0900"
                },
                {
                    "fileName": "SQLAGENT.2",
                    "fileSize": 4172,
                    "fileDate": "2024-07-01T14:56:23+0900"
                },
                {
                    "fileName": "SQLAGENT.3",
                    "fileSize": 4312,
                    "fileDate": "2024-07-01T14:54:11+0900"
                }
            ],
            "requestId": "dd99ccc0-****-****-****-f002e46ceb43",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMssqlLogFileListResponse>
        <requestId>dd99ccc0-****-****-****-f002e46ceb43</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>4</totalRows>
        <cloudMssqlLogFileList>
            <cloudMssqlLogFile>
                <fileName>SQLAGENT.OUT</fileName>
                <fileSize>3164</fileSize>
                <fileDate>2024-07-01T14:58:13+0900</fileDate>
            </cloudMssqlLogFile>
            <cloudMssqlLogFile>
                <fileName>SQLAGENT.1</fileName>
                <fileSize>4428</fileSize>
                <fileDate>2024-07-01T14:58:06+0900</fileDate>
            </cloudMssqlLogFile>
            <cloudMssqlLogFile>
                <fileName>SQLAGENT.2</fileName>
                <fileSize>4172</fileSize>
                <fileDate>2024-07-01T14:56:23+0900</fileDate>
            </cloudMssqlLogFile>
            <cloudMssqlLogFile>
                <fileName>SQLAGENT.3</fileName>
                <fileSize>4312</fileSize>
                <fileDate>2024-07-01T14:54:11+0900</fileDate>
            </cloudMssqlLogFile>
        </cloudMssqlLogFileList>
    </getCloudMssqlLogFileListResponse>