このドキュメントでは、 Partnership API を使用してアカウントを管理する方法を説明します。子アカウントの場合は、 子アカウント オブジェクトを使用します。
要件
この API を使用する前に、次の点に注意してください。
- この API は、組織が New Relic の担当者から使用するように指示されていない限り、使用できません。
- この特定のオブジェクトを使用するためのアクセス権がない可能性があります。使用する前に、まず要件をお読みください。
アカウントオブジェクトの属性
Partnership API アカウントオブジェクトの属性を示します。
account API には、子アカウントを作成するための属性はありません。代わりに、子アカウントを作成するには、親アカウントの アカウント設定 ページ を New Relic UI で使用します。
アカウントAPIコール
以下に、アカウントAPI機能のURLパターンを示します。このURLパターンを使用する場合は、 Partner API key を含むHTTPヘッダをJSONリクエストボディと一緒に送信してください。例えば、以下のようになります。
GET .../api/v2/partners/:PARTNER_ID/accounts/:IDx-api-key: :PARTNER_ACCOUNT_KEYContent-Type: application/json
{ JSON data }
電話 | リソースのURLパターン |
---|---|
パートナーの全アカウントを一覧表示(index )。 |
|
Show アカウントの属性を表示します。 |
|
アップデート アカウントの属性を変更します。 |
|
指定されたパラメーターで アカウントを作成します。 |
|
Cancel an account. |
|
ステータスの定義
APIコールでアカウントを作成またはリストアップすると、アカウントのステータスが自動的に含まれます。これらのステータスの中には、すべての価格モデルに適用されないものもあります。
アカウントの状況 | 定義 |
---|---|
| 無料アカウントが作成されているが、プライマリ・アドミンがまだ有効になっていない。 |
| 有料会員で作成されたアカウントですが、プライマリ管理者がまだ有効になっていません。 |
| 無料アカウント、アクティブなプライマリ管理者、アプリケーションデータは収集されていません。 |
| 有料のサブスクリプション、アクティブな主管理者、アプリケーションデータは収集されていません。 |
| 無料購読、アプリケーションデータの受信 |
| 有料会員、アプリケーションデータの受信 |
| アカウントのサブスクリプションがアップグレードされました。 |
| アカウントのサブスクリプションがダウングレードされました。 |
| New Relic アカウントのサブスクリプションがキャンセルされました。 |
| プライマリ管理者がメールアドレスを認証していないため、New Relic アカウントが停止しています。 |
JSONの例
以下は、Partnership API のアカウントオブジェクトを使用した JSON リクエストとレスポンスの例です。
これは単なる例であり、一部のアカウントでは、 users
}属性とsubscriptions
属性は不要であり、無視されることに注意してください。
アカウントオブジェクトAPIの例
アカウント数が1000を超えるパートナーシップでは、ページ分割された応答が返されます。ページを指定するには、クエリに以下のパラメータを追加します。
?page=
PartnershipAPIアカウントオブジェクトを使用した呼び出しの例を次に示します。これらは例であり、一部のアカウントでは、 users
}属性とsubscriptions
属性は適用されず、無視されることに注意してください。