---
schema_version: "1"
id: e2b05672fbf2aff38b66f47d1da2f46a99926c3f0c9ca906ef11bdcffd941778
title: DataGraph API ソース管理の CLI
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/anypoint-cli/3.x/datagraph-source.md
canonical_url: https://docs.mulesoft.com/jp/anypoint-cli/3.x/datagraph-source
source_site: docs.mulesoft.com
content_type: documentation
content_hash: c7caeb35750b1ad8b76e614ba0f12a2625e154a6fb6c0dd8e9ec554b16c483ff
description: MuleSoft Documentation Site
release: 3.x
latest: false
---
# DataGraph API ソース管理の CLI

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 35%;">
<col style="width: 65%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">コマンド</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-add">datagraph sources add</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースを追加する</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-promote">datagraph sources promote</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースを昇格する</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-update">datagraph sources update</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースを更新する</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-scale">datagraph scale</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>統合スキーマに対する API コールをスケーリングする</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-schema-download">datagraph schema-download</a></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"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-delete">datagraph sources delete</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースを削除する</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-get">datagraph sources get</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースを取得する</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-sources-list">datagraph sources list</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>すべての API ソースをリストする</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-describe">datagraph describe</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>DataGraph に関する情報を返す</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>​<a href="#datagraph-validate">datagraph validate</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>統合スキーマの API ソースを検証する</p>
</div></div></td>
</tr>
</tbody>
</table>

## [](#datagraph-sources-add)datagraph sources add

\> datagraph sources add <g/a/v>

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>DataGraph では、​<code>stable</code>​ 状態の API バージョンのみがサポートされています。</p>
</div>
</td>
</tr>
</tbody></table>

このコマンドは、​`<g/a/v>`​ で指定された API ソースを追加します。ここで、​`g`​ はグループ ID、​`a`​ はアセット ID、​`v`​ は API ソースのバージョン ID です。グループ ID は省略可能です。グループ ID を指定しない場合、このコマンドは現在の組織 ID を使用します。

このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 35%;">
<col style="width: 65%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">オプション</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-none</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API が公開の場合に使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-basic</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>基本認証ヘッダー、またはユーザー名とパスワードを渡して、API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-oauth</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>OAuth 2.0 の ​<code>client_id</code>​、​<code>client_secret</code>​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;client_id&gt;:&lt;client_secret&gt;</code>​</p>
</li>
<li>
<p><code>--server &lt;authorization server URL&gt;</code>​
​ <br>
 <br>
省略可能:</p>
</li>
<li>
<p><code>--scope &lt;server&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-pass-through</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>認証ヘッダーを渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>​<code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-headers</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
ヘッダーで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code>​</p>
<div class="paragraph">
<p>Or (または)</p>
</div>
</li>
<li>
<p><code>--custom-headers-file: &lt;location of the file containing header-value pairs, one per line&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-query-params</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
クエリパラメーターで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;client_id:client_secret&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--url &lt;url&gt;</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>バックエンド API の URL を設定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--discover-url</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--ca</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API のトラストストアに追加する認証機関 (CA) ファイルのカンマ区切りリストを指定します (​<code>file.ca,file2.ca</code>​ など)。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--cert</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>相互トランスポートレイヤーセキュリティ (mTLS) に使用するクライアント証明書のファイル名を指定します (​<code>cert.ca</code>​ など)。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>mTLS に使用する非公開キーのファイル名を指定します (​<code>key.pem</code>​ など)。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key-password</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"><div class="content"><div class="paragraph">
<p><code>--ignore-invalid-edits</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API 仕様の拡張機能で行われた有効な編集を適用し、無効な編集を無視するために使用します。</p>
</div></div></td>
</tr>
</tbody>
</table>

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。</td></tr></tbody></table>

### [](#コマンド例)コマンド例

```copy
datagraph sources add 18dc11ee-4a09-4aae-9c6c-4371a87eafa8/product-api/1.0.0/  --url http://test.com
```

### [](#出力例)出力例

{
  "apiVersion": "v1",
  "assetId": "product-api",
  "createDate": "2022-05-20T18:05:41",
  "endpoint": "http://test.com",
  "environmentId": "<envID>",
  "groupId": "<groupID>",
  "name": "Product API",
  "organizationId": "<orgID>",
  "securityScheme": "NO\_AUTH",
  "sourceId": "deca7be1-c299-4441-bc7b-dba733e3a11f",
  "updateDate": "2022-05-20T18:05:41",
  "version": "1.0.0",
  "origin": "CLI"
}

## [](#datagraph-sources-promote)datagraph sources promote

\> datagraph sources promote <sourceId> <target-EnvID>

このコマンドは、API ソース ​`<sourceId>`​ を対象環境 ​`<targetEnv>`​ に昇格します。

このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 35%;">
<col style="width: 65%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">オプション</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-none</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API が公開の場合に使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-basic</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>基本認証ヘッダー、またはユーザー名とパスワードを使用して、API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-oauth</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>OAuth 2.0 の ​<code>client_id</code>​、​<code>client_secret</code>​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--client-credentials &lt;client_id&gt;:&lt;client_secret&gt;</code>​</p>
</li>
<li>
<p><code>--server &lt;authorization server URL&gt;</code>​
​ <br>
 <br>
省略可能:</p>
</li>
<li>
<p><code>--scope &lt;server&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-pass-through</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>認証ヘッダーを渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>​<code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-headers</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
ヘッダーで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code>​</p>
<div class="paragraph">
<p>Or (または)</p>
</div>
</li>
<li>
<p><code>--custom-headers-file: &lt;location of the file containing header header-value pairs, one per line&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-query-params</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
クエリパラメーターで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;client_id:client_secret&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--url</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>バックエンド API の URL を設定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--discover-url</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--ca</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API のトラストストアに追加する CA ファイルのリストを指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--cert</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>mTLS に使用するクライアント証明書を指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>mTLS に使用する非公開キーを指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key-password</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"><div class="content"><div class="paragraph">
<p><code>--empty-ca</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>すべての CA 証明書を削除します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--empty-mtls</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クライアント証明書、非公開キー、非公開キーパスワード情報を削除します。</p>
</div></div></td>
</tr>
</tbody>
</table>

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。</td></tr></tbody></table>

### [](#コマンド例-2)コマンド例

この例では、​`promote`​ コマンドの実行後に ​`environmentId`​ が変更されます。

```copy
datagraph sources promote d1d27987-939a-4b41-b3ef-411568ee5bdd e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6 --auth-none
```

### [](#出力例-2)出力例

{
  "apiVersion": "1.0",
  "assetId": "order-e2e",
  "createDate": "2022-05-27T18:56:03",
  "endpoint": "http://test.com",
  "environmentId": "e7e8da65-9cf1-569e-c9d2-brd2r0rc7rd6",
  "groupId": "<groupID>",
  "name": "Order E2E",
  "organizationId": "<orgID>",
  "securityScheme": "NO\_AUTH",
  "sourceId": "1ff021b3-9296-43fd-9d64-2f9027c25740",
  "updateDate": "2022-05-27T18:56:03",
  "version": "1.0.0",
  "origin": "CLI"
}

## [](#datagraph-sources-update)datagraph sources update

\> datagraph sources update <sourceId>

<table>
<tbody><tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>DataGraph では、​<code>stable</code>​ 状態の API バージョンのみがサポートされています。​<code>update</code>​ コマンドは、API ソースのパッチおよびマイナーバージョンのみを更新します。</p>
</div>
</td>
</tr>
</tbody></table>

このコマンドは、API ソース ​`<sourceId>`​ のバージョンを更新します。

このコマンドでは、デフォルトの ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ オプション以外に次のオプションも使用できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 35%;">
<col style="width: 65%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">オプション</th>
<th class="tableblock halign-left valign-top">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-none</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API が公開の場合に使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-basic</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>基本認証ヘッダー、またはユーザー名とパスワードの両方を渡して、API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;username&gt;:&lt;password&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-oauth</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>OAuth 2.0 の ​<code>client_id</code>​、​<code>client_secret</code>​、認証サーバーの値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;client_id&gt;:&lt;client_secret&gt;</code>​</p>
</li>
<li>
<p><code>--server &lt;authorization server URL&gt;</code>​
​ <br>
 <br>
省略可能:</p>
</li>
<li>
<p><code>--scope &lt;server&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-pass-through</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>認証ヘッダーを渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>​<code>--mapping: &lt;comma-separated list of key-value pairs, for example, key1:value1,key2:value2&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-headers</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>カスタムヘッダーパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
ヘッダーで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--custom-headers: &lt;comma-separated list of header-value pairs, for example, header1:value1,header2:value2&gt;</code>​</p>
<div class="paragraph">
<p>Or (または)</p>
</div>
</li>
<li>
<p><code>--custom-headers-file: &lt;location of the file containing header-value pairs, one per line&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--auth-query-params</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クエリパラメーターと値を渡して API に対する認証を行う場合に使用します。
 <br>
 <br>
クエリパラメーターで必須:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--credentials &lt;client_id:client_secret&gt;</code></p>
</li>
</ul>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--url</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>バックエンド API の URL を設定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--discover-url</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>現在の環境で実行されているインスタンスに基づいて、バックエンド API の URL を自動的に検出します。複数の API が実行されている場合、DataGraph は最初の URL を使用します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--ca</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API のトラストストアに追加する CA ファイルのリストを指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--cert</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>mTLS に使用するクライアント証明書を指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>mTLS に使用する非公開キーを指定します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--key-password</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"><div class="content"><div class="paragraph">
<p><code>--empty-ca</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>すべての CA 証明書を削除します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--empty-mtls</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"><div class="content"><div class="paragraph">
<p><code>--keep-edits</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースの現在のバージョンに存在する編集を、API 仕様から抽出する代わりに保持します。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--override-ui-edits</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API ソースの取得元を CLI に変更します。API ソースの取得元が DataGraph UI である場合、このオプションを使用して、UI の編集を API 仕様の編集で上書きします。</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><code>--ignore-invalid-edits</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>API 仕様の拡張機能で行われた有効な編集を適用し、無効な編集を無視するために使用します。</p>
</div></div></td>
</tr>
</tbody>
</table>

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">コマンドラインで定義されたすべてのヘッダーとクエリパラメーター、およびすべてのヘッダーとクエリパラメーターファイルが追加されます。反復キーがある場合、コマンドラインで指定された値が優先されます。</td></tr></tbody></table>

### [](#コマンド例-3)コマンド例

次のコマンドは、ソース API の URL を更新し、その認証を ​`auth-none`​ から ​`auth-basic`​ に変更して、クライアント ID とシークレットを追加します。

```copy
> datagraph sources update b6cb82a6-51dc-4968-861a-aa04447c3442 --url http://test2.com --version 1.0.0 --auth-basic --credentials client-test:client-secret
```

### [](#出力例-3)出力例

{
  "apiVersion": "v1",
  "assetId": "product-api",
  "createDate": "2022-05-20T18:56:57Z",
  "endpoint": "http://test2.com",
  "environmentId": "<envID>",
  "groupId": "<groupID>",
  "name": "Product API",
  "organizationId": "<orgID>",
  "securityScheme": "BASIC",
  "sourceId": "b6cb82a6-51dc-4968-861a-aa04447c3442",
  "updateDate": "2022-05-27T18:31:39",
  "version": "1.0.0",
  "origin": "CLI"
}

## [](#datagraph-scale)datagraph scale

\> datagraph scale <concurrent-api-calls>

このコマンドでは、統合スキーマで許可される同時 API コール数を設定できます。API コール数を増減することで、必要に応じて処理するワークロードを増やし、コンシュームを最適化できます。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#コマンド例-4)コマンド例

```copy
datagraph scale 300
```

### [](#出力例-4)出力例

{
  "message": "Api calls updated"
}

## [](#datagraph-schema-download)datagraph schema-download

\> datagraph schema-download

このコマンドは、現在の環境の統合スキーマをダウンロードします。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#出力例-5)出力例

directive @key(fields: String) on OBJECT

"An Item"
type Item {
  itemId: Int!
  "A Product"
  product: OrderProduct!
  quantity: Int!
}

"An Order"
type Order {
  items: \[Item!\]!
  orderId: String!
  customerId: String!
}

"A Product"
type OrderProduct {
  productId: String!
  name: String!
}

type Query {
  orders(ordersCount: Int): \[Order!\]
  ordersByOrderId(orderId: String!): Order
  ordersProductsByOrderId(productsCounts: Int, orderId: String!): \[OrderProduct!\]
}

## [](#datagraph-sources-delete)datagraph sources delete

\> datagraph sources delete <sourceId>

このコマンドは、指定された API ソースを削除します。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#コマンド例-5)コマンド例

```copy
datagraph sources delete d40df394-785d-4c91-8aeb-f07568dd57c
```

### [](#出力例-6)出力例

{
  "message": "Source deleted successfully",
  "sourceId": "620afe93-b196-42eb-ae77-b68a0a937b6a"
}

## [](#datagraph-sources-get)datagraph sources get

\> datagraph sources get <sourceId>

このコマンドは、指定された API ソースを取得します。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#コマンド例-6)コマンド例

```copy
datagraph sources get d1d27987-939a-4b41-b3ef-411568ee5bdd
```

### [](#出力例-7)出力例

{
  "apiVersion": "1.0",
  "assetId": "order-e2e",
  "createDate": "2022-05-20T16:49:00Z",
  "hasKeystore": false,
  "endpoint": "http://test.com",
  "environmentId": "<envID>",
  "groupId": "<groupID>",
  "name": "Order E2E",
  "organizationId": "<orgID>",
  "hasTruststore": false,
  "securityScheme": "NO\_AUTH",
  "sourceId": "d1d27987-939a-4b41-b3ef-411568ee5bdd",
  "updateDate": "2022-05-20T16:49:00Z",
  "version": "1.0.0",
  "origin": "CLI"
}

## [](#datagraph-sources-list)datagraph sources list

```copy
> datagraph sources list
```

このコマンドは、現在の環境のすべての API ソースをリストします。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#出力例-8)出力例

{
    "apiVersion": "1.0",
    "assetId": "order-e2e",
    "createDate": "2022-05-20T16:49:00.000Z",
    "endpoint": "http://test.com",
    "environmentId": "<envID>",
    "groupId": "<groupID>",
    "name": "Order E2E",
    "organizationId": "<orgID>",
    "securityScheme": "NO\_AUTH",
    "sourceId": "d1d27987-939a-4b41-b3ef-411568ee5bdd",
    "updateDate": "2022-05-20T16:49:00.000Z",
    "version": "1.0.0",
    "origin": "CLI"
  },
  {
    "apiVersion": "v1",
    "assetId": "product-api",
    "createDate": "2022-05-20T18:05:41.000Z",
    "endpoint": "http://test.com",
    "environmentId": "<envID>",
    "groupId": "<groupID>",
    "name": "Product API",
    "organizationId": "<orgID>",
    "securityScheme": "NO\_AUTH",
    "sourceId": "deca7be1-c299-4441-bc7b-dba733e3a11f",
    "updateDate": "2022-05-20T18:05:41.000Z",
    "version": "1.0.0",
    "origin": "CLI"
  }

## [](#datagraph-describe)datagraph describe

```copy
> datagraph describe
```

このコマンドは、DataGraph に関する次の情報を返します。

- `endpoint`​: 要求を受け入れる GraphQL エンドポイントを表示します。
- `deploymentError`​: DataGraph のデプロイメントが失敗した場合、この項目にエラーの情報が表示されます。それ以外の場合は空です。
- `deploymentStatus`​: DataGraph はデプロイ中、実行中、またはエラーがあるかどうかを示します。
- `logLevels`​: 設定されたログレベルのリストを表示します。
- `envStatus`​: 現在の環境の状況を表示します。
- `dlbEndpoint`​: ロードバランサーエンドポイントを表示します。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#出力例-9)出力例

{
  "deploymentStatus": "STARTED",
  "dlbEndpoint": "datagraph-example.us-e1.prod.cloudhub.io",
  "endpoint": "datagraph-example.us-e1.prod.cloudhub.io",
  "envStatus": "STARTED"
}

## [](#datagraph-validate)datagraph validate

\> datagraph validate asset <g/a/v>

このコマンドは、API ソースを統合スキーマに追加できるかどうかを検証します。そのために、このコマンドは次の処理を行います。

- API ソースを GraphQL スキーマに変換する。
- API 仕様に適用されている API 拡張機能を検証する。
- 統合スキーマに対して競合チェックを実行する。

これらのステップのいずれかで競合またはエラーが発生した場合、コマンドは結果を返します。競合やエラーが見つからない場合は、成功メッセージを返します。

検証する API ソースは、​`<g/a/v>`​ で指定されます。ここで、​`g`​ はグループ ID、​`a`​ はアセット ID、​`v`​ は API ソースのバージョン ID です。グループ ID は省略可能です。グループ ID を指定しない場合、このコマンドは現在の組織 ID を使用します。

このコマンドはデフォルトのオプション ​`--help`​、​`-f/--fields`​、​`-o/--output`​、​`--verbose`​ を受け入れます。

### [](#コマンド例-7)コマンド例

```copy
datagraph validate asset 73b0d8f2-5a2f-4107-884d-fcd80f30bc51/sales-api/1.0.0
```

### [](#出力例-10)出力例

{
  "code": "success"
}