Skip to Content
リリースノート9.9.0 ~ 9.9.8External API変更事項（9.8.10バージョン > 9.9.4バージョン）

External API変更事項（9.8.10バージョン > 9.9.4バージョン）

API Docs JSON file

:paperclip: 9810_external.json :paperclip: 994_external.json

1. Authentication

  • API Key HTTP Header nameが変更されました
変更前変更後
Header Parameter nameX-QueryPie-Api-TokenAuthorization

2. Alert API

変更/改善事項

API(9.8.10)

変更点

(GET) List

  • 各Alertの すべての情報 を返却
    → 各Alertの 簡単な情報 を返却するように変更されました。
  • 各Alert Type別にAlertの詳細情報を返却する Detail API追加 されました。

(POST) Create

  • 1つのAPI で全てのTypeのAlertを生成可能
    → 各Alert Type別に 生成APIが分離 しました。
  • 既存Create API削除されました。

(PUT) Update

  • 1つのAPI で全てのTypeのAlertを修正可能
    → 各Alert Type別に 修正APIを分離 しました。
  • 既存Update API削除されました。

(Delete) Delete

  • 変更点なし。

[新規] (POST) Create, (PUT) Update, (GET) Detail API

  • 詳細なリクエスト内容はDocs参照

Alert Type(9.8.10基準)

Docs位置(9.9.4)

SQL_EXECUTION

[SQL Execution]
/api/external/alerts/sql-execution

SQL_EXECUTION_PREVENTED

[Prevented SQL Execution]
/api/external/alerts/prevented-sql-execution

DATABASE_AUTHENTICATION_FAILED

[DB Connection Attempt]
/api/external/alerts/db-connection-attempt

SENSITIVE_DATA_BY_POLICY

[Sensitive Data Access]
api/external/alerts/sensitive-data-access

  • policy

SENSITIVE_DATA_BY_LEVEL

[Sensitive Data Access]
api/external/alerts/sensitive-data-access

  • level

EXCEL_EXPORT

[Data Export]
api/external/alerts/data-export

APPROVAL_REQUESTED

[Workflow New Request]
/api/external/alerts/workflow-new-request

[Unusual Login Attempt] 新規追加されました
/api/external/alerts/unusual-login-attempt

(GET) List

/api/external/notifications

Request
  • 変更点なし
Response

変更前

変更後

{
  "list": [
    {
      "condition": {...},
      "description": "",
      "lastAt": "2019-08-24T14:15:22Z",
      "lastStatus": "UNDEFINED",
      "notification": {...},
      "policy": {...},
      "template": "{{userName}} executed {{expRows}} rows.",
      "uuid": "a5ac2279-b715-4819-a00d-daba81739057"
    },
    ...
  ],
  "page": {...}
}
{
  "list": [
    {
      "alertType": "SQL Execution",
      "lastAt": "2019-08-24T14:15:22Z",
      "lastStatus": "UNDEFINED",
      "name": "string",
      "template": "{{userName}} executed {{expRows}} rows.",
      "uuid": "a5ac2279-b715-4819-a00d-daba81739057"
    },
    ...
  ],
  "page": {...}
}

3. Approval Rule API

(GET) List

/api/external/approval-rules

Request
  • Query Parameter
  • RequestType が SQL, ACCESS → SQL, EXPORT, ACCESS に EXPORT が追加 されました。
Response
  • 変更点なし

4. Audit Log API

(GET) List of Approval

/api/external/audit-logs

Request
  • Query Parameter

変更前

変更後

  • pageNumber
  • pageSize
  • actionType
  • clusterGroupId
  • clusterId
  • startDate
  • endDate
  • databaseType
  • sqlFullText
  • cursor
  • count
  • actionType
  • clusterGroupId
  • clusterId
  • startDate
  • endDate
  • databaseType
  • sqlFullText
  • cursorはResponseの nextCursor を そのまま 使用すればよいです。最初の呼び出しの場合は空にしておきます。
    • /api/docsに記載されている内容は 誤った内容 で、以降のバージョンで修正予定です。
  • count は既存pageSizeと同一で、 max 値は 100 です。
  • databaseType に Redis が 追加 されました。
Response

変更前

変更後

{
  "list": [
    {
      …
      "execMillis": 200,
      "execResult": false,
      "executedAt": "2019-08-24T14:15:22Z",
      …
    }
  ],
  "page": {
    "currentPage": 0,
    "pageSize": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}
{
  "hasNext": true,
  "list": [
    {
      …
      "execMillis": 200,
      "execResult": false, (Deprecated)
      "executedAt": "2019-08-24T14:15:22Z",
      …
    }
  ],
  "nextCursor": "2019-08-24T16:15:22Z"
}
  • hasNextフィールドが 追加 されました。 Response以降に次のデータがあるか を表します。
  • execResult が Deprecated されました。以降のバージョンで削除されます。
  • page フィールドが 消えて nextCursor が 追加 されました。
    • RequestのstartDateとendDateの間で現在のResponseのlistのうち 最も最後の要素のexecutedAt を意味します。
    • Requestのcursorに該当値を入れると 該当時間から続けて データを取得します。 (startDate, endDateは変更しなくてもよいです。)
    • /api/docsに記載されている内容は 誤った内容 で、以降のバージョンで修正予定です。


(GET) Detail

/api/external/audit-logs/{id}

Request
  • 変更点なし
Response

変更前

変更後

{
      …
      "execMillis": 200,
      "execResult": false,
      "executedAt": "2019-08-24T14:15:22Z",
      …
}
{
      …
      "execMillis": 200,
      "execResult": false, (Deprecated)
      "executedAt": "2019-08-24T14:15:22Z",
      …
}
  • execResult が Deprecated されました。以降のバージョンで削除されます。

(GET) Detail

/api/external/audit-logs/{uuid}

Request
  • 変更点なし
Response

変更前

変更後

{
      …
      "execMillis": 200,
      "execResult": false,
      "executedAt": "2019-08-24T14:15:22Z",
      …
}
{
      …
      "execMillis": 200,
      "execResult": false, (Deprecated)
      "executedAt": "2019-08-24T14:15:22Z",
      …
}
  • execResult が Deprecated されました。以降のバージョンで削除されます。

5. Authentication History API

(GET) List of Authentication

/api/external/connection-auth-logs

Request
  • Query Parameter

変更前

変更後

  • pageNumber
  • pageSize
  • actionType
  • clusterGroupId
  • clusterId
  • startDate
  • endDate
  • databaseType
  • sqlFullText
  • pageNumber
  • pageSize
  • actionType
  • clusterGroupId
  • clusterId
  • startDate
  • endDate
  • databaseType
  • sqlFullText
  • actionType から LOGIN, LOGOUT, LOCKED, EXPIRED, LOCKED_MANUALLY, UNLOCK が 削除 されました。
    • CONNECT, DISCONNECT のみ使用します。
  • databaseType に Redisが 追加 されました。
Response
  • 変更点なし

6. User Access History API

(GET) List of User Access History

/api/external/system-auth-logs

Request & Response
  • actionType から CONNECT, DISCONNECTが 削除 されました。
    • LOGIN, LOGOUT, LOCKED, EXPIRED, LOCKED_MANUALLY, UNLOCK のみ使用します。

7. Cloud Provider API

(GET) List of Cloud Provider

/api/external/cloud-providers

Request
  • 変更点なし
Response

変更前

変更後

{
  "list": [
    {
      …
      "subscriptionId": "string",
      "targetArn": "string",
      …
    }
  ],
  "page": {
    …
  }
}
{
  "list": [
    {
      …
      "subscriptionId": "string",
      "synchronizableDatabaseTypes": [],
      "targetArn": "string",
      …
    }
  ],
  "page": {
     …
  }
}
  • synchronizableDatabaseTypes が 追加 されました。
    • 同期したいデータベースのタイプ (ベンダー) を出力するフィールドです。
    • AURORA_MY_SQL, AURORA_POSTGRESQL, MY_SQL, POSTGRESQL, MARIA_DB, ORACLE, SQL_SERVER, DYNAMO_DB, DOCUMENT_DB, REDSHIFT, ATHENA

(POST) Create Cloud Provider

/api/external/cloud-providers

Request

変更前

変更後

{
      …
      "subscriptionId": "string",
      "targetArn": "string",
      …
}
{
      …
      "subscriptionId": "string",
      "synchronizableDatabaseTypes": [],
      "targetArn": "string",
      …
}
  • synchronizableDatabaseTypes が 追加 されました。
    • 同期したいデータベースのタイプ (ベンダー) を入力するフィールドです。
    • AURORA_MY_SQL, AURORA_POSTGRESQL, MY_SQL, POSTGRESQL, MARIA_DB, ORACLE, SQL_SERVER, DYNAMO_DB, DOCUMENT_DB, REDSHIFT, ATHENA
Response

変更前

変更後

{
      …
      "subscriptionId": "string",
      "targetArn": "string",
      …
 }
{
      …
      "subscriptionId": "string",
      "synchronizableDatabaseTypes": [],
      "targetArn": "string",
      …
}
  • synchronizableDatabaseTypes が 追加 されました。
    • 同期したいデータベースのタイプ (ベンダー) を出力するフィールドです。
    • AURORA_MY_SQL, AURORA_POSTGRESQL, MY_SQL, POSTGRESQL, MARIA_DB, ORACLE, SQL_SERVER, DYNAMO_DB, DOCUMENT_DB, REDSHIFT, ATHENA

(PUT) Update Cloud Provider

/api/external/cloud-providers/{cloudProviderUuid}

Request

変更前

変更後

{
  "cronExpression": "0 0 6 * * ?",
  "name": "AWS",
  "proxyAuthType": "QUERYPIE",
  "proxyEnabled": true,
  "replicationMode": "MANUAL"
}
{
  "cronExpression": "0 0 6 * * ?",
  "name": "AWS",
  "proxyAuthType": "QUERYPIE",
  "proxyEnabled": true,
  "replicationMode": "MANUAL",
  "synchronizableDatabaseTypes": [
    "AURORA_MY_SQL"
  ]
}
  • synchronizableDatabaseTypes が 追加 されました。
    • 同期したいデータベースのタイプ (ベンダー) を入力するフィールドです。
    • AURORA_MY_SQL, AURORA_POSTGRESQL, MY_SQL, POSTGRESQL, MARIA_DB, ORACLE, SQL_SERVER, DYNAMO_DB, DOCUMENT_DB, REDSHIFT, ATHENA
Response

変更前

変更後

{
      …
      "subscriptionId": "string",
      "targetArn": "string",
      …
}
{
      …
      "subscriptionId": "string",
      "synchronizableDatabaseTypes": [],
      "targetArn": "string",
      …
}
  • synchronizableDatabaseTypes が 追加 されました。
    • 同期したいデータベースのタイプ (ベンダー) を出力するフィールドです。
    • AURORA_MY_SQL, AURORA_POSTGRESQL, MY_SQL, POSTGRESQL, MARIA_DB, ORACLE, SQL_SERVER, DYNAMO_DB, DOCUMENT_DB, REDSHIFT, ATHENA

8. Cluster Role API

(GET) List of Role

/api/external/roles

Request
  • 変更点なし
Response

変更前

変更後

{
  "list": [
    {
      …
      "privilegeTypes": "SELECT",
      …
    },
    …
  ],
  "page": { … }
}
{
  "list": [
    {
      …
      "privilegeTypes": "SELECT",
      "privilegeVendor": "SQL",
      …
    },
    …
  ],
  "page": { … }
}
  • privilegeVendor が 追加 されました。
    • SQL, REDIS

(POST) Create Role

/api/external/roles

Request & Response

変更前

変更後

{
  …
  "privilegeTypes": "ALL",
  …
}
{
  …
  "privilegeTypes": "ALL",
  "privilegeVendor": "SQL",
  …
}
  • privilegeVendor が 追加 されました。
    • SQL, REDIS

(PUT) Update Role

/api/external/roles/{roleUuid}

Request & Response

変更前

変更後

{
  …
  "privilegeTypes": "ALL",
  …
}
{
  …
  "privilegeTypes": "ALL",
  "privilegeVendor": "SQL",
  …
}
  • privilegeVendor が 追加 されました。
    • SQL, REDIS

9. Connection API

(GET) List of Cluster Group

/api/external/connections

Request
  • 変更点なし
Response

変更前

変更後

Request

-

なし

Response

{
  "list": [
    {
      …
      "clusters": [
          …
      ],
      "connectionOwners": [
       …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "dbUserInfos": [
        {
          "dbUserType": "string",
          "dbUsername": "string"
        }
      ],
      "deleted": false,
      …
      "schemaName": "test_db",
      "useMultipleAccount": true,
      "useProxy": true,
      …
    }
  ],
  "page": {
    …
  }
}
{
  "list": [
    {
      …
      "clusters": [
        …
      ],
      "connectionAccount": {
        "kerberosProtocols": {
          "admin": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          },
          "common": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          }
        },
        "type": "UIDPWD",
        "useMultipleAccount": false,
        "usernamePasswords": {
          "admin": {
            "username": "string"
          },
          "common": {
            "username": "string"
          },
          "proxy": {
            "username": "string"
          }
        }
      },
      "connectionOwners": [
        …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "deleted": false,
      …
      "schemaName": "test_db",
      "useProxy": true,
      …
    }
  ],
  "page": {
    …
  }
}
  • dbUserInfo が 削除 されました。 userMultipleAccount が 削除 されました。
    • 該当フィールドの内容はconnectionAccountを通じて伝達されます。
  • connectionAccount が 追加 されました。
    • 接続の account 情報 を伝達するフィールドです。
    • type はaccountの タイプ を意味します。
      • NOAUTH SASL_KERBEROS SASL_PLAIN_UID UIDPWD SASL_PLAIN_UIDPWD_SSL NOAUTH_SSL DELEGATION_TOKEN O_AUTH_CLIENT_CREDENTIALS
    • useMultipleAccount は マルチアカウント を使用するかについての boolean 値です。
    • KerberosProtocols は Kerberosアカウント 情報を伝達するフィールドです。
      • Kerberosアカウントは proxy アカウント を サポートしません。
    • usernamePasswords は usernamePassword アカウント 情報を伝達するフィールドです。

(POST) Create Cluster Group

/api/external/connections

Request

変更前

変更後

Request

-

なし

Response

{
      "clusters": [
          …
      ],
      "connectionOwners": [
       …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "dbUserInfos": [
        {
          "dbUserType": "string",
          "dbUsername": "string"
        }
      ],
      "deleted": false,
      …
}
{
      …
      "clusters": [
        …
      ],
      "connectionAccount": {
        "kerberosProtocols": {
          "admin": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          },
          "common": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          }
        },
        "type": "UIDPWD",
        "useMultipleAccount": false,
        "usernamePasswords": {
          "admin": {
            "username": "string"
          },
          "common": {
            "username": "string"
          },
          "proxy": {
            "username": "string"
          }
        }
      },
      "connectionOwners": [
        …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "deleted": false,
      …
}
  • dbUserInfo が 削除 されました。 userMultipleAccount が 削除 されました。
    • 該当フィールドの内容はconnectionAccountを通じて伝達されます。
  • connectionAccount が 追加 されました。
    • 接続の account 情報 を伝達するフィールドです。
    • type はaccountの タイプ を意味します。
      • NOAUTH SASL_KERBEROS SASL_PLAIN_UID UIDPWD SASL_PLAIN_UIDPWD_SSL NOAUTH_SSL DELEGATION_TOKEN O_AUTH_CLIENT_CREDENTIALS
    • useMultipleAccount は マルチアカウント を使用するかについての boolean 値です。
    • KerberosProtocols は Kerberosアカウント 情報を伝達するフィールドです。
      • Kerberosアカウントは proxy アカウント を サポートしません。
    • usernamePasswords は usernamePassword アカウント 情報を伝達するフィールドです。
Response

変更前

変更後

Request

-

なし

Response

{
      …
      "clusters": [
          …
      ],
      "connectionOwners": [
       …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "dbUserInfos": [
        {
          "dbUserType": "string",
          "dbUsername": "string"
        }
      ],
      "deleted": false,
      …
      "schemaName": "test_db",
      "useMultipleAccount": true,
      "useProxy": true,
      …
}
{
      …
      "clusters": [
        …
      ],
      "connectionAccount": {
        "kerberosProtocols": {
          "admin": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          },
          "common": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          }
        },
        "type": "UIDPWD",
        "useMultipleAccount": false,
        "usernamePasswords": {
          "admin": {
            "username": "string"
          },
          "common": {
            "username": "string"
          },
          "proxy": {
            "username": "string"
          }
        }
      },
      "connectionOwners": [
        …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "deleted": false,
      …
      "schemaName": "test_db",
      "useProxy": true,
      …
}
  • dbUserInfo が 削除 されました。 userMultipleAccount が 削除 されました。
    • 該当フィールドの内容はconnectionAccountを通じて伝達されます。
  • connectionAccount が 追加 されました。
    • 接続の account 情報 を伝達するフィールドです。
    • type はaccountの タイプ を意味します。
      • NOAUTH SASL_KERBEROS SASL_PLAIN_UID UIDPWD SASL_PLAIN_UIDPWD_SSL NOAUTH_SSL DELEGATION_TOKEN O_AUTH_CLIENT_CREDENTIALS
    • useMultipleAccount は マルチアカウント を使用するかについての boolean 値です。
    • KerberosProtocols は Kerberosアカウント 情報を伝達するフィールドです。
      • Kerberosアカウントは proxy アカウント を サポートしません。
    • usernamePasswords は usernamePassword アカウント 情報を伝達するフィールドです。


(PATCH) Update Cluster Group

/api/external/connections/{uuid}

Request

変更前

変更後

Request

-

なし

Response

{
      "clusters": [
          …
      ],
      "connectionOwners": [
       …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "dbUserInfos": [
        {
          "dbUserType": "string",
          "dbUsername": "string"
        }
      ],
      "deleted": false,
      …
}
{
      …
      "clusters": [
        …
      ],
      "connectionAccount": {
        "kerberosProtocols": {
          "admin": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          },
          "common": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          }
        },
        "type": "UIDPWD",
        "useMultipleAccount": false,
        "usernamePasswords": {
          "admin": {
            "username": "string"
          },
          "common": {
            "username": "string"
          },
          "proxy": {
            "username": "string"
          }
        }
      },
      "connectionOwners": [
        …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "deleted": false,
      …
}
  • dbUserInfo が 削除 されました。 userMultipleAccount が 削除 されました。
    • 該当フィールドの内容はconnectionAccountを通じて伝達されます。
  • connectionAccount が 追加 されました。
    • 接続の account 情報 を伝達するフィールドです。
    • type はaccountの タイプ を意味します。
      • NOAUTH SASL_KERBEROS SASL_PLAIN_UID UIDPWD SASL_PLAIN_UIDPWD_SSL NOAUTH_SSL DELEGATION_TOKEN O_AUTH_CLIENT_CREDENTIALS
    • useMultipleAccount は マルチアカウント を使用するかについての boolean 値です。
    • KerberosProtocols は Kerberosアカウント 情報を伝達するフィールドです。
      • Kerberosアカウントは proxy アカウント を サポートしません。
    • usernamePasswords は usernamePassword アカウント 情報を伝達するフィールドです。
Response

変更前

変更後

Request

-

なし

Response

{
      …
      "clusters": [
          …
      ],
      "connectionOwners": [
       …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "dbUserInfos": [
        {
          "dbUserType": "string",
          "dbUsername": "string"
        }
      ],
      "deleted": false,
      …
      "schemaName": "test_db",
      "useMultipleAccount": true,
      "useProxy": true,
      …
}
{
      …
      "clusters": [
        …
      ],
      "connectionAccount": {
        "kerberosProtocols": {
          "admin": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          },
          "common": {
            "principal": "string",
            "realm": "string",
            "serviceName": "string"
          }
        },
        "type": "UIDPWD",
        "useMultipleAccount": false,
        "usernamePasswords": {
          "admin": {
            "username": "string"
          },
          "common": {
            "username": "string"
          },
          "proxy": {
            "username": "string"
          }
        }
      },
      "connectionOwners": [
        …
      ],
      "databaseType": "MySQL",
      "databaseVersion": "5.7.10",
      "deleted": false,
      …
      "schemaName": "test_db",
      "useProxy": true,
      …
}
  • dbUserInfo が 削除 されました。 userMultipleAccount が 削除 されました。
    • 該当フィールドの内容はconnectionAccountを通じて伝達されます。
  • connectionAccount が 追加 されました。
    • 接続の account 情報 を伝達するフィールドです。
    • type はaccountの タイプ を意味します。
      • NOAUTH SASL_KERBEROS SASL_PLAIN_UID UIDPWD SASL_PLAIN_UIDPWD_SSL NOAUTH_SSL DELEGATION_TOKEN O_AUTH_CLIENT_CREDENTIALS
    • useMultipleAccount は マルチアカウント を使用するかについての boolean 値です。
    • KerberosProtocols は Kerberosアカウント 情報を伝達するフィールドです。
      • Kerberosアカウントは proxy アカウント を サポートしません。
    • usernamePasswords は usernamePassword アカウント 情報を伝達するフィールドです。

10. Notification Channels API

(GET) List of Notification channel

/api/external/notification-channels

Request
  • Query Parameterフィールド追加

変更前

変更後

  • …
  • dataFlowRequest. filterKey
  • dataFlowRequest. filterValue
  • dataFlowRequest. sortKey
  • dataFlowRequest. sortType
  • …
  • dataflowRequest. filterKey は フィルターキー を入れます。. ex) “Title”
  • dataflowRequest. filterValue は フィルター値 (検索語) を入れます。 ex) “channelName123”
  • dataflowRequest. sortKey は sort する カラム名 を入れます。 ex ) “createdAt”
  • dataflowRequest. sortType は sort を 降順 にするか、 昇順 にするかを入力します。 ex) “ASC”, “DESC”
Last updated on
9.9.0 ~ 9.9.8External API変更事項（9.9.4バージョン > 9.9.5バージョン）