Object Store v2 REST API

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

Object Store v2 API により、REST を使用して次の操作を実行できます。

アプリケーションに関連付けられたオブジェクトストアとキーのリストを取得する。
オブジェクトストアでキー-値ペアを保存して取得する。
オブジェクトストアからキー-値ペアを削除する。
組織の Object Store の使用量統計を取得する。

Object Store には次の API が用意されています。

Object Store API を使用した認証

Object Store v2 API

Object Store API を使用して認証するにはベアラートークンが必要です。ベアラートークンを取得するには、アプリケーションのクライアント ID とクライアントシークレットが必要です。
Object Store v2 Stats API

Object Store v2 Stats API を使用して認証するにはアクセストークンが必要です。アクセストークンを取得するには、組織のシステム管理者ロールが割り当てられたユーザーの Anypoint Platform ユーザー名とパスワードが必要です。

前提条件

Object Store v2 を使用するアプリケーションを作成し、CloudHub にデプロイします。

「CloudHub へのデプロイ」を参照してください。
オブジェクトストアにキー-値ペアを保存します。

「オブジェクトストアにデータを送信する」を参照してください。
Anypoint Platform ユーザーのアクセストークン (ACCESS_TOKEN) を取得します。

Object Store v2 Stats API にアクセスするには、ユーザーに組織のシステム管理者ロールが割り当てられている必要があります。

Object Store v2 Stats API を使用して認証するにはアクセストークンが必要です。

「アクセス管理 API」の「認証」を参照してください。
組織 ID (ORG_ID) を取得します。

Object Store v2 API および Object Store v2 Stats API を使用した操作には組織 ID が必要です。

「アクセス管理 API」の /api/me エンドポイントを参照してください。
環境 ID (ENV_ID) を取得します。

Object Store v2 API および Object Store v2 Stats API を使用した操作には環境 ID が必要です。

「アクセス管理 API」の /api/organizations/ORG_ID/environments エンドポイントを参照してください。
リージョン ID (REGION_ID) を取得します。

Object Store v2 Stats API を使用した操作にはリージョン ID が必要です。

「Object Store v2 API」および「例: リージョンのリストを取得する」で /api/v1/organizations/ORG_ID/regions エンドポイントを参照してください。
ストア ID (STORE_ID) を取得します。

Object Store v2 Stats API を使用した操作にはストア ID が必要です。

「Object Store v2 API」および「例: オブジェクトストアのリストを取得する」で /api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID エンドポイントを参照してください。
アプリケーションのクライアント ID (CLIENT_ID) とクライアントシークレット (CLIENT_SECRET) を取得します。

ベアラートークンを取得するにはクライアント ID とクライアントシークレットが必要です。

アプリケーションのクライアント ID とクライアントシークレットを取得するを参照してください。
アプリケーションのベアラートークン (BEARER_TOKEN) を取得します。

Object Store v2 API を使用して認証するにはベアラートークンが必要です。

「アクセス管理 API」の /accounts/oauth2/token エンドポイントを参照してください。

ベアラートークンを取得するには、アプリケーションのクライアント ID とクライアントシークレットが必要です。

アプリケーションのクライアント ID とクライアントシークレットを取得する

アプリケーションのクライアント ID とクライアントシークレットを取得する手順は、次のとおりです。

[Anypoint Platform] > [Runtime Manager] にログインします。
アプリケーションをクリックし、[Manage Application (アプリケーションを管理)] をクリックします。
アプリケーションが Object Store に関連付けられていない場合、[Use Object Store v2 (Object Store v2 を使用)] をクリックして変更を適用します。
左ナビゲーション領域の [Object Store] をクリックし、[Show Client Credentials (クライアントのログイン情報を表示)] をクリックします。
[Client ID (クライアント ID)] の [Copy to Clipboard (クリップボードにコピー)] をクリックして CLIENT_ID の値として保存します。
[Client Secret (クライアントシークレット)] の [Copy to Clipboard (クリップボードにコピー)] をクリックして CLIENT_SECRET の値として保存します。

Object Store v2 API

Object Store v2 API で読み取りおよび書き込みを行う key,list 値は、key,value 形式での読み取りおよび書き込みを行うオブジェクトストア用 Anypoint Connector (Object Store Connector) とは異なります。

次の表では、Object Store REST API 操作を Object Store Connector 操作と比較しています。

Object Store v2 API Object Store v2 REST API 操作 Object Store Connector 操作

Object Store v2 API	Object Store v2 REST API 操作	Object Store Connector 操作
POST	オブジェクトストアオブジェクトストアの TTL (秒) 最大 TTL は 2,592,000 秒 (30 日) です。指定された `entryTtl` 値が 30 日より大きい場合、値のデフォルトは 2592000 秒 (30 日) になり、エラーは返されません。永続性プロパティアプリケーションまたは環境ごとの使用制限。キーまたはサイズに基づいて制限するオプションやその適用方法を含みますキーおよびリスト (項目) 値	Store (保存)
GET	Get keys (キーを取得) Get item (項目を取得) Get items (複数の項目を取得) Get all items (すべての項目を取得) Get regions for an organization (組織のリージョンを取得)	Contains (包含チェック) + Retrieve (取得) + Retrieve all keys (すべてのキーを取得) + Retrieve and store (取得して保存) (Retrieve 部分)
PUT	Put item as string (項目を文字列として更新) Put item as number (項目を数値として更新) Put item as confirmable string (項目を確認可能な文字列として更新) Put store (更新して保存)	Dual Store (2 段階保存) † + Store (保存)
DELETE	Remove object store (オブジェクトストアを削除) Delete key (キーを削除) Delete item (項目を削除)	Remove (削除)

POST

オブジェクトストア
- オブジェクトストアの TTL (秒)
  
  最大 TTL は 2,592,000 秒 (30 日) です。
  
  指定された entryTtl 値が 30 日より大きい場合、値のデフォルトは 2592000 秒 (30 日) になり、エラーは返されません。
- 永続性プロパティ
- アプリケーションまたは環境ごとの使用制限。キーまたはサイズに基づいて制限するオプションやその適用方法を含みます
キーおよびリスト (項目) 値

Store (保存)

GET

Get keys (キーを取得)
Get item (項目を取得)
Get items (複数の項目を取得)
Get all items (すべての項目を取得)
Get regions for an organization (組織のリージョンを取得)

Contains (包含チェック) + Retrieve (取得) + Retrieve all keys (すべてのキーを取得) + Retrieve and store (取得して保存) (Retrieve 部分)

PUT

Put item as string (項目を文字列として更新)
Put item as number (項目を数値として更新)
Put item as confirmable string (項目を確認可能な文字列として更新)
Put store (更新して保存)

Dual Store (2 段階保存) † + Store (保存)

DELETE

Remove object store (オブジェクトストアを削除)
Delete key (キーを削除)
Delete item (項目を削除)

Remove (削除)

† Object Store Connector の Dual Store 操作は、キーで値を保存する操作と、その後に値でキーを保存する操作の 2 つで構成されます。 Dual Store 操作は、Object Store v2 で 2 つの「Put item as String」 (項目を文字列として更新) コールを実行して次の結果を得るのと同様に動作します。

objectStore.store(key, value);
objectStore.store(value, key);

1 回の GET 操作で最大 25 個のキーを取得できます。

制限事項

アプリケーションが REST インターフェースを使用してオブジェクトストアに書き込み、Mule 3 用 Object Store Connector を使用して同じキーから読み取る場合、この読み取りでは要素 0 の値しか取得できません。そのため、REST API を使用する場合は、API を使用してオブジェクトストアのコンテンツを読み書きします。そうしないと、API を使用して書き込める先はインデックス 0 のみになります。

この制限は、Mule 4 用 Object Store Connector と Anypoint Studio Object Store Connector には適用されません。

Object Store v2 API へのアクセス

オブジェクトストアにアクセスするために、Postman などのアプリケーションをセットアップします。

オブジェクトストアのアクセス URL を設定し、ORG_ID を組織 ID に、ENV_ID を環境 ID に置き換えます。

BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/myTestStoreId/objects

デプロイメントリージョンに応じて、アクセス URL の BASE_URL の値では次のドメインのいずれかを使用できます。

コントロールプレーン BASE_URL リージョン

コントロールプレーン	BASE_URL	リージョン
米国	`object-store-us-east-1.anypoint.mulesoft.com`	米国東部 (北バージニア)
`object-store-us-east-2.anypoint.mulesoft.com`	米国東部 (オハイオ)
`object-store-us-west-1.anypoint.mulesoft.com`	米国西部 (北カリフォルニア)
`object-store-us-west-2.anypoint.mulesoft.com`	米国西部 (オレゴン)
`object-store-ap-southeast-1.anypoint.mulesoft.com`	アジア太平洋 (シンガポール)
`object-store-ap-southeast-2.anypoint.mulesoft.com`	アジア太平洋 (シドニー)
`object-store-ap-northeast-1.anypoint.mulesoft.com`	アジア太平洋 (東京)
`object-store-ca-central-1.anypoint.mulesoft.com`	カナダ (中央部)
`object-store-eu-central-1.anypoint.mulesoft.com`	欧州 (フランクフルト)
`object-store-eu-west-1.anypoint.mulesoft.com`	欧州 (アイルランド)
`object-store-eu-west-2.anypoint.mulesoft.com`	欧州 (ロンドン)
`object-store-sa-east-1.anypoint.mulesoft.com`	南米 (サンパウロ)
米国 MuleSoft Government Cloud	`object-store-us-gov-west-1.gov.anypoint.mulesoft.com`	US Gov West (米国政府西部)
EU	`object-store-eu-central-1.eu1.anypoint.mulesoft.com`	欧州 (フランクフルト)
`object-store-eu-west-1.eu1.anypoint.mulesoft.com`	欧州 (アイルランド)

米国

object-store-us-east-1.anypoint.mulesoft.com

米国東部 (北バージニア)

object-store-us-east-2.anypoint.mulesoft.com

米国東部 (オハイオ)

object-store-us-west-1.anypoint.mulesoft.com

米国西部 (北カリフォルニア)

object-store-us-west-2.anypoint.mulesoft.com

米国西部 (オレゴン)

object-store-ap-southeast-1.anypoint.mulesoft.com

アジア太平洋 (シンガポール)

object-store-ap-southeast-2.anypoint.mulesoft.com

アジア太平洋 (シドニー)

object-store-ap-northeast-1.anypoint.mulesoft.com

アジア太平洋 (東京)

object-store-ca-central-1.anypoint.mulesoft.com

カナダ (中央部)

object-store-eu-central-1.anypoint.mulesoft.com

欧州 (フランクフルト)

object-store-eu-west-1.anypoint.mulesoft.com

欧州 (アイルランド)

object-store-eu-west-2.anypoint.mulesoft.com

欧州 (ロンドン)

object-store-sa-east-1.anypoint.mulesoft.com

南米 (サンパウロ)

米国

MuleSoft Government Cloud

object-store-us-gov-west-1.gov.anypoint.mulesoft.com

US Gov West (米国政府西部)

object-store-eu-central-1.eu1.anypoint.mulesoft.com

欧州 (フランクフルト)

object-store-eu-west-1.eu1.anypoint.mulesoft.com

欧州 (アイルランド)

オブジェクトストアに対して値の保存や読み取りができるように、HTTP ヘッダーおよび本文でアプリケーションを設定します。
操作を Object Store v2 API に送信します。

例: オブジェクトストアのリストを取得する

オブジェクトストアのリストを表示するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X GET \
 'https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores' \
 -H 'authorization: bearer ACCESS_TOKEN'

このコマンドにより、次のような出力が返されます。

  {"values":[{"storeId":"APP_os-simple-flow__defaultPersistentObjectStore","encrypted":true,"permanentOsFlag":false,
    "persistent":true,"defaultTtlSeconds":2592000,"defaultConfirmationTtlSeconds":600,"isFixedTtl":null},
  {"storeId":"APP_scheduler-tests__defaultPersistentObjectStore","encrypted":true,"permanentOsFlag":false,
    "persistent":true,"defaultTtlSeconds":2592000,"defaultConfirmationTtlSeconds":600,"isFixedTtl":null}
  {"storeId":"APP_sending-a-csv-file-thru-email-using-smtp__defaultPersistentObjectStore","encrypted":true,"permanentOsFlag":false,
    "persistent":true,"defaultTtlSeconds":2592000,"defaultConfirmationTtlSeconds":600,"isFixedTtl":null}],"nextPageToken":null}json

例: リージョンのリストを取得する

リージョンのリストを表示するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X GET \
 'https://BASE_URL/api/v1/organizations/ORG_ID/regions' \
 -H 'authorization: Bearer ACCESS_TOKEN'

このコマンドにより、次のような出力が返されます。

[
  {
    "id": "us-east-1",
    "name": "US East (N. Virginia)",
    "url": "http://object-store.us-east-1.anypoint.mulesoft.com"
  },
  {
    "id": "us-west-1",
    "name": "US West (N. California)",
    "url": "http://object-store.us-west-1.anypoint.mulesoft.com"
  }
]json

例: パーティションのリストを取得する

パーティションのリストを表示するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、STORE_ID をオブジェクトストアリストの storeId に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X GET \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドにより、次のような出力が返されます。

  {"values":["PARTITION_ID"],"nextPageToken":null}json

例: パーティションのキーのリストを取得する

パーティションのキーを表示するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、STORE_ID をオブジェクトストアの名前に、PARTITION_ID をパーティションの名前に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X GET \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドにより、次のような出力が返されます。

{"values":[{"keyId":"KeyTwo"},{"keyId":"KeyOne"}],"nextPageToken":null}json

例: キーの値を取得する

キーの値を表示するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、STORE_ID をオブジェクトストアの名前に、PARTITION_ID をパーティションの名前に、KEY_ID をキー ID に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X GET \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys/KEY_ID \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドにより、次のような出力が返されます。

{"binaryValue":"++Kn0AIBAQBbwoABDiJLZXkgMiBWYWx1ZSL8rNmhAQEBAWphdmEuaW8uU2VyaWFsaXphYmzlgGFwcGxpY2F0aW9uL2pzb247IGNoYXJzZXQ9VVRGLbgAAAAAAAAADQ==","keyId":"KeyTwo","valueType":"BINARY"}json

例: キー-値ペアを保存する

キー-値ペアを保存するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、STORE_ID をオブジェクトストアの名前に、PARTITION_ID をパーティションの名前に、ACCESS_TOKEN をアクセストークンに置き換えて、KEY_ID の値 (myTestKey) を指定します。

KEY_ID=myTestKey; \
curl -X POST \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys/myTestKey \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"stringValue":"Hello World","keyId":"myTestKey","valueType":"STRING"}'

このコマンドでは、値は JSON 文字列になります。

キー-値ペアがオブジェクトストアにあることを確認するには、パーティションのキーのリストを取得します。

curl -X GET \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドにより、次のような出力が返されます。

{"values":[{"keyId":"KeyTwo"},{"keyId":"KeyOne"},{"keyId":"myTestKey"}],"nextPageToken":null}json

例: キーと値を削除する

キー-値ペアを削除するには、次のような curl コマンドを送信し、BASE_URL をリージョンのドメインに、ORG_ID を組織 ID に、ENV_ID を環境 ID に、STORE_ID をオブジェクトストアの名前に、PARTITION_ID をパーティションの名前に、KEY_ID をキー ID に、ACCESS_TOKEN をアクセストークンに置き換えます。

curl -X DELETE \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys/KEY_ID \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドでは、値は JSON 文字列になります。

キー-値ペアがオブジェクトストアからなくなったことを確認するには、パーティションのキーのリストを取得します。

curl -X GET \
  https://BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID/partitions/PARTITION_ID/keys \
  -H "Authorization: Bearer ACCESS_TOKEN"

このコマンドにより、次のような出力が返されます。

{"values":[{"keyId":"KeyTwo"},{"keyId":"KeyOne"}],"nextPageToken":null}json

Object Store v2 Stats API

Object Store v2 Stats API により、Object Store 使用量に関する統計を取得できます。

使用量統計はリアルタイムではなく、レイテンシーが含まれている場合があります。

Stats API を使用して、請求目的で組織全体の Object Store の使用量を表示します。

ルート組織とすべてのサブ組織ごとの使用量
組織ごとの使用量
環境ごとの使用量
リージョンごとの使用量
ストアごとの使用量

Object Store v2 Stats API へのアクセス

オブジェクトストアにアクセスするために、Postman などのアプリケーションをセットアップします。
アクセス URL を設定し、ORG_ID を組織 ID に、ENV_ID を環境 ID に置き換えます。

https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID/environments/ENV_ID?startDate=...&endDate=...&period=...
オブジェクトストアに対して値の保存や読み取りができるように、HTTP ヘッダーおよび本文でアプリケーションを設定します。
操作を Object Store v2 Stats API に送信します。

例: Object Store v2 Stats API

例: 組織別の使用状況メトリクスの取得
例: 環境別の使用状況メトリクスの取得
例: リージョン別の使用状況メトリクスの取得
例: ストア別の使用状況メトリクスの取得

例: 組織別の使用状況メトリクスの取得

デフォルトでは、Object Store v2 Stats API エンドポイントでは、指定された ORG_ID の統計のみを取得します。ルート組織とすべてのサブ組織の使用量データを取得するには、ORG_ID がルート組織の場合に isMaster を true に設定します。 isMaster=true を使用してサブ組織を照会した場合、エンドポイントでは結果は返されません。

2023 年 7 月 11 日から 2023 年 9 月 11 日までのルート組織とすべてのサブ組織の Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID をルート組織の組織 ID に、BEARER_TOKEN をベアラートークンに置き換えます。

curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID?startDate=2023-07-11T17%3A51%3A54.000Z&endDate=2023-09-11T17%3A51%3A54.000Z&period=1month&isMaster=true' \
  -H 'authorization: Bearer BEARER_TOKEN'

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2023-07-01T00:00:00Z","objectStoreRequestCount":0},
 {"timeStamp":"2023-08-01T00:00:00Z","objectStoreRequestCount":38},
 {"timeStamp":"2023-09-01T00:00:00Z","objectStoreRequestCount":28}
]json

1 日のルート組織とすべてのサブ組織の Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID をルート組織の組織 ID に、BEARER_TOKEN をベアラートークンに置き換えます。

curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID?startDate=2023-11-11T17%3A51%3A54.000Z&endDate=2023-11-131T17%3A51%3A54.000Z&period=1day&isMaster=true' \
  -H 'authorization: Bearer BEARER_TOKEN'

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2023-11-11T00:00:00Z","objectStoreRequestCount":36}
 {"timeStamp":"2023-11-12T00:00:00Z","objectStoreRequestCount":22}
 {"timeStamp":"2023-11-13T00:00:00Z","objectStoreRequestCount":43}

]json

2023 年 2 月 10 日から 2023 年 4 月 10 日までのサブ組織の Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID をサブ組織の組織 ID に、BEARER_TOKEN をベアラートークンに置き換えます。

curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID?startDate=2023-02-10T17%3A51%3A54.000Z&endDate=2023-04-10T17%3A51%3A54.000Z&period=1month' \
  -H 'authorization: Bearer BEARER_TOKEN'

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2023-02-10T00:00:00Z","objectStoreRequestCount":1},
 {"timeStamp":"2023-03-10T00:00:00Z","objectStoreRequestCount":15},
 {"timeStamp":"2023-04-10T00:00:00Z","objectStoreRequestCount":2}
]json

サブ組織の 1 日の Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID をサブ組織の組織 ID に、BEARER_TOKEN をベアラートークンに置き換えます。

curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID?startDate=2023-12-01T17%3A51%3A54.000Z&endDate=2023-12-03T17%3A51%3A54.000Z&period=1day' \
  -H 'authorization: Bearer BEARER_TOKEN'

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2023-12-01T00:00:00Z","objectStoreRequestCount":4}
 {"timeStamp":"2023-12-02T00:00:00Z","objectStoreRequestCount":2}
 {"timeStamp":"2023-12-03T00:00:00Z","objectStoreRequestCount":8}

]json

例: 環境別の使用状況メトリクスの取得

2021 年 6 月 13 日から 2021 年 9 月 13 日までの環境の Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID を組織 ID に、ENV_ID を環境 ID に、BEARER_TOKEN をベアラートークンに置き換えます。

curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID/environments/ENV_ID?startDate=2021-06-13T17%3A51%3A54.000Z&endDate=2021-09-13T17%3A51%3A54.000Z&period=1month' \
  -H 'authorization: Bearer BEARER_TOKEN'

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2021-06-01T00:00:00Z","objectStoreRequestCount":3},
 {"timeStamp":"2021-07-01T00:00:00Z","objectStoreRequestCount":30},
 {"timeStamp":"2021-08-01T00:00:00Z","objectStoreRequestCount":1},
 {"timeStamp":"2021-09-01T00:00:00Z","objectStoreRequestCount":25}
]json

例: リージョン別の使用状況メトリクスの取得

リージョンの Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID を組織 ID に、ENV_ID を環境 ID に、REGION_ID をメトリクスの取得元のリージョンに、BEARER_TOKEN をベアラートークンに置き換えます。

 curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID/environments/ENV_ID/regions/REGION_ID?startDate=2021-06-13T17%3A51%3A54.000Z&endDate=2021-09-13T17%3A51%3A54.000Z&period=1month' \
  -H 'authorization: Bearer BEARER_TOKEN'

REGION_ID を取得するには、「例: リージョンのリストを取得する」を参照してください。

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2021-06-01T00:00:00Z","objectStoreRequestCount":3},
 {"timeStamp":"2021-07-01T00:00:00Z","objectStoreRequestCount":30},
 {"timeStamp":"2021-08-01T00:00:00Z","objectStoreRequestCount":1},
 {"timeStamp":"2021-09-01T00:00:00Z","objectStoreRequestCount":25}
]json

例: ストア別の使用状況メトリクスの取得

ストアの Object Store 使用量統計を表示するには、次のような curl コマンドを送信し、ORG_ID を組織 ID に、ENV_ID を環境 ID に、REGION_ID をメトリクスの取得元のリージョンに、STORE_ID をメトリクスの取得の対象であるストア ID に、BEARER_TOKEN をベアラートークンに置き換えます。

 curl -X GET \
  'https://object-store-stats.anypoint.mulesoft.com/api/v1/organizations/ORG_ID/environments/ENV_ID/regions/REGION_ID/stores/STORE_ID?startDate=2021-06-13T17%3A51%3A54.000Z&endDate=2021-09-13T17%3A51%3A54.000Z&period=1month' \
  -H 'authorization: Bearer BEARER_TOKEN'

STORE_ID を取得するには、「例: オブジェクトストアのリストを取得する」を参照してください。

この要求により、次のような応答が返されます。

[
 {"timeStamp":"2021-06-01T00:00:00Z","objectStoreRequestCount":3},
 {"timeStamp":"2021-07-01T00:00:00Z","objectStoreRequestCount":30},
 {"timeStamp":"2021-08-01T00:00:00Z","objectStoreRequestCount":1},
 {"timeStamp":"2021-09-01T00:00:00Z","objectStoreRequestCount":25}
]json

Exchange から Object Store API をダウンロードする

Exchange から Object Store API をダウンロードするには、[Download (ダウンロード)] をクリックして RAML、OAS、または Mule 3 または Mule 4 のコネクタファイルの中からダウンロードする形式を選択します。

Figure 1. 矢印は、Exchange の [Download (ダウンロード)] ボタンを示しています。

Object Store v2 REST API

Object Store API を使用した認証

前提条件

アプリケーションのクライアント ID とクライアントシークレットを取得する

Object Store v2 API

制限事項

Object Store v2 API へのアクセス

例: Object Store v2 API

例: オブジェクトストアのリストを取得する

例: リージョンのリストを取得する

例: パーティションのリストを取得する

例: パーティションのキーのリストを取得する

例: キーの値を取得する

例: キー-値ペアを保存する

例: キーと値を削除する

Object Store v2 Stats API

Object Store v2 Stats API へのアクセス

例: Object Store v2 Stats API

例: 組織別の使用状況メトリクスの取得

例: 環境別の使用状況メトリクスの取得

例: リージョン別の使用状況メトリクスの取得

例: ストア別の使用状況メトリクスの取得

Exchange から Object Store API をダウンロードする

関連情報