API v1.0 ガイド - NHN Cloud 使用ガイド

Database > RDS for PostgreSQL > APIガイド > API v1.0ガイド

RDS for PostgreSQL API 共通情報

API エンドポイント

リージョン	エンドポイント
韓国(パンギョ)リージョン	https://kr1-rds-postgres.api.nhncloudservice.com

認証および権限

RDS for PostgreSQLは、API呼び出し時の認証/認可のためにUser Access Keyトークンを使用します。User Access Keyトークンは、User Access Keyに基づいて発行されるBearerタイプの一時的なアクセストークンです。User Access Keyトークンの発行及び使用に関する詳細は、User Access Keyトークンを参照してください。発行されたトークンはAppkeyと共にリクエストHeaderに含める必要があります。

名前	種類	形式	必須	説明
X-TC-APP-KEY	Header	String	O	RDS for PostgreSQLサービスのAppkeyまたはプロジェクト統合Appkey
X-NHN-AUTHORIZATION	Header	String	O	Public APIで発行されたBearerタイプトークン

また、プロジェクト権限によって呼び出せるAPIが制限されます。RDS for PostgreSQL ADMIN、RDS for PostgreSQL VIEWERのロールには、次のような基本権限が付与されており、プロジェクト内のロールグループ管理メニューで必要な権限のみを付与できます。

RDS for PostgreSQL ADMINのロールには、API実行に必要なすべての権限が付与されます。
RDS for PostgreSQL VIEWERのロールには、情報を照会する権限のみ付与されます。
- DBインスタンスを作成、修正、削除およびDBインスタンスを対象とするいかなる機能も使用できません。
- ただし、通知グループとユーザーグループに関連する機能は使用できます。

APIリクエスト時、認証に失敗または権限がない場合、次のようなエラーが発生します。

resultCode	resultMessage	説明
80401	Unauthorized	認証に失敗しました。
80403	Forbidden	権限がありません。

レスポンス共通情報

すべてのAPIリクエストに200 OKでレスポンスします。詳しいレスポンス結果はレスポンス本文のヘッダを参照してください。

レスポンス本文

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

フィールド

名前	データ型	説明
resultCode	Number	結果コード(成功:0、その他:失敗)
resultMessage	String	結果メッセージ
successful	Boolean	成否

DBバージョン

DBバージョン	作成可否
POSTGRESQL_V14_6
POSTGRESQL_V14_15
POSTGRESQL_V14_17	O
POSTGRESQL_V14_19	O
POSTGRESQL_V17_2
POSTGRESQL_V17_4	O
POSTGRESQL_V17_6	O

ENUMタイプのdbVersionフィールドに対して該当値を使用できます。
バージョンによっては、作成不可能な場合や復元不可能な場合があります。

DBバージョンリストを表示

GET /v1.0/db-versions

必要権限

権限名	説明
RDSforPostgreSQL:DbVersion.List	DBバージョンリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
dbVersions	Body	Array	DBバージョンリスト
dbVersions.dbVersion	Body	String	DBバージョン
dbVersions.dbVersionName	Body	String	DBバージョン名
dbVersions.restorableFromObs	Body	Boolean	オブジェクトストレージから復元可能かどうか

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbVersions": [
        {
            "dbVersion": "POSTGRESQL_V17_6",
            "dbVersionName": "PostgreSQL V17.6",
            "restorableFromObs": true
        }
    ]
}

DBインスタンス仕様

DBインスタンス仕様リストを表示

GET /v1.0/db-flavors

必要権限

権限名	説明
RDSforPostgreSQL:DbFlavor.List	DBインスタンス仕様リスト表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
dbFlavors	Body	Array	DBインスタンス仕様リスト
dbFlavors.dbFlavorId	Body	UUID	DBインスタンス仕様の識別子
dbFlavors.dbFlavorName	Body	String	DBインスタンス仕様名
dbFlavors.ram	Body	Number	メモリ容量(MB)
dbFlavors.vcpus	Body	Number	CPUコア数

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbFlavors": [
        {
            "dbFlavorId": "50be6d9c-02d6-4594-a2d4-12010eb65ec0",
            "dbFlavorName": "m2.c1m2",
            "ram": 2048,
            "vcpus": 1
        }
    ]
}

プロジェクト情報

リージョンリストを表示

GET /v1.0/project/regions

必要権限

権限名	説明
RDSforPostgreSQL:Project.Get	プロジェクト情報を照会

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
regions	Body	Array	リージョンリスト
regions.regionCode	Body	Enum	リージョンコード - `KR1`:韓国(パンギョ)リージョン
regions.isEnabled	Body	Boolean	リージョンが有効かどうか

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "regions": [
        {
            "regionCode": "KR1",
            "isEnabled": true
        }
    ]
}

プロジェクトメンバーリストを表示

GET /v1.0/project/members

必要権限

権限名	説明
RDSforPostgreSQL:Project.Get	プロジェクト情報照会

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
members	Body	Array	プロジェクトメンバーリスト
members.memberId	Body	UUID	プロジェクトメンバーの識別子
members.memberName	Body	String	プロジェクトメンバーの名前
members.emailAddress	Body	String	プロジェクトメンバーのメールアドレス
members.phoneNumber	Body	String	プロジェクトメンバーの電話番号

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "members": [
        {
            "memberId": "1b1d3627-507a-49ea-8cb7-c86dfa9caa58",
            "memberName": "ホン・ギルドン",
            "emailAddress": "gildong.hong@nhn.com",
            "phoneNumber": "+821012345678"
        }
    ]
}

ネットワーク

サブネットリストを表示

GET /v1.0/network/subnets

必要権限

権限名	説明
RDSforPostgreSQL:Network.List	サブネットリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
subnets	Body	Array	サブネットリスト
subnets.subnetId	Body	UUID	サブネットの識別子
subnets.subnetName	Body	String	サブネットを識別できる名前
subnets.subnetCidr	Body	String	サブネットのCIDR
subnets.usingGateway	Body	Boolean	ゲートウェイ使用有無
subnets.availableIpCount	Body	Number	使用可能なIP数

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "subnets": [
        {
            "subnetId": "1b2a9b23-0725-4b92-8c78-35db66b8ad9f",
            "subnetName": "Default Network",
            "subnetCidr": "192.168.0.0/24",
            "usingGateway": true,
            "availableIpCount": 240
        }
    ]
}

ストレージ

ストレージタイプリストを表示

GET /v1.0/storage-types

必要権限

権限名	説明
RDSforPostgreSQL:Storage.List	ストレージタイプリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
storageTypes	Body	Array	ストレージタイプリスト

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "storageTypes": [
        "General SSD",
        "General HDD"
    ]
}

作業情報

作業情報の詳細を表示

GET /v1.0/jobs/{jobId}

必要権限

権限名	説明
RDSforPostgreSQL:Job.Get	作業情報の詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
jobId	URL	UUID	O	作業の識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	作業の識別子
jobStatus	Body	Enum	作業の現在状態 - `PREPARING`:作業が準備中の場合 - `READY`:作業が準備完了した場合 - `RUNNING`:作業が進行中の場合 - `COMPLETED`:作業が完了した場合 - `REGISTERED`:作業が登録された場合 - `WAIT_TO_REGISTER`:作業が登録待機中の場合 - `INTERRUPTED`:作業進行中に割り込みが発生した場合 - `CANCELED`:作業がキャンセルされた場合 - `FAILED`:作業が失敗した場合 - `ERROR`:作業進行中にエラーが発生した場合 - `DELETED`:作業が削除された場合 - `FAIL_TO_READY`:作業準備に失敗した場合
resourceRelations	Body	Array	関連リソースリスト
resourceRelations.resourceType	Body	Enum	関連リソースタイプ - `DB_INSTANCE`: DBインスタンス - `DB_INSTANCE_GROUP`: DBインスタンスグループ - `DB_SECURITY_GROUP`: DBセキュリティグループ - `PARAMETER_GROUP`:パラメータグループ - `BACKUP`:バックアップ - `TENANT`:テナント
resourceRelations.resourceId	Body	UUID	関連リソースの識別子
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c",
    "jobStatus": "RUNNING",
    "resourceRelations": [
        {
            "resourceType": "DB_INSTANCE",
            "resourceId": "56b39dcf-65eb-47ec-9d4f-09f160ba2266"
        }
    ],
    "createdYmdt": "2023-02-22T20:47:12+09:00",
    "updatedYmdt": "2023-02-22T20:49:46+09:00"
}

DBインスタンスグループ

DBインスタンスグループリストを表示

GET /v1.0/db-instance-groups

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroup.List	DBインスタンスグループリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
dbInstanceGroups	Body	Array	DBインスタンスグループリスト
dbInstanceGroups.dbInstanceGroupId	Body	UUID	DBインスタンスグループの識別子
dbInstanceGroups.dbInstanceGroupStatus	Body	Enum	DBインスタンスグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
dbInstanceGroups.replicationType	Body	Enum	DBインスタンスグループのレプリケーションタイプ - `STANDALONE`:単一
dbInstanceGroups.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbInstanceGroups.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbInstanceGroups": [
        {
            "dbInstanceGroupId": "05de0746-89fd-49c8-94f9-9c5b1df97009",
            "dbInstanceGroupStatus": "CREATED",
            "replicationType": "STANDALONE",
            "createdYmdt": "2023-02-13T17:35:20+09:00",
            "updatedYmdt": "2023-02-13T17:35:20+09:00"
        }
    ]
}

DBインスタンスグループ詳細を表示

GET /v1.0/db-instance-groups/{dbInstanceGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroup.Get	DBインスタンスグループ詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子

レスポンス

名前	種類	形式	説明
dbInstanceGroupId	Body	UUID	DBインスタンスグループの識別子
dbInstanceGroupStatus	Body	Enum	DBインスタンスグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
replicationType	Body	Enum	DBインスタンスグループのレプリケーションタイプ - `STANDALONE`:単一 - `HIGH_AVAILABILITY`:高可用性
dbInstances	Body	Array	DBインスタンスグループに属するDBインスタンスリスト
dbInstances.dbInstanceId	Body	UUID	DBインスタンスの識別子
dbInstances.dbInstanceType	Body	Enum	DBインスタンスのロールタイプ - `MASTER`:マスター - `FAILED_MASTER`:フェイルオーバーされたマスター - `CANDIDATE_MASTER`:予備マスター - `READ_ONLY_SLAVE`:リードレプリカ
dbInstances.dbInstanceStatus	Body	Enum	DBインスタンスの現在状態
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbInstanceGroupId": "36617a8e-0df8-4b16-b6ea-6306019e95da",
    "dbInstanceGroupStatus": "CREATED",
    "replicationType": "STANDALONE",
    "dbInstances": [
        {
            "dbInstanceId": "6d2db0ef-fe9b-4ed4-97b1-d97fcb4cf1b8",
            "dbInstanceType": "MASTER",
            "dbInstanceStatus": "AVAILABLE"
        }
    ],
    "createdYmdt": "2023-03-03T17:38:14+09:00",
    "updatedYmdt": "2023-03-03T17:38:14+09:00"
}

DBインスタンスグループ > 拡張機能管理

拡張機能リスト表示

GET /v1.0/db-instance-groups/{dbInstanceGroupId}/extensions

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroupExtension.List	拡張機能リスト照会

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子

レスポンス

名前	種類	形式	説明
extensions	Body	Array	拡張機能リスト
extensions.extensionId	Body	UUID	拡張機能の識別子
extensions.extensionName	Body	String	拡張機能名
extensions.extensionStatus	Body	ENUM	拡張機能の状態 - `AVAILABLE`:使用可能 - `NEED_TO_APPLY`:適用必要 - `APPLYING`:適用中
extensions.databases	Body	Array	拡張機能がインストールされたデータベース情報
extensions.databases.dbInstanceGroupExtensionId	Body	UUID	DBインスタンスグループ内の拡張機能の識別子
extensions.databases.dbInstanceGroupExtensionStatus	Body	ENUM	DBインスタンスグループ内の拡張機能の状態 - `CREATED`:作成済み - `INSTALLED`:インストール済み - `INSTALLING`:インストール中 - `INSTALL_ERROR`:インストールエラー - `DELETED`:削除済み - `DELETING`:削除中 - `DELETE_ERROR`:削除エラー
extensions.databases.databaseId	Body	UUID	データベースの識別子
extensions.databases.databaseName	Body	String	データベース名
extensions.databases.reservedAction	Body	ENUM	予約タスク - `NONE`:なし - `INSTALL`:インストール予約(適用必要) - `INSTALL_WITH_CASCADE`:強制インストール予約(適用必要) - `DELETE`:削除予約(適用必要) - `DELETE_WITH_CASCADE`:強制削除予約(適用必要)
extensions.databases.errorReason	Body	String	エラー原因
isNeedToApply	Body	Boolean	変更事項の適用が必要かどうか

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "extensions": [
        {
            "extensionId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
            "extensionName": "address_standardizer",
            "extensionStatus": "AVAILABLE",
            "databases": [
                {
                    "dbInstanceGroupExtensionId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
                    "databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
                    "databaseName": "database-1",
                    "dbInstanceGroupExtensionStatus": "INSTALLED",
                    "reservedAction": "NONE",
                    "errorReason": null
                }
            ]
        }
    ],
    "isNeedToApply": true
}

拡張機能のインストール

POST /v1.0/db-instance-groups/{dbInstanceGroupId}/extensions/{extensionId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroupExtension.Install	拡張機能のインストール

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子
extensionId	URL	UUID	O	拡張機能の識別子
databaseId	Body	UUID	O	インストール対象データベースの識別子
schemaName	Body	String	O	インストール対象スキーマ名
withCascade	Body	Boolean	X	依存情報を強制的にインストールするかどうか

レスポンス

このAPIはレスポンス本文を返しません。

例

{
  "header": {
    "resultCode": 0,
    "resultMessage": "SUCCESS",
    "isSuccessful": true
  }
}

拡張機能の削除(キャンセル)

DELETE /v1.0/db-instance-groups/{dbInstanceGroupId}/extensions/{dbInstanceGroupExtensionId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroupExtension.Delete	拡張機能の削除(キャンセル)

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子
dbInstanceGroupExtensionId	URL	UUID	O	DBインスタンスグループ内の拡張機能の識別子
withCascade	Query	Boolean	O	依存情報を強制的に削除するかどうか

レスポンス

このAPIはレスポンス本文を返しません。

例

{
  "header": {
    "resultCode": 0,
    "resultMessage": "SUCCESS",
    "isSuccessful": true
  }
}

拡張機能変更事項適用

POST /v1.0/db-instance-groups/{dbInstanceGroupId}/extensions/apply

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroupExtension.Apply	拡張機能変更事項適用

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
  "header": {
    "resultCode": 0,
    "resultMessage": "SUCCESS",
    "isSuccessful": true
  },
  "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

拡張機能の同期

POST /v1.0/db-instance-groups/{dbInstanceGroupId}/extensions/sync

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceGroupExtension.Sync	拡張機能の同期

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceGroupId	URL	UUID	O	DBインスタンスグループの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
  "header": {
    "resultCode": 0,
    "resultMessage": "SUCCESS",
    "isSuccessful": true
  },
  "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス

DBインスタンスの状態

状態	説明
`AVAILABLE`	DBインスタンスが使用可能な場合
`BEFORE_CREATE`	DBインスタンス作成前の場合
`STORAGE_FULL`	DBインスタンスの容量が不足している場合
`FAIL_TO_CREATE`	DBインスタンス作成に失敗した場合
`FAIL_TO_CONNECT`	DBインスタンス接続に失敗した場合
`REPLICATION_STOP`	DBインスタンスの複製が中断された場合
`REPLICATION_DELAY`	DBインスタンスの複製が遅延している場合
`FAILOVER`	高可用性DBインスタンスのフェイルオーバーが完了した場合
`SHUTDOWN`	DBインスタンスが中止された場合
`DELETED`	DBインスタンスが削除された場合

DBインスタンスの進行状態

状態	説明
`APPLYING_DB_INSTANCE_HBA_RULE`	アクセス制御ルール適用中
`APPLYING_PARAMETER_GROUP`	パラメータグループ適用中
`APPLYING_EXTENSION`	拡張機能の適用中
`BACKING_UP`	バックアップ中
`CANCELING`	キャンセル中
`CREATING`	作成中
`CREATING_DATABASE`	データベース作成中
`CREATING_USER`	ユーザー作成中
`DELETING`	削除中
`DELETING_DATABASE`	データベース削除中
`DELETING_USER`	ユーザー削除中
`EXPORTING_BACKUP`	バックアップをエクスポート中
`FAILING_OVER`	フェイルオーバー中
`MIGRATING`	マイグレーション中
`MODIFYING`	修正中
`OCCUPIED`	占有中
`PREPARING`	準備中
`PROMOTING`	昇格中
`PROMOTING_FORCIBLY`	強制昇格中
`REBUILDING`	再構築中
`REPAIRING`	復旧中
`REPLICATING`	複製中
`RESTARTING`	再起動中
`RESTARTING_FORCIBLY`	強制再起動中
`RESTORING`	復元中
`STARTING`	起動中
`STOPPING`	停止中
`SYNCING_DATABASE`	データベース同期中
`SYNCING_USER`	ユーザー同期中
`SYNCING_EXTENSION`	拡張機能の同期中
`UPDATING_USER`	ユーザー修正中
`UPDATING_DATABASE`	データベース修正中
`WAIT_MANUAL_CONTROL`	手動フェイルオーバー待機中

DBインスタンスリストを表示

GET /v1.0/db-instances

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.List	DBインスタンスリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
dbInstances	Body	Array	DBインスタンスリスト
dbInstances.dbInstanceId	Body	UUID	DBインスタンスの識別子
dbInstances.dbInstanceGroupId	Body	UUID	DBインスタンスグループの識別子
dbInstances.dbInstanceName	Body	String	DBインスタンスを識別できる名前
dbInstances.description	Body	String	DBインスタンスの追加情報
dbInstances.dbVersion	Body	Enum	DBバージョン情報
dbInstances.dbPort	Body	Number	DBポート
dbInstances.dbInstanceType	Body	Enum	DBインスタンスのロールタイプ - `MASTER`:マスター - `FAILED_MASTER`:フェイルオーバーされたマスター - `CANDIDATE_MASTER`:予備マスター - `READ_ONLY_SLAVE`:リードレプリカ
dbInstances.dbInstanceStatus	Body	Enum	DBインスタンスの現在状態
dbInstances.progressStatus	Body	Enum	DBインスタンスの現在進行状態
dbInstances.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbInstances.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbInstances": [
        {
            "dbInstanceId": "d067593b-1acc-4ccc-9e8a-cc72d6d79ec3",
            "dbInstanceGroupId": "51c7d080-ff36-4025-84b1-9d9d0b4fe9e0",
            "dbInstanceName": "db-instance",
            "description": null,
            "dbVersion": "POSTGRESQL_V17_6",
            "dbPort": 15432,
            "dbInstanceType": "MASTER",
            "dbInstanceStatus": "AVAILABLE",
            "progressStatus": "NONE",
            "createdYmdt": "2023-01-23T12:03:13+09:00",
            "updatedYmdt": "2023-02-02T17:20:17+09:00"
        }
    ]
}

DBインスタンス詳細を表示

GET /v1.0/db-instances/{dbInstanceId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
dbInstanceId	Body	UUID	DBインスタンスの識別子
dbInstanceGroupId	Body	UUID	DBインスタンスグループの識別子
dbInstanceName	Body	String	DBインスタンスを識別できる名前
description	Body	String	DBインスタンスの追加情報
dbVersion	Body	Enum	DBバージョン情報
dbPort	Body	Number	DBポート
dbInstanceType	Body	Enum	DBインスタンスのロールタイプ - `MASTER`:マスター - `FAILED_MASTER`:フェイルオーバーされたマスター - `CANDIDATE_MASTER`:予備マスター - `READ_ONLY_SLAVE`:リードレプリカ
dbInstanceStatus	Body	Enum	DBインスタンスの現在状態
progressStatus	Body	Enum	DBインスタンスの現在の作業進行状態
dbFlavorId	Body	UUID	DBインスタンス仕様の識別子
parameterGroupId	Body	UUID	DBインスタンスに適用されたパラメータグループの識別子
dbSecurityGroupIds	Body	Array	DBインスタンスに適用されたDBセキュリティグループの識別子リスト
notificationGroupIds	Body	Array	DBインスタンスに適用された通知グループの識別子リスト
useDeletionProtection	Body	Boolean	DBインスタンス削除保護の有無
needToApplyParameterGroup	Body	Boolean	最新パラメータグループの適用可否
needMigration	Body	Boolean	マイグレーションの要否
osVersion	Body	String	OSバージョン
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbInstanceId": "d067593b-1acc-4ccc-9e8a-cc72d6d79ec3",
    "dbInstanceGroupId": "51c7d080-ff36-4025-84b1-9d9d0b4fe9e0",
    "dbInstanceName": "db-instance",
    "description": null,
    "dbVersion": "POSTGRESQL_V17_6",
    "dbPort": 15432,
    "dbInstanceType": "MASTER",
    "dbInstanceStatus": "AVAILABLE",
    "progressStatus": "NONE",
    "dbFlavorId": "e9ed4ef6-78d7-46fa-ace9-32481e97f3b7",
    "parameterGroupId": "b03e8b13-de27-4d04-a488-ff5689589372",
    "dbSecurityGroupIds": ["01908c35-d2c9-4852-baf0-17f06ec42c03"],
    "notificationGroupIds": ["83a62a33-ddbf-4a04-8653-e54463d5b1ac"],
    "useDeletionProtection": false,
    "needToApplyParameterGroup": false,
    "needMigration": false,
    "createdYmdt": "2022-11-23T12:03:13+09:00",
    "updatedYmdt": "2022-12-02T17:20:17+09:00"
}

DBインスタンスを作成する

POST /v1.0/db-instances

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Create	DBインスタンスを作成する

リクエスト

名前	種類	形式	必須	説明
dbInstanceName	Body	String	O	DBインスタンスを識別できる名前
description	Body	String	X	DBインスタンスの追加情報
dbFlavorId	Body	UUID	O	DBインスタンス仕様の識別子
dbVersion	Body	Enum	O	DBバージョン情報
dbPort	Body	Number	O	DBポート - 最小値:`5432` - 最大値:`45432`
databaseName	Body	String	O	DBエンジン内で新規作成するデータベース名
dbUserName	Body	String	O	DBエンジン内で新規作成するユーザーアカウント名
dbPassword	Body	String	O	DBエンジン内で新規作成するユーザーアカウントのパスワード - 最小文字数:`4` - 最大文字数:`16`
parameterGroupId	Body	UUID	O	パラメータグループの識別子
dbSecurityGroupIds	Body	Array	X	DBセキュリティグループの識別子リスト
useDeletionProtection	Body	Boolean	X	削除保護の有無 - デフォルト値:`false`
useDefaultNotification	Body	Boolean	X	基本通知の使用有無 - デフォルト値:`false`
useHighAvailability	Body	Boolean	X	高可用性の使用有無
pingInterval	Body	Number	X	高可用性使用時のPing間隔(秒) - 最小値:`1` - 最大値:`600`
failoverReplWaitingTime	Body	Number	X	高可用性使用時のフェイルオーバー待機時間 - 最小値:`-1` - -1に設定時、複製遅延が解消されるまで待機し続けます。
network	Body	Object	O	ネットワーク情報オブジェクト
network.subnetId	Body	UUID	O	サブネットの識別子
network.usePublicAccess	Body	Boolean	X	外部接続可否 - デフォルト値:`false`
network.availabilityZone	Body	Enum	X	DBインスタンスを作成するアベイラビリティゾーン - 例:`kr-pub-a` - デフォルト値:`任意のアベイラビリティゾーン`
storage	Body	Object	O	ストレージ情報オブジェクト
storage.storageType	Body	Enum	O	データストレージタイプ - 例:`General SSD`
storage.storageSize	Body	Number	O	データストレージサイズ(GB) - 最小値:`20` - 最大値:`2048`
backup	Body	Object	O	バックアップ情報オブジェクト
backup.backupPeriod	Body	Number	O	バックアップ保管期間(日) - 最小値:`0` - 最大値:`730`
backup.backupRetryCount	Body	Number	X	バックアップ再試行回数 - デフォルト値:`0` - 最小値:`0` - 最大値:`10`
backup.backupSchedules	Body	Array	X	バックアップスケジュールリスト
backup.backupSchedules.backupWndBgnTime	Body	String	O	バックアップ開始時間 - 例:`00:00:00`
backup.backupSchedules.backupWndDuration	Body	Enum	O	バックアップWindows バックアップ開始時間から設定された期間内に自動バックアップが実行されます。 - `HALF_AN_HOUR`:30分 - `ONE_HOUR`:1時間 - `ONE_HOUR_AND_HALF`:1時間30分 - `TWO_HOURS`:2時間 - `TWO_HOURS_AND_HALF`:2時間30分 - `THREE_HOURS`:3時間

例

{
    "dbInstanceName": "db-instance",
    "description": "description",
    "dbFlavorId": "71f69bf9-3c01-4c1a-b135-bb75e93f6268",
    "dbVersion": "POSTGRESQL_V17_6",
    "dbPort": 15432,
    "databaseName": "database",
    "dbUserName": "db-user",
    "dbPassword": "password",
    "parameterGroupId": "488bf4f5-d8f7-459b-ace6-529b606c8570",
    "dbSecurityGroupIds": [
        "b0483a3d-e8e2-46f6-9e84-d5e31b0d44f4"
    ],
    "userGroupIds": [],
    "network": {
        "subnetId": "e721a9dd-dad0-4cf0-a53b-dd654ebfc683",
        "availabilityZone": "kr-pub-a"
    },
    "storage": {
        "storageType": "General SSD",
        "storageSize": 20
    },
    "backup": {
        "backupPeriod": 1,
        "backupSchedules": [
            {
                "backupWndBgnTime": "00:00:00",
                "backupWndDuration": "ONE_HOUR_AND_HALF",
                "backupRetryExpireTime": "01:30:00"
            }
        ]
    }
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスを修正する

PUT /v1.0/db-instances/{dbInstanceId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスを修正する

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
dbInstanceName	Body	String	X	DBインスタンスを識別できる名前
description	Body	String	X	DBインスタンスの追加情報
dbPort	Body	Number	X	DBポート - 最小値:`5432` - 最大値:`45432`
dbFlavorId	Body	UUID	X	DBインスタンス仕様の識別子
parameterGroupId	Body	UUID	X	パラメータグループの識別子
dbSecurityGroupIds	Body	Array	X	DBセキュリティグループの識別子リスト
executeBackup	Body	Boolean	X	現時点バックアップを実行するかどうか - デフォルト値:`false`

例

{
    "dbInstanceName": "db-instance2",
    "description": "description2",
    "dbPort": 25432,
    "dbSecurityGroupIds": [],
    "executeBackup": true
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

高可用性情報の照会

GET /v1.0/db-instances/{dbInstanceId}/high-availability

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Get	高可用性情報照会

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
haStatus	Body	Boolean	高可用性状態 - `CREATED`:作成済み - `STABLE`:正常 - `DISABLE_REPLICATION_DELAY`:複製遅延によるフェイルオーバー停止 - `PAUSING`:一時停止中 - `PAUSED`:一時停止 - `PAUSED_DUE_TO_TASK`:作業による一時停止 - `FAILOVER_STARTED`:フェイルオーバー開始 - `FAILOVER_FAILED`:フェイルオーバー失敗 - `FAILOVER_COMPLETED`:フェイルオーバー完了 - `DELETED`:削除済み
pingInterval	Body	Number	高可用性使用時のPing間隔(秒) - 最小値:`1` - 最大値:`600`
failoverReplWaitingTime	Body	Number	高可用性使用時のフェイルオーバー待機時間 - 最小値:`-1` - -1に設定時、複製遅延が解消されるまで待機し続けます。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "useHighAvailability": true,
    "haStatus": "STABLE",
    "pingInterval": 3,
    "failoverReplWaitingTime": 60
}

高可用性を修正する

PUT /v1.0/db-instances/{dbInstanceId}/high-availability

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Modify	高可用性を修正する

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
useHighAvailability	Body	Boolean	O	高可用性の使用有無
pingInterval	Body	Number	X	高可用性使用時のPing間隔(秒) - 最小値:`1` - 最大値:`600`
failoverReplWaitingTime	Body	Number	X	高可用性使用時フェイルオーバー待機時間 - 最小値:`-1` - -1に設定時、複製遅延が解消されるまで待機し続けます。

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

高可用性の再起動

POST /v1.0/db-instances/{dbInstanceId}/high-availability/resume

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Resume	高可用性の再起動

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

高可用性の一時停止

POST /v1.0/db-instances/{dbInstanceId}/high-availability/pause

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Pause	高可用性の一時停止

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

高可用性の復旧

POST /v1.0/db-instances/{dbInstanceId}/high-availability/repair

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Repair	高可用性の復旧

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

高可用性の分離

POST /v1.0/db-instances/{dbInstanceId}/high-availability/split

必要権限

権限名	説明
RDSforPostgreSQL:HighAvailability.Split	高可用性の分離

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスストレージ情報の照会

GET /v1.0/db-instances/{dbInstanceId}/storage-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
storageType	Body	Enum	データストレージタイプ
storageSize	Body	Number	データストレージサイズ(GB)
storageStatus	Body	Enum	データストレージの現在状態 - `DETACHED`:デタッチ - `ATTACHED`:アタッチ - `DELETED`:削除済み

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "storageType": "General SSD",
    "storageSize": 20,
    "storageStatus": "ATTACHED"
}

DBインスタンスストレージ情報の修正

PUT /v1.0/db-instances/{dbInstanceId}/storage-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
storageSize	Body	Number	O	データストレージサイズ(GB) - 最小値:現在値 - 最大値:`2048`

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスネットワーク情報の照会

GET /v1.0/db-instances/{dbInstanceId}/network-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
availabilityZone	Body	Enum	DBインスタンスを作成するアベイラビリティゾーン
subnet	Body	Object	サブネットオブジェクト
subnet.subnetId	Body	UUID	サブネットの識別子
subnet.subnetName	Body	UUID	サブネットを識別できる名前
subnet.subnetCidr	Body	UUID	サブネットのCIDR
subnet.publicAccessible	Body	Boolean	外部接続可否
endPoints	Body	Array	接続情報リスト
endPoints.domain	Body	String	ドメイン
endPoints.ipAddress	Body	String	IPアドレス
endPoints.endPointType	Body	Enum	接続情報タイプ -`EXTERNAL`:外部接続ドメイン -`INTERNAL`:内部接続ドメイン -`PUBLIC`:(Deprecated)外部接続ドメイン -`PRIVATE`:(Deprecated)内部接続ドメイン

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "availabilityZone": "kr-pub-a",
    "subnet": {
        "subnetId": "bd453789-34ae-416c-9f78-05b9e43a46be",
        "subnetName": "Default Network",
        "subnetCidr": "192.168.0.0/16",
        "publicAccessible": true
    },
    "endPoints": [
        {
            "domain": "ea548a78-d85f-43b4-8ddf-c88d999b9905.internal.kr1.postgres.rds.nhncloudservice.com",
            "ipAddress": "192.168.0.2",
            "endPointType": "INTERNAL"
        }
    ]
}

DBインスタンスネットワーク情報の修正

PUT /v1.0/db-instances/{dbInstanceId}/network-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
usePublicAccess	Body	Boolean	O	外部接続可否

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスバックアップ情報の照会

GET /v1.0/db-instances/{dbInstanceId}/backup-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
backupPeriod	Body	Number	バックアップの保管期間(日)
backupRetryCount	Body	Number	バックアップの再試行回数
backupSchedules	Body	Array	バックアップスケジュールリスト
backupSchedules.backupWndBgnTime	Body	String	バックアップ開始時間
backupSchedules.backupWndDuration	Body	Enum	バックアップWindows バックアップ開始時間から設定された期間内に自動バックアップが実行されます。 - `HALF_AN_HOUR`:30分 - `ONE_HOUR`:1時間 - `ONE_HOUR_AND_HALF`:1時間30分 - `TWO_HOURS`:2時間 - `TWO_HOURS_AND_HALF`:2時間30分 - `THREE_HOURS`:3時間

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "backupPeriod": 1,
    "backupRetryCount": 0,
    "backupSchedules": [
        {
            "backupWndBgnTime": "00:00:00",
            "backupWndDuration": "ONE_HOUR_AND_HALF",
            "backupRetryExpireTime": "01:30:00"
        }
    ]
}

DBインスタンスバックアップ情報の修正

PUT /v1.0/db-instances/{dbInstanceId}/backup-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
backupPeriod	Body	Number	X	バックアップの保管期間(日) - 最小値:`0` - 最大値:`730`
backupRetryCount	Body	Number	X	バックアップの再試行回数 - 最小値:`0` - 最大値:`10`
backupSchedules	Body	Array	X	バックアップスケジュールリスト
backupSchedules.backupWndBgnTime	Body	String	O	バックアップ開始時間 - 例:`00:00:00`
backupSchedules.backupWndDuration	Body	Enum	O	バックアップWindows バックアップ開始時間から設定された期間内に自動バックアップが実行されます。 - `HALF_AN_HOUR`:30分 - `ONE_HOUR`:1時間 - `ONE_HOUR_AND_HALF`:1時間30分 - `TWO_HOURS`:2時間 - `TWO_HOURS_AND_HALF`:2時間30分 - `THREE_HOURS`:3時間

例

{
    "backupPeriod": 5,
    "backupSchedules": [
        {
            "backupWndBgnTime": "01:00:00",
            "backupWndDuration": "TWO_HOURS",
            "backupRetryExpireTime": "03:00:00"
        }
    ]
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス復元情報の照会

GET /v1.0/db-instances/{dbInstanceId}/restoration-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細を表示

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
oldestRestorableYmdt	Body	DateTime	最も古い復元可能時間
latestRestorableYmdt	Body	DateTime	最も最新の復元可能時間
restorableBackups	Body	Array	復元可能なバックアップリスト
restorableBackups.backup	Body	Object	バックアップの情報オブジェクト
restorableBackups.backup.backupId	Body	UUID	バックアップの識別子
restorableBackups.backup.backupName	Body	String	バックアップ名
restorableBackups.backup.backupSize	Body	Number	バックアップサイズ
restorableBackups.backup.backupType	Body	Enum	バックアップタイプ - `AUTO`:自動 - `MANUAL`:手動
restorableBackups.backup.backupStatus	Body	Enum	バックアップ状態 - `BACKING_UP`:バックアップ中の場合 - `COMPLETED`:バックアップが完了した場合 - `DELETING`:バックアップが削除中の場合 - `DELETED`:バックアップが削除された場合 - `ERROR`:エラーが発生した場合
restorableBackups.backup.dbInstanceId	Body	UUID	原本DBインスタンスの識別子
restorableBackups.backup.dbInstanceName	Body	String	原本DBインスタンス名
restorableBackups.backup.dbVersion	Body	String	DBバージョン情報
restorableBackups.backup.failoverCount	Body	Number	フェイルオーバー回数
restorableBackups.backup.walFileName	Body	String	WALログファイル名
restorableBackups.backup.createdYmdt	Body	DateTime	バックアップ作成日時
restorableBackups.backup.updatedYmdt	Body	DateTime	バックアップ更新日時
restorableBackups.backup.startYmdt	Body	DateTime	バックアップ開始日時
restorableBackups.backup.completedYmdt	Body	DateTime	バックアップ完了日時

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "oldestRestorableYmdt": "2023-07-09T16:33:33+09:00",
    "latestRestorableYmdt": "2023-07-10T15:44:44+09:00",
    "restorableBackups": [
        {
            "backup": {
                "backupId": "145d889a-fe08-474f-8f58-bde576ff96a9",
                "backupName": "example-backup-name",
                "backupStatus": "COMPLETED",
                "dbInstanceId": "dba1be25-9429-4589-9716-7fb6daad7cb9",
                "dbInstanceName": "original-db-instance-name",
                "dbVersion": "POSTGRESQL_V17_6",
                "backupType": "MANUAL",
                "backupSize": 8299904,
                "walFileName": "000000010000000000000005",
                "createdYmdt": "2023-07-10T15:44:44+09:00",
                "updatedYmdt": "2023-07-10T15:46:07+09:00"
            }
        }
    ]
}

DBインスタンスの復元

GET /v1.0/db-instances/{dbInstanceId}/restore

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Restore	DBインスタンスの復元

共通リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
restore	Body	Object	O	復元情報オブジェクト
restore.restoreType	Body	Enum	O	復元タイプ種類 - `TIMESTAMP`:復元可能時間内の時間を利用した時点復元タイプ - `BACKUP`:既存のバックアップを利用した復元タイプ
dbInstanceName	Body	String	O	DBインスタンスを識別できる名前
description	Body	String	X	DBインスタンスの追加情報
dbFlavorId	Body	UUID	O	DBインスタンス仕様の識別子
dbPort	Body	Number	O	DBポート - 最小値:`3306` - 最大値:`43306`
parameterGroupId	Body	UUID	O	パラメータグループの識別子
dbSecurityGroupIds	Body	Array	X	DBセキュリティグループの識別子リスト
userGroupIds	Body	Array	X	ユーザーグループの識別子リスト
useDefaultNotification	Body	Boolean	X	基本通知の使用有無 - デフォルト値:`false`
useDeletionProtection	Body	Boolean	X	削除保護の有無デフォルト値:`false`
useHighAvailability	Body	Boolean	X	高可用性の使用有無 - デフォルト値:`false`
pingInterval	Body	Number	X	高可用性使用時Ping間隔(秒) - デフォルト値: `3`最小値: `1` - 最大値: `600`
failoverReplWaitingTime	Body	Number	X	高可用性使用時のフェイルオーバー待機時間 - 最小値:`-1` - -1に設定時、複製遅延が解消されるまで待機し続けます。
network	Body	Object	O	ネットワーク情報オブジェクト
network.subnetId	Body	UUID	O	サブネットの識別子
network.usePublicAccess	Body	Boolean	X	外部接続可否 - デフォルト値:`false`
network.availabilityZone	Body	Enum	X	DBインスタンスを作成するアベイラビリティゾーン - 例:`kr-pub-a` - デフォルト値:`任意のアベイラビリティゾーン`
storage	Body	Object	O	ストレージ情報オブジェクト
storage.storageType	Body	Enum	O	データストレージタイプ - 例:`General SSD`
storage.storageSize	Body	Number	O	データストレージサイズ(GB) - 最小値:`20` - 最大値:`2048`
backup	Body	Object	O	バックアップの情報オブジェクト
backup.backupPeriod	Body	Number	O	バックアップの保管期間(日) - 最小値:`0` - 最大値:`730`
backup.backupRetryCount	Body	Number	X	バックアップの再試行回数 - デフォルト値:`0` - 最小値:`0` - 最大値:`10`
backup.backupSchedules	Body	Array	O	バックアップスケジュールリスト
backup.backupSchedules.backupWndBgnTime	Body	String	X	バックアップ開始時刻 - 例:`00:00:00` - デフォルト値:原本DBインスタンス値
backup.backupSchedules.backupWndDuration	Body	Enum	X	バックアップDuration バックアップ開始時刻からDuration内に自動バックアップが実行されます。 - `HALF_AN_HOUR`:30分 - `ONE_HOUR`:1時間 - `ONE_HOUR_AND_HALF`:1時間30分 - `TWO_HOURS`:2時間 - `TWO_HOURS_AND_HALF`:2時間30分 - `THREE_HOURS`:3時間 - デフォルト値:原本DBインスタンス値

Timestampを利用した時点復元時のリクエスト(restoreTypeが`TIMESTAMP`の場合)

名前	種類	形式	必須	説明
restore.restoreYmdt	Body	DateTime	O	DBインスタンス復元時間。(YYYY-MM-DDThh:mm:ss.SSSTZD) 復元情報照会で照会した最も最新の復元可能な時間以前のデータのみ復元が可能

例

{
  "dbInstanceName": "db-instance",
  "description": "description",
  "dbFlavorId": "71f69bf9-3c01-4c1a-b135-bb75e93f6268",
  "dbPort": 10000,
  "dbUserName": "db-user",
  "dbPassword": "password",
  "parameterGroupId": "488bf4f5-d8f7-459b-ace6-529b606c8570",
  "dbSecurityGroupIds": [
    "b0483a3d-e8e2-46f6-9e84-d5e31b0d44f4"
  ],
  "userGroupIds": [],
  "network": {
    "subnetId": "3ae7914f-9b42-4729-b125-87417b72cf36"
  },
  "storage": {
    "storageType": "General SSD",
    "storageSize": 20
  },
  "restore": {
    "restoreType": "TIMESTAMP",
    "restoreYmdt": "2023-07-10T15:44:44+09:00"
  },
  "backup": {
    "backupPeriod": 1,
    "backupSchedules": [
      {
        "backupWndBgnTime": "00:00:00",
        "backupWndDuration": "ONE_HOUR_AND_HALF"
      }
    ]
  }
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス削除保護設定の変更

PUT /v1.0/db-instances/{dbInstanceId}/deletion-protection

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
useDeletionProtection	Body	Boolean	O	削除保護の有無

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

DBインスタンス保守情報照会

GET /v1.0/db-instances/{dbInstanceId}/maintenance-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細表示

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
allowAutoMaintenance	Body	Boolean	自動保守を許可するかどうか
useAutoStorageCleanup	Body	Boolean	自動ストレージクリーンアップを使用するかどうか
maintWndBgnTime	Body	String	自動保守開始時間 - 例: `00:00:00`
maintWndDuration	Body	ENUM	保守Windows 例: `HALF_AN_HOUR`, `ONE_HOUR`, `ONE_HOUR_AND_HALF`, `TWO_HOURS`, `TWO_HOURS_AND_HALF`, `THREE_HOURS`
logRetentionPeriod	Body	Number	ログ保管期間(日)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "allowAutoMaintenance": true,
    "useAutoStorageCleanup": true,
    "maintWndBgnTime": "00:00:00",
    "maintWndDuration": "HALF_AN_HOUR",
    "logRetentionPeriod": 7
}

DBインスタンス保守情報修正

PUT /v1.0/db-instances/{dbInstanceId}/maintenance-info

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスを修正する

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
allowAutoMaintenance	Body	Boolean	X	自動保守を許可するかどうか
useAutoStorageCleanup	Body	Boolean	X	自動ストレージクリーンアップを使用するかどうか
maintWndBgnTime	Body	String	X	自動保守開始時間 - 例: `00:00:00`
maintWndDuration	Body	ENUM	X	保守Windows 例: `HALF_AN_HOUR`, `ONE_HOUR`, `ONE_HOUR_AND_HALF`, `TWO_HOURS`, `TWO_HOURS_AND_HALF`, `THREE_HOURS`
logRetentionPeriod	Body	Number	X	ログ保管期間(日)

例

{
  "allowAutoMaintenance": true,
  "useAutoStorageCleanup": true,
  "logRetentionPeriod": 7
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
  "header": {
    "resultCode": 0,
    "resultMessage": "SUCCESS",
    "isSuccessful": true
  },
  "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

現在のDBインスタンスで選択可能なDBバージョンの照会

GET /v1.0/db-instances/{dbInstanceId}/available-db-versions

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Get	DBインスタンス詳細表示

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
dbVersions	Body	Array	DBバージョンリスト
dbVersions.dbVersion	Body	String	DBバージョン
dbVersions.dbVersionName	Body	String	DBバージョン名
dbVersions.restorableFromObs	Body	Boolean	オブジェクトストレージから復元の可否

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbVersions": [
        {
            "dbVersion": "POSTGRESQL_V17_6",
            "dbVersionName": "PostgreSQL V17.6",
            "restorableFromObs": true
        }
    ]
}

DBインスタンスの削除

DELETE /v1.0/db-instances/{dbInstanceId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Delete	DBインスタンスの削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスの再起動

POST /v1.0/db-instances/{dbInstanceId}/restart

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Restart	DBインスタンスの再起動

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
useOnlineFailover	Body	Boolean	X	フェイルオーバーを利用した再起動の有無高可用性を使用中のDBインスタンスでのみ使用可能です。 - デフォルト値:`false`
executeBackup	Body	Boolean	X	現時点バックアップを実行するかどうか - デフォルト値: `false`

例

{
    "executeBackup": true
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスの強制再起動

POST /v1.0/db-instances/{dbInstanceId}/force-restart

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.ForceRestart	DBインスタンスの強制再起動

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

DBインスタンス開始

POST /v1.0/db-instances/{dbInstanceId}/start

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Start	DBインスタンス開始

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス停止

POST /v1.0/db-instances/{dbInstanceId}/stop

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Stop	DBインスタンスを停止する

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスのバックアップ

POST /v1.0/db-instances/{dbInstanceId}/backup

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Backup	DBインスタンスのバックアップ

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
backupName	Body	String	O	バックアップを識別できる名前

例

{
    "backupName": "backup"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスバックアップ後にエクスポート

POST /v1.0/db-instances/{dbInstanceId}/backup-to-object-storage

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.BackupToObjectStorage	バックアップ後にバックアップファイルをオブジェクトストレージにエクスポート

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
tenantId	Body	String	O	バックアップが保存されるオブジェクトストレージのテナントID
username	Body	String	O	NHN CloudアカウントまたはIAMアカウントID
password	Body	String	O	バックアップが保存されるオブジェクトストレージのAPIパスワード
targetContainer	Body	String	O	バックアップが保存されるオブジェクトストレージのコンテナ
objectPath	Body	String	O	コンテナに保存されるバックアップのパス

例

{
    "tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
    "username": "gildong.hong@nhn.com",
    "password": "password",
    "targetContainer": "/container",
    "objectPath": "/backups/backup_file"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスの最新パラメータグループを適用する

POST /v1.0/db-instances/{dbInstanceId}/apply-recent-parameter-group

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
executeBackup	Body	Boolean	X	現時点バックアップを実行するかどうか - デフォルト値:`false`

例

{
  "executeBackup": true
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスの複製

POST /v1.0/db-instances/{dbInstanceId}/replicate

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Replicate	DBインスタンスの複製

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
dbInstanceName	Body	String	O	DBインスタンスを識別できる名前
description	Body	String	X	DBインスタンスの追加情報
dbFlavorId	Body	UUID	X	DBインスタンス仕様の識別子 - デフォルト値:原本DBインスタンス値
dbPort	Body	Number	X	DBポート - デフォルト値:原本DBインスタンス値 - 最小値:`5432` - 最大値:`45432`
parameterGroupId	Body	UUID	X	パラメータグループの識別子 - デフォルト値:原本DBインスタンス値
dbSecurityGroupIds	Body	Array	X	DBセキュリティグループの識別子リスト - デフォルト値:原本DBインスタンス値
userGroupIds	Body	Array	X	ユーザーグループの識別子リスト
useDefaultNotification	Body	Boolean	X	基本通知の使用有無 - デフォルト値:`false`
useDeletionProtection	Body	Boolean	X	削除保護の有無 - デフォルト値: `false`
network	Body	Object	X	ネットワーク情報オブジェクト
network.usePublicAccess	Body	Boolean	X	外部接続可否 - デフォルト値:`false`
network.availabilityZone	Body	Enum	X	DBインスタンスを作成するアベイラビリティゾーン - 例:`kr-pub-a` - デフォルト値:`任意のアベイラビリティゾーン`
storage	Body	Object	X	ストレージ情報オブジェクト
storage.storageType	Body	Enum	X	データストレージタイプ - 例:`General SSD`
storage.storageSize	Body	Number	X	データストレージサイズ(GB) - デフォルト値:原本DBインスタンス値 - 最小値:`20` - 最大値:`2048`
backup	Body	Object	X	バックアップ情報オブジェクト
backup.backupPeriod	Body	Number	X	バックアップの保管期間(日) - デフォルト値:原本DBインスタンス値 - 最小値:`0` - 最大値:`730`
backup.backupRetryCount	Body	Number	X	バックアップの再試行回数 - デフォルト値:原本DBインスタンス値 - 最小値:`0` - 最大値:`10`

例

{
    "dbInstanceName": "db-instance-replicate",
    "description": "description",
    "dbPort": 15432,
    "storage": {
        "storageSize": 100
    }
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンスの昇格

POST /v1.0/db-instances/{dbInstanceId}/promote

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Promote	DBインスタンスの昇格

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス > データベース

データベースリスト表示

GET /v1.0/db-instances/{dbInstanceId}/databases

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceDatabase.List	DBインスタンス内のデータベースリスト表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
databases	Body	Array	データベースリスト
databases.databaseId	Body	UUID	データベースの識別子
databases.databaseName	Body	String	データベース名
databases.databaseStatus	Body	Enum	データベースの現在状態 - `STABLE`:作成済み - `CREATING`:作成中 - `MODIFYING`:修正中 - `SYNCING`:同期中 - `DELETING`:削除中 - `DELETED`:削除済み
databases.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
databases.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
databases.schemas	Body	Array	データベース内のスキーマリスト
databases.schemas.schemaName	Body	String	スキーマ名

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "databases": [
        {
            "databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
            "databaseName": "database",
            "databaseStatus": "STABLE",
            "createdYmdt": "2023-03-20T13:37:45+09:00",
            "updatedYmdt": "2023-03-20T13:37:45+09:00",
            "schemas": [
                {
                    "schemaName": "rds"
                }
            ]
        }
    ]
}

データベース作成

POST /v1.0/db-instances/{dbInstanceId}/databases

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceDatabase.Create	DBインスタンス内のデータベース作成

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
databaseName	Body	String	O	データベース名

例

{
    "databaseName": "database"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

データベースの修正

PUT /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceDatabase.Modify	DBインスタンス内のデータベース修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
databaseId	URL	UUID	O	データベースの識別子
databaseName	Body	String	O	データベース名
applyHbaRulesImmediately	Body	Boolean	X	関連するアクセス制御ルールを即時適用するかどうか - データベース名変更時、以前のデータベース名で設定されたアクセス制御ルールが存在する場合、変更された名前で反映します。

例

{
    "databaseName": "database-1"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

データベース削除

DELETE /v1.0/db-instances/{dbInstanceId}/databases/{databaseId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceDatabase.Delete	DBインスタンス内のデータベースを削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
databaseId	URL	UUID	O	データベースの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス > ユーザー

ユーザーリスト表示

GET /v1.0/db-instances/{dbInstanceId}/db-users

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceUser.List	DBインスタンス内のユーザーリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
dbUsers	Body	Array	DBユーザーリスト
dbUsers.dbUserId	Body	UUID	DBユーザーの識別子
dbUsers.dbUserName	Body	String	DBユーザーアカウント名
dbUsers.authorityType	Body	Enum	DBユーザー権限タイプ - `CRUD`:DMLクエリ実行可能な権限 - `DDL`:DDLクエリ実行可能な権限
dbUsers.dbUserStatus	Body	Enum	DBユーザーの現在状態 - `STABLE`:作成済み - `CREATING`:作成中 - `MODIFYING`:修正中 - `SYNCING`:同期中 - `DELETING`:削除中 - `DELETED`:削除済み
dbUsers.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbUsers.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "databases": [
        {
            "databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
            "databaseName": "database",
            "databaseStatus": "STABLE",
            "createdYmdt": "2023-03-20T13:37:45+09:00"
        }
    ]
}

ユーザー作成

POST /v1.0/db-instances/{dbInstanceId}/db-users

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceUser.Create	DBインスタンス内のユーザー作成

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
dbUserName	Body	String	O	DBユーザーアカウント名 - 最小文字数:`1` - 最大文字数:`20`
dbPassword	Body	String	O	DBユーザーアカウントパスワード - 最小文字数:`1` - 最大文字数:`100`
authorityType	Body	Enum	O	DBユーザー権限タイプ - `CRUD`:DMLクエリ実行可能な権限 - `DDL`:DDLクエリ実行可能な権限
createDefaultHbaRules	Body	Boolean	X	基本アクセス制御ルールの作成可否
address	Body	String	X	基本アクセス制御ルール作成時に使用する接続アドレス

例

{
    "dbUserName": "db-user",
    "dbPassword": "password",
    "authorityType": "CRUD"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

ユーザー修正

PUT /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceUser.Modify	DBインスタンス内のユーザー修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
dbUserId	URL	UUID	O	DBユーザーの識別子
dbUserName	Body	String	X	DBユーザーアカウント名 - 最小文字数:`1` - 最大文字数:`20`
dbPassword	Body	String	X	DBユーザーアカウントパスワード - 最小文字数:`1` - 最大文字数:`100`
authorityType	Body	Enum	X	DBユーザー権限タイプ - `CRUD`:DMLクエリ実行可能な権限 - `DDL`:DDLクエリ実行可能な権限
applyHbaRulesImmediately	Body	Boolean	X	関連するアクセス制御ルールを即時適用するかどうか - ユーザーアカウント名変更時に以前のユーザーアカウント名で設定されたアクセス制御ルールが存在する場合、変更された名前で反映します。

例

{
    "dbUserName": "db-user-1",
    "dbPassword": "new-password"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

ユーザー削除

DELETE /v1.0/db-instances/{dbInstanceId}/db-users/{dbUserId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceUser.Delete	DBインスタンス内のユーザー削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
dbUserId	URL	UUID	O	DBユーザーの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBインスタンス > アクセス制御

アクセス制御ルールリストを表示

GET /v1.0/db-instances/{dbInstanceId}/hba-rules

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceHba.List	DBインスタンス内のアクセス制御ルールリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
hbaRules	Body	Array	アクセス制御ルールリスト
hbaRules.hbaRuleId	Body	UUID	アクセス制御ルールの識別子
hbaRules.hbaRuleStatus	Body	Enum	アクセス制御ルールの現在状態 - `CREATED`:作成済み - `APPLIED`:適用済み - `CREATING`:作成中 - `MODIFYING`:修正中 - `DELETING`:削除中 - `DELETED`:削除済み
hbaRules.databaseApplyType	Body	String	データベースルールの適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
hbaRules.dbUserApplyType	Body	Enum	DBユーザールールの適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
hbaRules.databases	Body	Array	ユーザー指定のデータベースリスト
hbaRules.databases.databaseId	Body	UUID	ユーザー指定のデータベースの識別子
hbaRules.databases.databaseName	Body	String	ユーザー指定のデータベース名
hbaRules.dbUsers	Body	Array	ユーザー指定のDBユーザーリスト
hbaRules.dbUsers.dbUserId	Body	UUID	ユーザー指定のDBユーザーの識別子
hbaRules.dbUsers.dbUserName	Body	String	ユーザー指定のDBユーザーアカウント名
hbaRules.address	Body	String	接続アドレス
hbaRules.authMethod	Body	Enum	認証方式 - `TRUST`:トラスト(パスワード不要) - `REJECT`:接続ブロック - `SCRAM_SHA_256`:パスワード(SCRAM-SHA-256)
hbaRules.reservedAction	Body	Enum	予約作業 - `NONE`:なし - `CREATE`:作成予約(適用必要) - `MODIFY`:修正予約(適用必要) - `DELETE`:削除予約(適用必要)
hbaRules.order	Body	Number	適用順序
hbaRules.applicable	Body	Boolean	適用可否 - 適用不可状態のルールは無視される
needToApply	Body	Boolean	変更内容の適用が必要かどうか

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "hbaRules": [
        {
            "hbaRuleId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
            "hbaRuleStatus": "APPLIED",
            "databaseApplyType": "USER_CUSTOM",
            "dbUserApplyType": "ENTIRE",
            "databases": [
                {
                    "databaseId": "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4",
                    "databaseName": "database"
                }
            ],
            "dbUsers": [],
            "address": "0.0.0.0/0",
            "authMethod": "TRUST",
            "reservedAction": "NONE",
            "order": 0,
            "applicable": true
        }
    ]
}

アクセス制御ルールの追加

POST /v1.0/db-instances/{dbInstanceId}/hba-rules

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceHba.Create	DBインスタンス内のアクセス制御ルール追加

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
databaseApplyType	Body	String	O	データベースルール適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
dbUserApplyType	Body	Enum	O	DBユーザールール適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
databaseIds	Body	Array	X	ユーザー指定のデータベースの識別子リスト
dbUserIds	Body	Array	X	ユーザー指定のDBユーザーの識別子リスト
address	Body	String	O	接続アドレス - CIDR形式、ホスト名またはドメイン形式で入力
authMethod	Body	Enum	O	認証方式 - `TRUST`:トラスト(パスワード不要) - `REJECT`:接続ブロック - `SCRAM_SHA_256`:パスワード(SCRAM-SHA-256)

例

{
    "databaseApplyType": "ENTIRE",
    "dbUserApplyType": "USER_CUSTOM",
    "databaseIds": [], 
    "dbUserIds": [
        "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
    ],
    "address": "0.0.0.0/0",
    "authMethod": "TRUST"
}

レスポンス

名前	種類	形式	説明
hbaRuleId	Body	UUID	アクセス制御ルールの識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "hbaRuleId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

アクセス制御ルールの修正

PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceHba.Modify	DBインスタンス内のアクセス制御ルール修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
hbaRuleId	URL	UUID	O	アクセス制御ルールの識別子
databaseApplyType	Body	String	O	データベースルールの適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
dbUserApplyType	Body	Enum	O	DBユーザールールの適用方式 - `ENTIRE`:全体 - `USER_CUSTOM`:ユーザー指定
databaseIds	Body	Array	X	ユーザー指定のデータベースの識別子リスト
dbUserIds	Body	Array	X	ユーザー指定のDBユーザーの識別子リスト
address	Body	String	O	接続アドレス - CIDR形式、ホスト名またはドメイン形式で入力
authMethod	Body	Enum	O	認証方式 - `TRUST`:トラスト(パスワード不要) - `REJECT`:接続ブロック - `SCRAM_SHA_256`:パスワード(SCRAM-SHA-256)

例

{
    "databaseApplyType": "ENTIRE",
    "dbUserApplyType": "ENTIRE",
    "databaseIds": [], 
    "dbUserIds": [],
    "address": "0.0.0.0/0",
    "authMethod": "REJECT"
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

アクセス制御ルールの削除

DELETE /v1.0/db-instances/{dbInstanceId}/hba-rules/{hbaRuleId}

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceHba.Delete	DBインスタンス内のアクセス制御ルール削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
hbaRuleId	URL	UUID	O	アクセス制御ルールの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

アクセス制御ルールの順序調整

PUT /v1.0/db-instances/{dbInstanceId}/hba-rules/orders

必要権限

権限名	説明
RDSforPostgreSQL:DbInstanceHba.Modify	DBインスタンス内のアクセス制御ルール修正

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子
hbaRuleIds	URL	Body	O	アクセス制御ルールの識別子リスト - リクエストした順序どおりに調整

例

{
    "hbaRuleIds": [
        "7c9a94b8-86c1-435d-8af2-82a5e9d53fd4"
    ]
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

アクセス制御ルールを適用

POST /v1.0/db-instances/{dbInstanceId}/hba-rules/apply

必要権限

権限名	説明
RDSforPostgreSQL:DbInstance.Modify	DBインスタンスの修正

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbInstanceId	URL	UUID	O	DBインスタンスの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

バックアップ

バックアップリスト照会

GET /v1.0/backups

必要権限

権限名	説明
RDSforPostgreSQL:Backup.List	バックアップリスト照会

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
page	Query	Number	O	照会するリストのページ - 最小値:`1`
size	Query	Number	O	照会するリストのページサイズ - 最小値:`1` - 最大値:`100`
backupType	Query	Enum	X	バックアップタイプ - `AUTO`:自動 - `MANUAL`: 手動 - デフォルト値:`全体`
dbInstanceId	Query	UUID	X	原本DBインスタンスの識別子
dbVersion	Query	Enum	X	DBバージョン情報

レスポンス

名前	種類	形式	説明
totalCounts	Body	Number	全体バックアップリスト数
backups	Body	Array	バックアップリスト
backups.backupId	Body	UUID	バックアップの識別子
backups.backupName	Body	String	バックアップを識別できる名前
backups.backupStatus	Body	Enum	バックアップの現在状態 - `BACKING_UP`:バックアップ中の場合 - `COMPLETED`:バックアップが完了した場合 - `DELETING`:バックアップが削除中の場合 - `DELETED`:バックアップが削除された場合 - `ERROR`:エラーが発生した場合
backups.dbInstanceId	Body	UUID	原本DBインスタンスの識別子
backups.dbVersion	Body	Enum	DBバージョン情報
backups.backupType	Body	Enum	バックアップタイプ - `AUTO`:自動 - `MANUAL`: 手動
backups.backupSize	Body	Number	バックアップのサイズ - 単位:`バイト`
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
completedYmdt	Body	DateTime	完了日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "totalCounts": 1,
    "backups": [
        {
            "backupId": "0017f136-3e01-4530-94aa-20661afe6632",
            "backupName": "backup",
            "backupStatus": "COMPLETED",
            "dbInstanceId": "142e6ccc-3bfb-4e1e-84f7-38861284fafd",
            "dbVersion": "POSTGRESQL_V17_6",
            "backupType": "AUTO",
            "backupSize": 4996786,
            "createdYmdt": "2023-02-21T00:35:00+09:00",
            "updatedYmdt": "2023-02-22T00:35:32+09:00",
            "completedYmdt": "2023-02-22T00:35:32+09:00"
        }
    ]
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

オブジェクトストレージにバックアップをエクスポート

POST /v1.0/backups/{backupId}/export

必要権限

権限名	説明
RDSforPostgreSQL:Backup.Export	オブジェクトストレージにバックアップをエクスポート

リクエスト

名前	種類	形式	必須	説明
backupId	URL	UUID	O	バックアップの識別子
tenantId	Body	String	O	バックアップが保存されるオブジェクトストレージのテナントID
username	Body	String	O	NHN CloudアカウントまたはIAMアカウントID
password	Body	String	O	バックアップが保存されるオブジェクトストレージのAPIパスワード
targetContainer	Body	String	O	バックアップが保存されるオブジェクトストレージのコンテナ
objectPath	Body	String	O	コンテナに保存されるバックアップのパス

例

{
    "tenantId": "399631c404744dbbb18ce4fa2dc71a5a",
    "username": "gildong.hong@nhn.com",
    "password": "password",
    "targetContainer": "/container",
    "objectPath": "/backups/backup_file"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

バックアップの復元

POST /v1.0/backups/{backupId}/restore

必要権限

権限名	説明
RDSforPostgreSQL:Backup.Restore	バックアップの復元

リクエスト

名前	種類	形式	必須	説明
backupId	URL	UUID	O	バックアップの識別子
dbInstanceName	Body	String	O	DBインスタンスを識別できる名前
description	Body	String	X	DBインスタンスの追加情報
dbFlavorId	Body	UUID	O	DBインスタンス仕様の識別子
dbPort	Body	Number	O	DBポート - 最小値:`5432` - 最大値:`45432`
parameterGroupId	Body	UUID	O	パラメータグループの識別子
dbSecurityGroupIds	Body	Array	X	DBセキュリティグループの識別子リスト
userGroupIds	Body	Array	X	ユーザーグループの識別子リスト
useDefaultNotification	Body	Boolean	X	基本通知の使用有無 - デフォルト値:`false`
useDeletionProtection	Body	Boolean	X	削除保護の有無 - デフォルト値:`false`
useHighAvailability	Body	Boolean	X	高可用性の使用有無
pingInterval	Body	Number	X	高可用性使用時のPing間隔(秒) - 最小値:`1` - 最大値:`600`
failoverReplWaitingTime	Body	Number	X	高可用性使用時のフェイルオーバー待機時間 - 最小値:`-1` - -1に設定時、複製遅延が解消されるまで待機し続けます。
network	Body	Object	O	ネットワーク情報オブジェクト
network.subnetId	Body	UUID	O	サブネットの識別子
network.usePublicAccess	Body	Boolean	X	外部接続可否 - デフォルト値:`false`
network.availabilityZone	Body	Enum	X	DBインスタンスを作成するアベイラビリティゾーン - 例:`kr-pub-a` - デフォルト値:`任意のアベイラビリティゾーン`
storage	Body	Object	O	ストレージ情報オブジェクト
storage.storageType	Body	Enum	O	データストレージタイプ - 例:`General SSD`
storage.storageSize	Body	Number	O	データストレージサイズ - 単位: `ギガバイト` - 最小値:`20` - 最大値:`2048`
backup	Body	Object	O	バックアップ情報オブジェクト
backup.backupPeriod	Body	Number	O	バックアップの保管期間(日) - 最小値:`0` - 最大値:`730`
backup.backupRetryCount	Body	Number	X	バックアップの再試行回数 - デフォルト値:`0` - 最小値:`0` - 最大値:`10`
backup.backupSchedules	Body	Array	X	バックアップスケジュールリスト
backup.backupSchedules.backupWndBgnTime	Body	String	O	バックアップ開始時間 - 例:`00:00:00`
backup.backupSchedules.backupWndDuration	Body	Enum	O	バックアップDuration バックアップ開始時間から設定された期間内に自動バックアップが実行されます。 - `HALF_AN_HOUR`:30分 - `ONE_HOUR`:1時間 - `ONE_HOUR_AND_HALF`:1時間30分 - `TWO_HOURS`:2時間 - `TWO_HOURS_AND_HALF`:2時間30分 - `THREE_HOURS`:3時間

例


{
  "dbInstanceName": "db-instance-restore",
  "dbFlavorId": "50be6d9c-02d6-4594-a2d4-12010eb65ec0",
  "dbPort": 15432,
  "parameterGroupId": "132d383c-38e3-468a-a826-5e9a8fff15d0",
  "network": {
    "subnetId": "e721a9dd-dad0-4cf0-a53b-dd654ebfc683"
  },
  "storage": {
    "storageType": "General SSD",
    "storageSize": 20
  },
  "backup": {
    "backupPeriod": 1,
    "backupSchedules": [
      {
        "backupWndBgnTime": "00:00:00",
        "backupWndDuration": "HALF_AN_HOUR",
        "backupRetryExpireTime": "00:30:00"
      }
    ]
  }
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

バックアップ削除

DELETE /v1.0/backups/{backupId}

必要権限

権限名	説明
RDSforPostgreSQL:Backup.Delete	バックアップ削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
backupId	URL	UUID	O	バックアップの識別子

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBセキュリティグループ

DBセキュリティグループリストを表示

GET /v1.0/db-security-groups

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroup.List	DBセキュリティグループリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
dbSecurityGroups	Body	Array	DBセキュリティグループリスト
dbSecurityGroups.dbSecurityGroupId	Body	UUID	DBセキュリティグループの識別子
dbSecurityGroups.dbSecurityGroupName	Body	String	DBセキュリティグループを識別できる名前
dbSecurityGroups.dbSecurityGroupStatus	Body	Enum	DBセキュリティグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
dbSecurityGroups.description	Body	String	DBセキュリティグループの追加情報
dbSecurityGroups.progressStatus	Body	Enum	DBセキュリティグループの現在の進行状態 - `NONE`:進行中の作業なし - `CREATING_RULE`:ルールポリシー作成中 - `UPDATING_RULE`:ルールポリシー修正中 - `DELETING_RULE`:ルールポリシー削除中 - `APPLYING_DEFAULT_RULE`:基本ルール適用中
dbSecurityGroups.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
dbSecurityGroups.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbSecurityGroups": [
        {
            "dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708",
            "dbSecurityGroupName": "dbSecurityGroup",
            "dbSecurityGroupStatus": "CREATED",
            "description": "description",
            "progressStatus": "NONE",
            "createdYmdt": "2023-02-19T19:18:13+09:00",
            "updatedYmdt": "2022-02-19T19:18:13+09:00"
        }
    ]
}

DBセキュリティグループ詳細を表示

GET /v1.0/db-security-groups/{dbSecurityGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroup.Get	DBセキュリティグループ詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子

レスポンス

名前	種類	形式	説明
dbSecurityGroupId	Body	UUID	DBセキュリティグループの識別子
dbSecurityGroupName	Body	String	DBセキュリティグループを識別できる名前
dbSecurityGroupStatus	Body	Enum	DBセキュリティグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
description	Body	String	DBセキュリティグループの追加情報
progressStatus	Body	Enum	DBセキュリティグループの現在の進行状態 - `NONE`:進行中の作業なし - `CREATING_RULE`:ルールポリシー作成中 - `UPDATING_RULE`:ルールポリシー修正中 - `DELETING_RULE`:ルールポリシー削除中 - `APPLYING_DEFAULT_RULE`:基本ルール適用中
rules	Body	Array	DBセキュリティグループルールリスト
rules.ruleId	Body	UUID	DBセキュリティグループルールの識別子
rules.description	Body	String	DBセキュリティグループルールの追加情報
rules.direction	Body	Enum	通信方向 - `INGRESS`:受信 - `EGRESS`:送信
rules.etherType	Body	Enum	Etherタイプ - `IPV4`: IPv4 - `IPV6`: IPv6
rules.port	Body	Object	ポートオブジェクト
rules.port.portType	Body	Enum	ポートタイプ - `DB_PORT`:各DBインスタンスポート値で設定されます。 - `PORT`:指定されたポート値で設定されます。 - `PORT_RANGE`:指定されたポート範囲で設定されます。
rules.port.minPort	Body	Number	最小ポート範囲
rules.port.maxPort	Body	Number	最大ポート範囲
rules.cidr	Body	String	許可するトラフィックの遠隔ソース
rules.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
rules.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbSecurityGroup": {
        "dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708",
        "dbSecurityGroupName": "dbSecurityGroup",
        "dbSecurityGroupStatus": "CREATED",
        "description": "description",
        "progressStatus": "NONE",
        "rules": [
            {
                "ruleId": "17c88ef6-95f1-4678-84f9-fee1b22e250d",
                "description": "description",
                "direction": "INGRESS",
                "etherType": "IPV4",
                "port": {
                    "portType": "PORT_RANGE",
                    "minPort": 10000,
                    "maxPort": 10005
                },
                "cidr": "0.0.0.0/0",
                "createdYmdt": "2023-02-19T19:18:13+09:00",
                "updatedYmdt": "2023-02-19T19:18:13+09:00"
            }
        ],
        "createdYmdt": "2023-02-19T19:18:13+09:00",
        "updatedYmdt": "2023-02-19T19:18:13+09:00"
    }
}

DBセキュリティグループの作成

POST /v1.0/db-security-groups

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroup.Create	DBセキュリティグループ作成

リクエスト

名前	種類	形式	必須	説明
dbSecurityGroupName	Body	String	O	DBセキュリティグループを識別できる名前
description	Body	String	X	DBセキュリティグループの追加情報
rules	Body	Array	O	DBセキュリティグループルールリスト
rules.description	Body	String	X	DBセキュリティグループルールの追加情報
rules.direction	Body	Enum	O	通信方向 - `INGRESS`:受信 - `EGRESS`:送信
rules.etherType	Body	Enum	O	Etherタイプ - `IPV4`: IPv4 - `IPV6`: IPv6
rules.cidr	Body	String	O	許可するトラフィックの遠隔ソース - 例:`1.1.1.1/32`
rules.port	Body	Object	O	ポートオブジェクト
rules.port.portType	Body	Enum	O	ポートタイプ - `DB_PORT`:各DBインスタンスポート値で設定されます。`minPort`値と`maxPort`値を必要としません。 - `PORT`:指定されたポート値で設定されます。`minPort`値と`maxPort`値が同じである必要があります。 - `PORT_RANGE`:指定されたポート範囲で設定されます。
rules.port.minPort	Body	Number	X	最小ポート範囲 - 受信最小値:5432 - 送信最小値:1
rules.port.maxPort	Body	Number	X	最大ポート範囲 - 受信最大値:45432 - 送信最大値:65535

例

{
    "dbSecurityGroupName": "dbSecurityGroup",
    "description": "description",
    "rules": [
        {
            "direction": "INGRESS",
            "etherType": "IPV4",
            "port": {
                "portType": "PORT_RANGE",
                "minPort": 10000,
                "maxPort": 10005
            },
            "cidr": "0.0.0.0/0"
        }
    ]
}

レスポンス

名前	種類	形式	説明
dbSecurityGroupId	Body	UUID	DBセキュリティグループの識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "dbSecurityGroupId": "fe4f2aee-afbb-4c19-a5e9-eb2eab394708"
}

DBセキュリティグループの修正

PUT /v1.0/db-security-groups/{dbSecurityGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroup.Modify	DBセキュリティグループの修正

リクエスト

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子
dbSecurityGroupName	Body	String	X	DBセキュリティグループを識別できる名前
description	Body	String	X	DBセキュリティグループの追加情報

例

{
    "dbSecurityGroupName": "dbSecurityGroup",
    "description": "description"
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

DBセキュリティグループの削除

DELETE /v1.0/db-security-groups/{dbSecurityGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroup.Delete	DBセキュリティグループの削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

DBセキュリティグループルールの作成

POST /v1.0/db-security-groups/{dbSecurityGroupId}/rules

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroupRule.Create	DBセキュリティグループルールの作成

リクエスト

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子
description	Body	String	X	DBセキュリティグループルールの追加情報
direction	Body	Enum	O	通信方向 - `INGRESS`:受信 - `EGRESS`:送信
etherType	Body	Enum	O	Etherタイプ - `IPV4`: IPv4 - `IPV6`: IPv6
port	Body	Object	O	ポートオブジェクト
port.portType	Body	Enum	O	ポートタイプ - `DB_PORT`:各DBインスタンスポート値で設定されます。`minPort`値と`maxPort`値を必要としません。 - `PORT`:指定されたポート値で設定されます。`minPort`値と`maxPort`値が同じである必要があります。 - `PORT_RANGE`:指定されたポート範囲で設定されます。
port.minPort	Body	Number	X	最小ポート範囲 - 受信最小値:5432 - 送信最小値:1
port.maxPort	Body	Number	X	最大ポート範囲 - 受信最大値:45432 - 送信最大値:65535
cidr	Body	String	O	許可するトラフィックの遠隔ソース - 例:`1.1.1.1/32`

例

{
    "direction": "INGRESS",
    "etherType": "IPV4",
    "port": {
        "portType": "PORT",
        "minPort": 10000,
        "maxPort": 10000
    },
    "cidr": "0.0.0.0/0"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBセキュリティグループルールの修正

PUT /v1.0/db-security-groups/{dbSecurityGroupId}/rules/{ruleId}

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroupRule.Modify	DBセキュリティグループルールの修正

リクエスト

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子
ruleId	URL	UUID	O	DBセキュリティグループルールの識別子
description	Body	String	X	DBセキュリティグループルールの追加情報
direction	Body	Enum	O	通信方向 - `INGRESS`:受信 - `EGRESS`:送信
etherType	Body	Enum	O	Etherタイプ - `IPV4`: IPv4 - `IPV6`: IPv6
port	Body	Object	O	ポートオブジェクト
port.portType	Body	Enum	O	ポートタイプ - `DB_PORT`:各DBインスタンスポート値で設定されます。`minPort`値と`maxPort`値を必要としません。 - `PORT`:指定されたポート値で設定されます。`minPort`値と`maxPort`値が同じである必要があります。 - `PORT_RANGE`:指定されたポート範囲で設定されます。
port.minPort	Body	Number	X	最小ポート範囲 - 受信最小値:5432 - 送信最小値:1
port.maxPort	Body	Number	X	最大ポート範囲 - 受信最大値:45432 - 送信最大値:65535
cidr	Body	String	O	許可するトラフィックの遠隔ソース - 例:`1.1.1.1/32`

例

{
    "direction": "INGRESS",
    "etherType": "IPV4",
    "port": {
        "portType": "DB_PORT"
    },
    "cidr": "0.0.0.0/0"
}

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

DBセキュリティグループルールの削除

DELETE /v1.0/db-security-groups/{dbSecurityGroupId}/rules

必要権限

権限名	説明
RDSforPostgreSQL:DbSecurityGroupRule.Create	DBセキュリティグループルールの削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbSecurityGroupId	URL	UUID	O	DBセキュリティグループの識別子
ruleIds	Query	Array	O	DBセキュリティグループルールの識別子リスト

レスポンス

名前	種類	形式	説明
jobId	Body	UUID	リクエストした作業の識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "jobId": "0ddb042c-5af6-43fb-a914-f4dd0540eb7c"
}

パラメータグループ

パラメータグループリストを表示

GET /v1.0/parameter-groups

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.List	パラメータグループリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
dbVersion	Query	Enum	X	DBバージョン情報

レスポンス

名前	種類	形式	説明
parameterGroups	Body	Array	パラメータグループリスト
parameterGroups.parameterGroupId	Body	UUID	パラメータグループの識別子
parameterGroups.parameterGroupName	Body	String	パラメータグループを識別できる名前
parameterGroups.parameterGroupStatus	Body	Enum	パラメータグループの現在状態 - `STABLE`:適用完了 - `NEED_TO_APPLY`:適用必要
parameterGroups.description	Body	String	パラメータグループの追加情報
parameterGroups.dbVersion	Body	Enum	DBバージョン情報
parameterGroups.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
parameterGroups.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroups": [
        {
            "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7",
            "parameterGroupName": "parameter-group",
            "parameterGroupStatus": "STABLE",
            "description": null,
            "dbVersion": "POSTGRESQL_V17_6",
            "createdYmdt": "2023-02-31T15:28:17+09:00",
            "updatedYmdt": "2023-02-31T15:28:17+09:00"
        }
    ]
}

パラメータグループ詳細を表示

GET /v1.0/parameter-groups/{parameterGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Get	パラメータグループ詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子

レスポンス

名前	種類	形式	説明
parameterGroupId	Body	UUID	パラメータグループの識別子
parameterGroupName	Body	String	パラメータグループを識別できる名前
description	Body	String	パラメータグループの追加情報
dbVersion	Body	Enum	DBバージョン情報
parameterGroupStatus	Body	Enum	パラメータグループの現在状態 - `STABLE`:適用完了 - `NEED_TO_APPLY`:適用必要 - `DELETED`:削除済み
parameters	Body	Array	パラメータリスト
parameters.parameterCategory	Body	String	パラメータカテゴリー
parameters.parameterName	Body	String	パラメータ名
parameters.value	Body	String	現在設定されている値
parameters.valueUnit	Body	Enum	現在設定されている値の単位 - `B`:バイト - `kB`:キロバイト - `MB`:メガバイト - `GB`:ギガバイト - `TB`:テラバイト - `us`:マイクロ秒 - `ms`:ミリ秒 - `s`:秒 - `min`:分 - `h`:時間 - `d`:日
parameters.defaultValue	Body	String	デフォルト値
parameters.allowedValue	Body	String	許可された値
parameters.valueType	Body	Enum	値タイプ - `BOOLEAN`:ブーリアンタイプ - `STRING`:文字列タイプ - `NUMERIC`:整数および浮動小数点タイプ - `NUMERIC_WITH_BYTE_UNIT`:バイト単位の数字タイプ(例：120KB、100MB) - `NUMERIC_WITH_TIME_UNIT`:時間単位の数字タイプ(例：120ms、100s、1d) - `ENUMERATED`:許可された値に宣言された値の中から1つを入力 - `MULTI_ENUMERATED`:許可された値に宣言された値の中から複数個を入力(コンマ(,)で区分される) - `TIMEZONE`:タイムゾーンタイプ
parameters.updateType	Body	Enum	修正タイプ - `VARIABLE`:常に修正可能 - `CONSTANT`:修正不可能
parameters.applyType	Body	Enum	適用タイプ - `SESSION`:セッション適用 - `FILE`:設定ファイル適用(再起動必要) - `BOTH`:全体
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
expressionAvailable	Body	Boolean	数式の使用可否

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7",
    "parameterGroupName": "parameter-group",
    "description": null,
    "dbVersion": "POSTGRESQL_V17_6",
    "parameterGroupStatus": "STABLE",
    "parameters": [
        {
            "parameterCategory": "Write-Ahead Log / Checkpoints",
            "parameterName": "checkpoint_timeout",
            "value": "300s",
            "defaultValue": "300s",
            "allowedValue": "30~86400s",
            "valueType": "NUMERIC_WITH_TIME_UNIT",
            "updateType": "VARIABLE",
            "applyType": "BOTH",
            "expressionAvailable": true
        }
    ],
    "createdYmdt": "2023-03-13T11:02:28+09:00",
    "updatedYmdt": "2023-03-13T11:02:28+09:00"
}

パラメータグループの作成

POST /v1.0/parameter-groups

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Create	パラメータグループの作成

リクエスト

名前	種類	形式	必須	説明
parameterGroupName	Body	String	O	パラメータグループを識別できる名前
description	Body	String	X	パラメータグループの追加情報
dbVersion	Body	Enum	O	DBバージョン情報

例

{
    "parameterGroupName": "parameter-group",
    "description": "description",
    "dbVersion": "POSTGRESQL_V17_6"
}

レスポンス

名前	種類	形式	説明
parameterGroupId	Body	UUID	パラメータグループの識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}

パラメータグループのコピー

POST /v1.0/parameter-groups/{parameterGroupId}/copy

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Copy	パラメータグループのコピー

リクエスト

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子
parameterGroupName	Body	String	O	パラメータグループを識別できる名前
description	Body	String	X	パラメータグループの追加情報

例

{
    "parameterGroupName": "parameter-group-copy",
    "description": "copy"
}

レスポンス

名前	種類	形式	説明
parameterGroupId	Body	UUID	パラメータグループの識別子

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "parameterGroupId": "404e8a89-ca4d-4fca-96c2-1518754d50b7"
}

パラメータグループの修正

PUT /v1.0/parameter-groups/{parameterGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Modify	パラメータグループの修正

リクエスト

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子
parameterGroupName	Body	String	X	パラメータグループを識別できる名前
description	Body	String	X	パラメータグループの追加情報

例

{
    "parameterGroupName": "parameter-group",
    "description": "description"
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

パラメータ修正

PUT /v1.0/parameter-groups/{parameterGroupId}/parameters

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Modify	パラメータグループの修正

リクエスト

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子
modifiedParameters	Body	Array	O	変更するパラメータリスト
modifiedParameters.parameterName	Body	UUID	O	パラメータ名
modifiedParameters.value	Body	String	O	変更するパラメータ値

例

{
   "modifiedParameters": [
       {
           "parameterName": "checkpoint_timeout",
           "value": "100s"
       }
   ]
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

パラメータグループの再設定

PUT /v1.0/parameter-groups/{parameterGroupId}/reset

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Reset	パラメータグループの再設定

リクエスト

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

パラメータグループの削除

DELETE /v1.0/parameter-groups/{parameterGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:ParameterGroup.Delete	パラメータグループの削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
parameterGroupId	URL	UUID	O	パラメータグループの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

ユーザーグループ

ユーザーグループリストを表示

GET /v1.0/user-groups

必要権限

権限名	説明
RDSforPostgreSQL:UserGroup.List	ユーザーグループリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
userGroups	Body	Array	ユーザーグループリスト
userGroups.userGroupId	Body	UUID	ユーザーグループの識別子
userGroups.userGroupName	Body	String	ユーザーグループを識別できる名前
userGroupStatus	Body	Enum	ユーザーグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
userGroups.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
userGroups.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "userGroups": [
        {
            "userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
            "userGroupName": "dev-team",
            "userGroupStatus": "CREATED",
            "createdYmdt": "2023-02-23T10:07:54+09:00",
            "updatedYmdt": "2023-02-26T01:15:50+09:00"
        }
    ]
}

ユーザーグループ詳細を表示

GET /v1.0/user-groups/{userGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:UserGroup.Get	ユーザーグループ詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
userGroupId	URL	UUID	O	ユーザーグループの識別子

レスポンス

名前	種類	形式	説明
userGroupId	Body	UUID	ユーザーグループの識別子
userGroupName	Body	String	ユーザーグループを識別できる名前
userGroupTypeCode	Body	Enum	ユーザーグループ種類 `ENTIRE`:プロジェクトメンバー全体を含むユーザーグループ `INDIVIDUAL_MEMBER`:特定プロジェクトメンバーを含むユーザーグループ
userGroupStatus	Body	Enum	ユーザーグループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
members	Body	Array	プロジェクトメンバーリスト
members.memberId	Body	UUID	プロジェクトメンバーの識別子
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
    "userGroupName": "dev-team",
    "userGroupStatus": "CREATED",
    "userGroupTypeCode": "INDIVIDUAL_MEMBER",
    "members": [
        {
            "memberId": "1321e759-2ef3-4b85-9921-b13e918b24b5"
        }
    ],
    "createdYmdt": "2023-02-23T10:07:54+09:00",
    "updatedYmdt": "2023-02-26T01:15:50+09:00"
}

ユーザーグループの作成

POST /v1.0/user-groups

必要権限

権限名	説明
RDSforPostgreSQL:UserGroup.Create	ユーザーグループの作成

リクエスト

名前	種類	形式	必須	説明
userGroupName	Body	String	O	ユーザーグループを識別できる名前
memberIds	Body	Array	O	プロジェクトメンバーの識別子リスト `selectAllYN`がtrueの場合、該当フィールド値は無視される
selectAllYN	Body	Boolean	X	プロジェクトメンバー全体の有無 trueの場合、該当グループは全メンバーに対して設定される

例

{
    "userGroupName": "dev-team",
    "memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5"]
}

{
    "userGroupName": "dev-team",
    "selectAllYN":true
}

レスポンス

名前	種類	形式	説明
userGroupId	Body	UUID	ユーザーグループの識別子

ユーザーグループの修正

PUT /v1.0/user-groups/{userGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:UserGroup.Modify	ユーザーグループの修正

リクエスト

名前	種類	形式	必須	説明
userGroupId	URL	UUID	O	ユーザーグループの識別子
userGroupName	Body	String	X	ユーザーグループを識別できる名前
memberIds	Body	Array	X	プロジェクトメンバーの識別子リスト
selectAllYN	Body	Boolean	X	プロジェクトメンバー全体の有無 trueの場合、該当グループは全メンバーに対して設定される

例

{
    "userGroupName": "dev-team",
    "memberIds": ["1321e759-2ef3-4b85-9921-b13e918b24b5","f9064b09-2b15-442e-a4b0-3a5a2754555e"]
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

ユーザーグループの削除

DELETE /v1.0/user-groups/{userGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:UserGroup.Delete	ユーザーグループの削除

リクエスト

名前	種類	形式	必須	説明
userGroupId	URL	UUID	O	ユーザーグループの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

通知グループ

通知グループリストを表示

GET /v1.0/notification-groups

必要権限

権限名	説明
RDSforPostgreSQL:NotificationGroup.List	通知グループリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
notificationGroups	Body	Array	通知グループリスト
notificationGroups.notificationGroupId	Body	UUID	通知グループの識別子
notificationGroups.notificationGroupName	Body	String	通知グループを識別できる名前
notificationGroups.notificationGroupStatus	Body	Enum	通知グループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
notificationGroups.notifyEmail	Body	Boolean	メール通知の有無
notificationGroups.notifySms	Body	Boolean	SMS通知の有無
notificationGroups.isEnabled	Body	Boolean	有効かどうか
notificationGroups.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
notificationGroups.updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "notificationGroups": [
        {
            "notificationGroupId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
            "notificationGroupName": "dev-team-noti",
            "notifyEmail": true,
            "notifySms": false,
            "isEnabled": true,
            "createdYmdt": "2023-02-20T13:34:13+09:00",
            "updatedYmdt": "2023-02-20T13:34:13+09:00"
        }
    ]
}

通知グループ詳細を表示

GET /v1.0/notification-groups/{notificationGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:NotificationGroup.Get	通知グループ詳細を表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子

レスポンス

名前	種類	形式	説明
notificationGroupId	Body	UUID	通知グループの識別子
notificationGroupName	Body	String	通知グループを識別できる名前
notificationGroupStatus	Body	Enum	通知グループの現在状態 - `CREATED`:作成済み - `DELETED`:削除済み
notifyEmail	Body	Boolean	メール通知の有無
notifySms	Body	Boolean	SMS通知の有無
isEnabled	Body	Boolean	有効かどうか
dbInstances	Body	Array	監視対象のDBインスタンスリスト
dbInstances.dbInstanceId	Body	UUID	DBインスタンスの識別子
dbInstances.dbInstanceName	Body	String	DBインスタンスを識別できる名前
userGroups	Body	Array	ユーザーグループリスト
userGroups.userGroupId	Body	UUID	ユーザーグループの識別子
userGroups.userGroupName	Body	String	ユーザーグループを識別できる名前
createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
updatedYmdt	Body	DateTime	修正日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "notificationGroupId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
    "notificationGroupName": "dev-team-noti",
    "notifyEmail": true,
    "notifySms": false,
    "isEnabled": true,
    "dbInstances": [
        {
            "dbInstanceId": "ed5cb985-526f-4c54-9ae0-40288593de65",
            "dbInstanceName": "database"
        }
    ],
    "userGroups": [
        {
            "userGroupId": "1aac0437-f32d-4923-ad3c-ac61c1cfdfe0",
            "userGroupName": "dev-team"
        }
    ],
    "createdYmdt": "2023-02-20T13:34:13+09:00",
    "updatedYmdt": "2023-02-20T13:34:13+09:00"
}

通知グループの作成

POST /v1.0/notification-groups

必要権限

権限名	説明
RDSforPostgreSQL:NotificationGroup.Create	通知グループの作成

リクエスト

名前	種類	形式	必須	説明
notificationGroupName	Body	String	O	通知グループを識別できる名前
notifyEmail	Body	Boolean	X	メール通知の有無 - デフォルト値:`true`
notifySms	Body	Boolean	X	SMS通知の有無 - デフォルト値:`true`
isEnabled	Body	Boolean	X	有効かどうか - デフォルト値:`true`
dbInstanceIds	Body	Array	X	監視対象のDBインスタンスの識別子リスト
userGroupIds	Body	Array	X	ユーザーグループの識別子リスト

例

{
    "notificationGroupName": "dev-team-noti",
    "notifyEmail": false,
    "isEnable": true,
    "dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65"],
    "userGroupIds": ["1aac0437-f32d-4923-ad3c-ac61c1cfdfe0"]
}

レスポンス

名前	種類	形式	説明
notificationGroupId	Body	UUID	通知グループの識別子

通知グループの修正

PUT /v1.0/notification-groups/{notificationGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:NotificationGroup.Modify	通知グループの修正

リクエスト

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子
notificationGroupName	Body	String	X	通知グループを識別できる名前
notifyEmail	Body	Boolean	X	メール通知の有無
notifySms	Body	Boolean	X	SMS通知の有無
isEnabled	Body	Boolean	X	有効かどうか
dbInstanceIds	Body	Array	X	監視対象のDBインスタンスの識別子リスト
userGroupIds	Body	Array	X	ユーザーグループの識別子リスト

例

{
    "notifyEmail": true,
    "dbInstanceIds": ["ed5cb985-526f-4c54-9ae0-40288593de65", "d51b7da0-682f-47ff-b588-b739f6adc740"]
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

通知グループの削除

DELETE /v1.0/notification-groups/{notificationGroupId}

必要権限

権限名	説明
RDSforPostgreSQL:NotificationGroup.Delete	通知グループの削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

監視設定リストを表示

GET /v1.0/notification-groups/{notificationGroupId}/watchdogs

必要権限

権限名	説明
RDSforPostgreSQL:NotificationWatchdog.List	監視設定リストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
notificationGroupId	URL	UUID	通知グループの識別子
watchdogs	Body	Array	監視設定リスト
watchdogs.watchdogId	Body	UUID	監視設定の識別子
watchdogs.metricName	Body	Enum	監視対象の性能指標 - 設定可能な性能指標は性能指標リスト表示項目を参照してください。
watchdogs.comparisonOperator	Body	Enum	監視対象の比較方法 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
watchdogs.threshold	Body	Long	監視対象のしきい値
watchdogs.duration	Body	Long	監視対象の持続時間 - 単位:`分`
watchdogs.createdYmdt	Body	DateTime	作成日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "watchdogs": [
        {
            "watchdogId": "b3901f17-9971-4d1e-8a81-8448cf533dc7",
            "metricName": "DATABASE_STATUS",
            "comparisonOperator": "LE",
            "threshold": 0,
            "duration": 5,
            "createdYmdt": "2023-02-20T13:34:13+09:00",
            "updatedYmdt": "2023-02-20T13:34:13+09:00"
        }
    ]
}

監視設定の作成

POST /v1.0/notification-groups/{notificationGroupId}/watchdogs

必要権限

権限名	説明
RDSforPostgreSQL:NotificationWatchdog.Create	監視設定の作成

リクエスト

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子
metricName	Body	Enum	O	監視対象の性能指標 - 設定可能な性能指標は性能指標リスト表示項目を参照してください。
comparisonOperator	Body	Enum	O	監視対象の比較方法 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
threshold	Body	Long	O	監視対象しきい値
duration	Body	Long	O	監視対象持続時間 - 単位:`分`

例

{
    "metricName": "DATABASE_STATUS",
    "comparisonOperator": "LE",
    "threshold": 0,
    "duration": 5
}

レスポンス

名前	種類	形式	説明
watchdogId	Body	UUID	監視設定の識別子

監視設定の修正

PUT /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}

必要権限

権限名	説明
RDSforPostgreSQL:NotificationWatchdog.Modify	監視設定の修正

リクエスト

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子
watchdogId	URL	UUID	O	監視設定の識別子
metricName	Body	Enum	O	監視対象の性能指標 - 設定可能な性能指標は性能指標リスト表示項目を参照してください。
comparisonOperator	Body	Enum	O	監視対象の比較方法 - `LE`: <= - `LT`: < - `GE`: >= - `GT`: >
threshold	Body	Long	O	監視対象のしきい値
duration	Body	Long	O	監視対象の持続時間 - 単位:`分`

例

{
    "metricName": "DATABASE_STATUS",
    "comparisonOperator": "LE",
    "threshold": 0,
    "duration": 10
}

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

監視設定の削除

DELETE /v1.0/notification-groups/{notificationGroupId}/watchdogs/{watchdogId}

必要権限

権限名	説明
RDSforPostgreSQL:NotificationWatchdog.Delete	監視設定の削除

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
notificationGroupId	URL	UUID	O	通知グループの識別子
watchdogId	URL	UUID	O	監視設定の識別子

レスポンス

このAPIはレスポンス本文を返しません。

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    }
}

モニタリング

性能指標リストを表示

GET /v1.0/metrics

必要権限

権限名	説明
RDSforPostgreSQL:Metric.List	統計情報照会

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
metrics	Body	Array	性能指標リスト
metrics.metricName	Body	Enum	性能指標タイプ
metrics.unit	Body	String	測定値単位

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "metrics": [
        {
            "metricName": "CPU_USAGE",
            "unit": "%"
        }
    ]
}

統計情報照会

GET /v1.0/metric-statistics

必要権限

権限名	説明
RDSforPostgreSQL:Metric.List	統計情報照会

リクエスト

名前	種類	形式	必須	説明
dbInstanceId	Query	UUID	O	DBインスタンスの識別子
metricNames	Query	Array	O	照会する性能指標リスト - 最小サイズ:`1`
from	Query	Datetime	O	開始日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
to	Query	Datetime	O	終了日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
interval	Query	Number	X	照会間隔 - 単位:`分` - デフォルト値:開始/終了日時に応じて適切な値を自動選択する

レスポンス

名前	種類	形式	説明
metricStatistics	Body	Array	統計情報リスト
metricStatistics.metricName	Body	Enum	性能指標タイプ
metricStatistics.unit	Body	String	測定値単位
metricStatistics.values	Body	Array	測定値リスト
metricStatistics.values.timestamp	Body	Timestamp	測定時間
metricStatistics.values.value	Body	Object	測定値

例

{
    "metricStatistics": [
        {
            "metricName": "DATABASE_STATUS",
            "unit": "",
            "values": [
                [
                    1679298540,
                    "1"
                ],
                [
                    1679298600,
                    "1"
                ],
                [
                    1679298660,
                    "1"
                ]
            ]
        }
    ]
}

イベント

イベントリストを表示

GET /v1.0/events

必要権限

権限名	説明
RDSforPostgreSQL:Event.List	イベントリスト表示

リクエスト

このAPIはリクエスト本文を要求しません。

名前	種類	形式	必須	説明
page	Query	Number	O	照会するリストのページ - 最小値:`1`
size	Query	Number	O	照会するリストのページサイズ - 最小値:`1` - 最大値:`100`
from	Query	Datetime	O	開始日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
to	Query	Datetime	O	終了日時(YYYY-MM-DDThh:mm:ss.SSSTZD)
eventCategoryType	Query	Enum	O	照会するイベントカテゴリータイプ - `ALL`:全体 - `BACKUP`:バックアップ - `DB_INSTANCE`:DBインスタンス - `DB_SECURITY_GROUP`:DBセキュリティグループ - `JOB`:作業 - `TENANT`:テナント - `MONITORING`:モニタリング
sourceId	Query	String	X	イベントが発生した対象リソースの識別子
keyword	Query	String	X	イベントメッセージに含まれた文字列検索ワード

レスポンス

名前	種類	形式	説明
totalCounts	Body	Number	全体のイベントリスト数
events	Body	Array	イベントリスト
events.eventCategoryType	Body	Enum	イベントカテゴリータイプ
events.eventCode	Body	Enum	発生したイベントのタイプ - 詳細はイベント項目を参照してください。
events.sourceId	Body	String	イベントソースの識別子
events.sourceName	Body	String	イベントソースを識別できる名前
events.messages	Body	Array	イベントメッセージリスト
events.messages.langCode	Body	String	言語コード
events.messages.message	Body	String	イベントメッセージ
events.eventYmdt	Body	DateTime	イベント発生日時(YYYY-MM-DDThh:mm:ss.SSSTZD)

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "totalCounts": 28,
    "events": [
        {
            "eventCategoryType": "DB_INSTANCE",
            "eventCode": "DB_INSTANCE_02_01",
            "sourceId": "76f00947-356e-4a20-8922-428368cc45ed",
            "sourceName": "db-instance",
            "messages": [
                {
                    "langCode": "EN",
                    "message": "DB instance started"
                },
                {
                    "langCode": "JA",
                    "message": "DBインスタンスの起動"
                },
                {
                    "langCode": "KO",
                    "message": "DBインスタンス開始"
                },
                {
                    "langCode": "ZH",
                    "message": "DB instance started"
                }
            ],
            "eventYmdt": "2023-03-20T16:31:59+09:00"
        }
    ]
}

購読可能なイベントコードリストを表示

GET /v1.0/event-codes

必要権限

権限名	説明
RDSforPostgreSQL:Event.List	イベントリストを表示

リクエスト

このAPIはリクエスト本文を要求しません。

レスポンス

名前	種類	形式	説明
eventCodes	Body	Array	イベントコードリスト
eventCodes.eventCode	Body	Enum	イベントコード
eventCodes.eventCategoryType	Body	Enum	イベントカテゴリータイプ

例

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "eventCodes": [
        {
            "eventCode": "DB_INSTANCE_02_01",
            "eventCategoryType": "DB_INSTANCE"
        }
    ]
}

Database > RDS for PostgreSQL > APIガイド > API v1.0ガイド
RDS for PostgreSQL API 共通情報
API エンドポイント
認証および権限
レスポンス共通情報
DBバージョン
DBバージョンリストを表示
DBインスタンス仕様
DBインスタンス仕様リストを表示
プロジェクト情報
リージョンリストを表示
プロジェクトメンバーリストを表示
ネットワーク
サブネットリストを表示
ストレージ
ストレージタイプリストを表示
作業情報
作業情報の詳細を表示
DBインスタンスグループ
DBインスタンスグループリストを表示
DBインスタンスグループ詳細を表示
DBインスタンスグループ > 拡張機能管理
拡張機能リスト表示
拡張機能のインストール
拡張機能の削除(キャンセル)
拡張機能変更事項適用
拡張機能の同期
DBインスタンス
DBインスタンスの状態
DBインスタンスの進行状態
DBインスタンスリストを表示
DBインスタンス詳細を表示
DBインスタンスを作成する
DBインスタンスを修正する
高可用性情報の照会
高可用性を修正する
高可用性の再起動
高可用性の一時停止
高可用性の復旧
高可用性の分離
DBインスタンスストレージ情報の照会
DBインスタンスストレージ情報の修正
DBインスタンスネットワーク情報の照会
DBインスタンスネットワーク情報の修正
DBインスタンスバックアップ情報の照会
DBインスタンスバックアップ情報の修正
DBインスタンス復元情報の照会
DBインスタンスの復元
DBインスタンス削除保護設定の変更
DBインスタンス保守情報照会
DBインスタンス保守情報修正
現在のDBインスタンスで選択可能なDBバージョンの照会
DBインスタンスの削除
DBインスタンスの再起動
DBインスタンスの強制再起動
DBインスタンス開始
DBインスタンス停止
DBインスタンスのバックアップ
DBインスタンスバックアップ後にエクスポート
DBインスタンスの最新パラメータグループを適用する
DBインスタンスの複製
DBインスタンスの昇格
DBインスタンス > データベース
データベースリスト表示
データベース作成
データベースの修正
データベース削除
DBインスタンス > ユーザー
ユーザーリスト表示
ユーザー作成
ユーザー修正
ユーザー削除
DBインスタンス > アクセス制御
アクセス制御ルールリストを表示
アクセス制御ルールの追加
アクセス制御ルールの修正
アクセス制御ルールの削除
アクセス制御ルールの順序調整
アクセス制御ルールを適用
バックアップ
バックアップリスト照会
オブジェクトストレージにバックアップをエクスポート
バックアップの復元
バックアップ削除
DBセキュリティグループ
DBセキュリティグループリストを表示
DBセキュリティグループ詳細を表示
DBセキュリティグループの作成
DBセキュリティグループの修正
DBセキュリティグループの削除
DBセキュリティグループルールの作成
DBセキュリティグループルールの修正
DBセキュリティグループルールの削除
パラメータグループ
パラメータグループリストを表示
パラメータグループ詳細を表示
パラメータグループの作成
パラメータグループのコピー
パラメータグループの修正
パラメータ修正
パラメータグループの再設定
パラメータグループの削除
ユーザーグループ
ユーザーグループリストを表示
ユーザーグループ詳細を表示
ユーザーグループの作成
ユーザーグループの修正
ユーザーグループの削除
通知グループ
通知グループリストを表示
通知グループ詳細を表示
通知グループの作成
通知グループの修正
通知グループの削除
監視設定リストを表示
監視設定の作成
監視設定の修正
監視設定の削除
モニタリング
性能指標リストを表示
統計情報照会
イベント
イベントリストを表示
購読可能なイベントコードリストを表示

TOP