API接続について

この記事では、OB CloudデータベースのOpen APIへの接続方法について説明します。

前提条件

AccessKey IDとAccessKey Secretを取得します。詳細については、アクセスキーの管理をご参照ください。

呼び出し方法

OB CloudデータベースのOpen API呼び出しには、以下の部分が含まれます：

• インターフェース呼び出しドメイン名：地域に応じて対応するドメイン名を選択してください。詳細については、サービスエントリポイントをご参照ください。
• Open APIキー：公開鍵と秘密鍵を使用した認証が必要です。
• リクエスト方式：POST、PATCH、PUTでリソースにデータを送信する場合、JSON形式の有効ペイロードを使用する必要があります。

リクエストヘッダー

Open APIエンドポイントの呼び出し

AccessKey IDとAccessKey Secretに対応するIDと秘密鍵を入力し、端末で以下のコマンドを実行します：

```
curl  --digest   -u 'AccessKey ID:AccessKey Secret' \
    --request GET \
    -H 'X-Ob-Project-Id':'projectId' \
    --url   https://< Open API ドメイン名>/< Open API リクエストパス>
```

実行例

• 呼び出しが成功すると、レスポンスのステータスコードは200になり、インターフェースの詳細情報が表示されます：

  {
      "success":true,
      "data":{
      },
      "requestId":"request-id-uuid"
  }
  

• 呼び出しが失敗した場合、200以外のステータスコードが返され、返される内容は次のとおりです：

  {
      "success":false,
      "errorCode":"E001R000",
      "errorMessage":"Unknown error",
      "requestId":"uuid"
  }