EDB Postgres Enterprise Manager REST APIs v1.0.0

EDB Postgres Enterprise Manager REST APIs v1.0.0#

EDB Postgres Enterprise Manager は、トークンベースの認証メカニズムを使用して、公開されたREST APIへのアクセスを許可します。

PEMは認証のためにトークンを使用します。トークンを生成するには、 トークンセクションを参照してください。トークン文字列を受け取った後、 https://PEM-SERVER-IP/api/token/以外のリソースを呼び出すときに、’X-Auth-Token’ヘッダーにトークン文字列を含める必要があります。

注

  • EDB Postgres Enterprise Manager は、このドキュメントでは** PEM *** と呼ばれています。*

  • PEM *自己認証SSL証明書を使用するため、「SSL証明書の問題:自己署名証明書」などのエラーが発生する場合があります。 ’非セキュア’接続を使用してサーバーに接続する必要がある場合があります。

残りのAPIバージョン

  • v1

  • v2

  • v3

  • v4

  • v5

  • v6

  • v7

  • v8

  • v9

  • v10

  • v11

  • v12

  • v13

  • v14 現在

ベースURL

電子メール EnterpriseDB Web EnterpriseDB ライセンス 限定使用ソフトウェアライセンス契約

トークン#

認証のためにPEM REST APIによって生成および使用される文字列

トークン生成#

コードサンプル

#  You can also use wget

curl -X POST https://PEM-SERVER-IP/api/token/ \
  -H Content-Type: application/json \
  -H Accept: application/json

import requests
headers = {
  Content-Type: application/json,
  Accept: application/json
}

r = requests.post(https://PEM-SERVER-IP/api/token/, headers = headers)

print(r.json())

const inputBody = {
  "username": "string",
  "password": "string"
};
const headers = {
  Content-Type:application/json,
  Accept:application/json
};

fetch(https://PEM-SERVER-IP/api/token/,
{
  method: POST,
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /token/

認証用のトークンを生成します。

このURLは、PEMが公開する他のREST APIが使用するトークンを作成します。有効なユーザー名とパスワードを入力する必要があります。プロセス中に検証されます。

トークンの有効期間は20分です。

ボディパラメーター

{
  "username": "string",
  "password": "string"
}

パラメーター#

Name

In

Type

Required

Description

body

body

object

true

最初に/token/ URLを使用してトークンを作成します。

» username

body

string

true

pem_userロールを持つユーザー名を検証します。

» password

body

string

true

ユーザー名のパスワード

応答例

{
  "issuedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "schema_version": 0,
  "backend_schema_version": 0,
  "version_long": 0,
  "version": "string",
  "supported_api_versions": [
    "string"
  ],
  "deprecated_api_versions": [
    "string"
  ]
}

応答#

Status

Meaning

Description

Schema

201

Created

トークンが作成され、応答ヘッダーに'X-Subject-Token'として見つかります。

Inline

401

Unauthorized

指定された情報は有効ではありません。

None

500

Internal Server Error

何かがうまくいかなかった。

None

503

Service Unavailable

PEMバックエンドデータベースサーバーがダウンしています。現在、サービスはご利用いただけません。

None

レスポンススキーマ#

ステータスコード 201

*トークンが生成されたとき、および有効期限が切れたときに関する情報が含まれています。

Name

Type

Required

Restrictions

Description

» issuedAt

string(date-time)

false

none

この時点でトークンが生成されました。

» expiresAt

string(date-time)

false

none

トークンの有効期限が切れる日時を提供します。

» schema_version

integer

false

none

アプリケーションがサポートするスキーマバージョン

» backend_schema_version

integer

false

none

バックエンドデータベーススキーマバージョン

» version_long

integer

false

none

ロングフォーマットで表されるバージョン

» version

string

false

none

PEMバージョンの文字列表現

» supported_api_versions

[string]

false

none

サポートされているAPIバージョンのリスト

» deprecated_api_versions

[string]

false

none

非推奨のAPIバージョンのリスト

レスポンスヘッダー#

Status

Header

Type

Format

Description

201

X-Subject-Token

string

新しいトークンを返します。これは、さらなる操作のためにREST APIで使用できます

注釈

この操作には認証が必要ありません

delete_token#

コードサンプル

#  You can also use wget

curl -X DELETE https://PEM-SERVER-IP/api/token/ \
  -H X-Auth-Token: string

import requests
headers = {
  X-Auth-Token: string
}

r = requests.delete(https://PEM-SERVER-IP/api/token/, headers = headers)

print(r.json())

const headers = {
  X-Auth-Token:string
};

fetch(https://PEM-SERVER-IP/api/token/,
{
  method: DELETE,

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /token/

トークンをリリースします。

トークンを無効にします。今後の操作では使用できなくなります。

パラメーター#

Name

In

Type

Required

Description

X-Auth-Token

header

string

true

承認トークン

応答例

応答#

Status

Meaning

Description

Schema

204

No Content

PEMからトークンを正常に解放しました。

This token can not be used for any further operations.

None

NA

レスポンススキーマ#

注釈

この操作には認証が必要ありません

目次