リクエスト

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

メソッド	URI
GET, POST	/getDbServerLogList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の Cloud DB for PostgreSQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`logType`	String	Required	DB Serverログファイルタイプ `POSTGRESQL_LOG`
`cloudPostgresqlServerInstanceNo`	String	Required	Cloud DB for PostgreSQLサーバインスタンス番号 getCloudPostgresqlInstanceListを通じて確認
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用してページング処理 0 (最小)
`pageSize`	Integer	Conditional	ページごとに表示する結果数 `pageNo`、`pageSize`を利用してページング処理 `pageNo`入力時、必須 1~1000
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/getDbServerLogList
?regionCode=KR
&logType=POSTGRESQL_LOG
&cloudPostgresqlServerInstanceNo=****925'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "getDbServerLogListResponse": {
        "totalRows": 3,
        "cloudPostgresqlDbServerLogList": [
            {
                "fileName": "postgresql-2024-06-04_000000.log",
                "fileSize": 0,
                "fileDate": "2024-06-04T00:00:00+0900"
            },
            {
                "fileName": "postgresql-2024-06-03_105643.log",
                "fileSize": 6334,
                "fileDate": "2024-06-03T16:40:41+0900"
            },
            {
                "fileName": "postgresql-2024-06-03_105640.log",
                "fileSize": 2318,
                "fileDate": "2024-06-03T10:56:41+0900"
            }
        ],
        "requestId": "93f8166d-****-****-****-12b2ad53630a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getDbServerLogListResponse>
    <requestId>93f8166d-****-****-****-12b2ad53630a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <cloudPostgresqlDbServerLogList>
        <cloudPostgresqlDbServerLog>
            <fileName>postgresql-2024-06-04_000000.log</fileName>
            <fileSize>0</fileSize>
            <fileDate>2024-06-04T00:00:00+0900</fileDate>
        </cloudPostgresqlDbServerLog>
        <cloudPostgresqlDbServerLog>
            <fileName>postgresql-2024-06-03_105643.log</fileName>
            <fileSize>6334</fileSize>
            <fileDate>2024-06-03T16:40:41+0900</fileDate>
        </cloudPostgresqlDbServerLog>
        <cloudPostgresqlDbServerLog>
            <fileName>postgresql-2024-06-03_105640.log</fileName>
            <fileSize>2318</fileSize>
            <fileDate>2024-06-03T10:56:41+0900</fileDate>
        </cloudPostgresqlDbServerLog>
    </cloudPostgresqlDbServerLogList>
</getDbServerLogListResponse>

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud DB for PostgreSQL