---
schema_version: "1"
id: 845ec83d69c6fa707f4b677977ace8f755f05c4c40ca9c70a35fa3323f21d64c
title: Object Store v2 REST API
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/object-store/osv2-apis.md
canonical_url: https://docs.mulesoft.com/jp/object-store/osv2-apis
source_site: docs.mulesoft.com
content_type: documentation
content_hash: a372b0196758a6cc9827b987d42406928a0ec67a278fed20df9c3e7dd9e52e4b
description: MuleSoft Documentation Site
latest: true
---
# Object Store v2 REST API

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。</p>
</div>
</td>
</tr>
</tbody></table>

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

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

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

- [Object Store v2 API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2/)
- [Object Store v2 Stats API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2-stats/)

## [](#authenticate-os-apis)Object Store API を使用した認証

- [Object Store v2 API](#object-store-v2-api)
    
    Object Store API を使用して認証するにはベアラートークンが必要です。 ベアラートークンを取得するには、アプリケーションのクライアント ID とクライアントシークレットが必要です。
- [Object Store v2 Stats API](#object-store-v2-stats-api)
    
    Object Store v2 Stats API を使用して認証するにはアクセストークンが必要です。 アクセストークンを取得するには、​**組織のシステム管理者**​ロールが割り当てられたユーザーの Anypoint Platform ユーザー名とパスワードが必要です。

## [](#前提条件)前提条件

- Object Store v2 を使用するアプリケーションを作成し、CloudHub にデプロイします。
    
    [「CloudHub へのデプロイ」](https://docs.mulesoft.com/cloudhub/deploying-to-cloudhub)​を参照してください。
- オブジェクトストアにキー-値ペアを保存します。
    
    [「オブジェクトストアにデータを送信する」](https://docs.mulesoft.com/jp/object-store/osv2-guide#send-data-to-an-object-store)​を参照してください。
- Anypoint Platform ユーザーのアクセストークン (​ACCESS\_TOKEN​) を取得します。
    
    Object Store v2 Stats API にアクセスするには、ユーザーに​**組織のシステム管理者**​ロールが割り当てられている必要があります。
    
    Object Store v2 Stats API を使用して認証するにはアクセストークンが必要です。
    
    [「アクセス管理 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/)​の [「認証」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/Authentication/)​を参照してください。
- 組織 ID (​ORG\_ID​) を取得します。
    
    Object Store v2 API および Object Store v2 Stats API を使用した操作には組織 ID が必要です。
    
    [「アクセス管理 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/)​の ​`/api/me`​ エンドポイントを参照してください。
- 環境 ID (​ENV\_ID​) を取得します。
    
    Object Store v2 API および Object Store v2 Stats API を使用した操作には環境 ID が必要です。
    
    [「アクセス管理 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/)​の ​`/api/organizations/ORG_ID/environments`​ エンドポイントを参照してください。
- リージョン ID (​REGION\_ID​) を取得します。
    
    Object Store v2 Stats API を使用した操作にはリージョン ID が必要です。
    
    [「Object Store v2 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2/minor/1.0/pages/home/)​および「​[例: リージョンのリストを取得する](#例-リージョンのリストを取得する)​」で ​`/api/v1/organizations/ORG_ID/regions`​ エンドポイントを参照してください。
- ストア ID (​STORE\_ID​) を取得します。
    
    Object Store v2 Stats API を使用した操作にはストア ID が必要です。
    
    [「Object Store v2 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2/minor/1.0/pages/home/)​および「​[例: オブジェクトストアのリストを取得する](#例-オブジェクトストアのリストを取得する)​」で ​`/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/STORE_ID`​ エンドポイントを参照してください。
- アプリケーションのクライアント ID (​CLIENT\_ID​) とクライアントシークレット (​CLIENT\_SECRET​) を取得します。
    
    ベアラートークンを取得するにはクライアント ID とクライアントシークレットが必要です。
    
    [アプリケーションのクライアント ID とクライアントシークレットを取得する](#アプリケーションのクライアント-id-とクライアントシークレットを取得する)​を参照してください。
- アプリケーションのベアラートークン (​BEARER\_TOKEN​) を取得します。
    
    Object Store v2 API を使用して認証するにはベアラートークンが必要です。
    
    [「アクセス管理 API」](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/minor/1.0/pages/home/)​の ​`/accounts/oauth2/token`​ エンドポイントを参照してください。
    
    ベアラートークンを取得するには、アプリケーションのクライアント ID とクライアントシークレットが必要です。

### [](#アプリケーションのクライアント-id-とクライアントシークレットを取得する)アプリケーションのクライアント ID とクライアントシークレットを取得する

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

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

## [](#object-store-v2-api)Object Store v2 API

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

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

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 50%;">
<col style="width: 30%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Object Store v2 API</th>
<th class="tableblock halign-left valign-top">Object Store v2 REST API 操作</th>
<th class="tableblock halign-left valign-top">Object Store Connector 操作</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>POST</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p>オブジェクトストア</p>
<div class="ulist">
<ul>
<li>
<p>オブジェクトストアの TTL (秒)</p>
<div class="paragraph">
<p>最大 TTL は 2,592,000 秒 (30 日) です。</p>
</div>
<div class="paragraph">
<p>指定された ​<code>entryTtl</code>​ 値が 30 日より大きい場合、値のデフォルトは 2592000 秒 (30 日) になり、エラーは返されません。</p>
</div>
</li>
<li>
<p>永続性プロパティ</p>
</li>
<li>
<p>アプリケーションまたは環境ごとの使用制限。キーまたはサイズに基づいて制限するオプションやその適用方法を含みます</p>
</li>
</ul>
</div>
</li>
<li>
<p>キーおよびリスト (項目) 値</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Store (保存)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>GET</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p>Get keys (キーを取得)</p>
</li>
<li>
<p>Get item (項目を取得)</p>
</li>
<li>
<p>Get items (複数の項目を取得)</p>
</li>
<li>
<p>Get all items (すべての項目を取得)</p>
</li>
<li>
<p>Get regions for an organization (組織のリージョンを取得)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Contains (包含チェック) + Retrieve (取得) + Retrieve all keys (すべてのキーを取得) + Retrieve and store (取得して保存) (Retrieve 部分)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>PUT</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p>Put item as string (項目を文字列として更新)</p>
</li>
<li>
<p>Put item as number (項目を数値として更新)</p>
</li>
<li>
<p>Put item as confirmable string (項目を確認可能な文字列として更新)</p>
</li>
<li>
<p>Put store (更新して保存)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Dual Store (2 段階保存) ​<strong>†</strong>​ + Store (保存)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>DELETE</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
<ul>
<li>
<p>Remove object store (オブジェクトストアを削除)</p>
</li>
<li>
<p>Delete key (キーを削除)</p>
</li>
<li>
<p>Delete item (項目を削除)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Remove (削除)</p>
</div></div></td>
</tr>
</tbody>
</table>

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

1. `objectStore.store(key, value);`
2. `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-へのアクセス)Object Store v2 API へのアクセス

1. オブジェクトストアにアクセスするために、Postman などのアプリケーションをセットアップします。
2. オブジェクトストアのアクセス URL を設定し、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に置き換えます。
    
    `BASE_URL/api/v1/organizations/ORG_ID/environments/ENV_ID/stores/myTestStoreId/objects`
    
    デプロイメントリージョンに応じて、アクセス URL の ​BASE\_URL​ の値では次のドメインのいずれかを使用できます。
    
    <table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 15%;">
<col style="width: 75%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">コントロールプレーン</th>
<th class="tableblock halign-left valign-top">BASE_URL</th>
<th class="tableblock halign-left valign-top">リージョン</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top" rowspan="12"><p class="tableblock">米国</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>object-store-us-east-1.anypoint.mulesoft.com</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>米国東部 (北バージニア)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-us-east-2.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>米国東部 (オハイオ)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-us-west-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>米国西部 (北カリフォルニア)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-us-west-2.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>米国西部 (オレゴン)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-ap-southeast-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アジア太平洋 (シンガポール)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-ap-southeast-2.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アジア太平洋 (シドニー)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-ap-northeast-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>アジア太平洋 (東京)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-ca-central-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>カナダ (中央部)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-eu-central-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>欧州 (フランクフルト)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-eu-west-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>欧州 (アイルランド)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-eu-west-2.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>欧州 (ロンドン)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-sa-east-1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>南米 (サンパウロ)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">米国</p>
<p class="tableblock">MuleSoft Government Cloud</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>object-store-us-gov-west-1.gov.anypoint.mulesoft.com</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>US Gov West (米国政府西部)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top" rowspan="2"><p class="tableblock">EU</p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>object-store-eu-central-1.eu1.anypoint.mulesoft.com</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>欧州 (フランクフルト)</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>object-store-eu-west-1.eu1.anypoint.mulesoft.com</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>欧州 (アイルランド)</p>
</div></div></td>
</tr>
</tbody>
</table>
3. オブジェクトストアに対して値の保存や読み取りができるように、HTTP ヘッダーおよび本文でアプリケーションを設定します。
4. 操作を Object Store v2 API に送信します。

### [](#例-object-store-v2-api)例: Object Store v2 API

- [例: オブジェクトストアのリストを取得する](#例-オブジェクトストアのリストを取得する)
- [例: リージョンのリストを取得する](#例-リージョンのリストを取得する)
- [例: パーティションのキーのリストを取得する](#例-パーティションのキーのリストを取得する)
- [例: キーの値を取得する](#例-キーの値を取得する)
- [例: キー-値ペアを保存する](#例-キー-値ペアを保存する)
- [例: キーと値を削除する](#例-キーと値を削除する)

#### [](#例-オブジェクトストアのリストを取得する)例: オブジェクトストアのリストを取得する

オブジェクトストアのリストを表示するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​ACCESS\_TOKEN​ をアクセストークンに置き換えます。

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

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

```json
  {"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}
```

#### [](#例-リージョンのリストを取得する)例: リージョンのリストを取得する

リージョンのリストを表示するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ACCESS\_TOKEN​ をアクセストークンに置き換えます。

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

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

```json
[
  {
    "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"
  }
]
```

#### [](#例-パーティションのリストを取得する)例: パーティションのリストを取得する

パーティションのリストを表示するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​STORE\_ID​ をオブジェクトストアリストの ​`storeId`​ に、ACCESS\_TOKEN をアクセストークンに置き換えます。

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

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

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

#### [](#例-パーティションのキーのリストを取得する)例: パーティションのキーのリストを取得する

パーティションのキーを表示するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​STORE\_ID​ をオブジェクトストアの名前に、​PARTITION\_ID​ をパーティションの名前に、​ACCESS\_TOKEN​ をアクセストークンに置き換えます。

```console
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"
```

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

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

#### [](#例-キーの値を取得する)例: キーの値を取得する

キーの値を表示するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​STORE\_ID​ をオブジェクトストアの名前に、​PARTITION\_ID​ をパーティションの名前に、​KEY\_ID​ をキー ID に、​ACCESS\_TOKEN​ をアクセストークンに置き換えます。

```console
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"
```

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

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

#### [](#例-キー-値ペアを保存する)例: キー-値ペアを保存する

キー-値ペアを保存するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​STORE\_ID​ をオブジェクトストアの名前に、​PARTITION\_ID​ をパーティションの名前に、​ACCESS\_TOKEN​ をアクセストークンに置き換えて、KEY\_ID の値 (​`myTestKey`​) を指定します。

```console
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 文字列になります。

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

```console
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"
```

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

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

#### [](#例-キーと値を削除する)例: キーと値を削除する

キー-値ペアを削除するには、次のような ​`curl`​ コマンドを送信し、​BASE\_URL​ をリージョンのドメインに、​ORG\_ID​ を組織 ID に、​ENV\_ID​ を環境 ID に、​STORE\_ID​ をオブジェクトストアの名前に、​PARTITION\_ID​ をパーティションの名前に、​KEY\_ID​ をキー ID に、​ACCESS\_TOKEN​ をアクセストークンに置き換えます。

```console
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 文字列になります。

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

```console
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"
```

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

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

## [](#object-store-v2-stats-api)Object Store v2 Stats API

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

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

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

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

### [](#object-store-v2-stats-api-へのアクセス)Object Store v2 Stats API へのアクセス

1. オブジェクトストアにアクセスするために、Postman などのアプリケーションをセットアップします。
2. アクセス 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=...`
3. オブジェクトストアに対して値の保存や読み取りができるように、HTTP ヘッダーおよび本文でアプリケーションを設定します。
4. 操作を Object Store v2 Stats API に送信します。

### [](#例-object-store-v2-stats-api)例: Object Store v2 Stats API

- [例: 組織別の使用状況メトリクスの取得](#usage-by-org)
- [例: 環境別の使用状況メトリクスの取得](#usage-by-env)
- [例: リージョン別の使用状況メトリクスの取得](#usage-by-region)
- [例: ストア別の使用状況メトリクスの取得](#usage-by-store)

#### [](#usage-by-org)例: 組織別の使用状況メトリクスの取得

デフォルトでは、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 をベアラートークンに置き換えます。

```console
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'
```

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

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

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

```console
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'
```

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

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

]
```

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

```console
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'
```

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

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

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

```console
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'
```

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

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

]
```

#### [](#usage-by-env)例: 環境別の使用状況メトリクスの取得

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

```console
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'
```

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

```json
[
 {"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}
]
```

#### [](#usage-by-region)例: リージョン別の使用状況メトリクスの取得

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

```console
 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​ を取得するには、「​[例: リージョンのリストを取得する](#例-リージョンのリストを取得する)​」を参照してください。

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

```json
[
 {"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}
]
```

#### [](#usage-by-store)例: ストア別の使用状況メトリクスの取得

ストアの Object Store 使用量統計を表示するには、次のような ​`curl`​ コマンドを送信し、ORG\_ID を組織 ID に、​ENV\_ID​ を環境 ID に、​REGION\_ID​ をメトリクスの取得元のリージョンに、​STORE\_ID​ をメトリクスの取得の対象であるストア ID に、​BEARER\_TOKEN​ をベアラートークンに置き換えます。

```console
 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​ を取得するには、「​[例: オブジェクトストアのリストを取得する](#例-オブジェクトストアのリストを取得する)​」を参照してください。

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

```json
[
 {"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}
]
```

## [](#exchange-から-object-store-api-をダウンロードする)Exchange から Object Store API をダウンロードする

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

![Exchange での Object Store v2 API のダウンロード](/mulesoft/current/ja-jp/object-store/_images/os-exchange-download.png)

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

## [](#関連情報)関連情報

- [ローリング TTL](https://docs.mulesoft.com/jp/object-store/#rolling-ttl)
- [Anypoint Exchange の Object Store v2 API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2/)
- [Anypoint Exchange の Object Store v2 Stats API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/object-store-v2-stats/)
- [アクセス管理 API](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/access-management-api/)
- [Mule 4 用 Object Store Connector](https://docs.mulesoft.com/object-store-connector/latest/)
- [Mule 3 用 Object Store Connector](#3.9@mule-runtime::object-store-connector.adoc)