REST APIリファレンス

前へ次へ

Secure Agentグループの作成、更新、および削除

runtimeEnvironmentリソースを使用して、Secure Agentグループを作成、更新、および削除できます。

POST要求を使用して、Secure Agentグループを作成および更新します。DELETE要求を使用して、Secure Agentグループを削除します。

POST要求

Secure Agentグループを作成するには、次のURIを使用します。

/api/v2/runtimeEnvironment

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String	○	Secure Agentグループの名前。
isShared	Boolean	-	Secure Agentグループをサブ組織と共有できるかどうか。

Secure Agentグループを更新するには、次のURIに示すようにエージェントグループIDを含めます。

/api/v2/runtimeEnvironment/<id>

エージェントを追加または削除し、Secure Agentグループの名前を変更できます。エージェントをあるSecure Agentグループから別のグループに移動するには、現在のグループからエージェントを削除する要求を送信してから、新しいグループにエージェントを追加する要求を送信します。

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String	○	Secure Agentグループの名前。
isShared	Boolean	-	Secure Agentグループをサブ組織と共有できるかどうか。
agents	配列	○	Secure Agentグループに割り当てられたエージェント。
orgId	String	○	組織ID。
id	String	○	エージェントID。

POST応答

フィールド	タイプ	説明
id	String	Secure AgentグループID。
orgId	String	組織ID。
name	String	Secure Agentグループ名。
description	String	Secure Agentグループの説明。
createTime	Date/Time	Secure Agentグループを作成した日時。
updateTime	Date/Time	Secure Agentグループが最後に更新された日時。
createdBy	String	Secure Agentグループを作成したユーザー。
updatedBy	String	Secure Agentグループを最後に更新したユーザー。
agents	配列	Secure Agentグループに割り当てられたエージェント。詳細については、agentリソースを参照してください。
isShared	Boolean	Secure Agentグループが共有されているかどうかを示します。次のいずれかの値を返します。 true。Secure Agentグループは共有されています。 false。Secure Agentグループは共有されていません。
federatedId	String	グローバル一意識別子。
serverlessConfig		サーバーレスランタイム環境プロパティを定義する属性。

POST要求の例

Secure Agentグループを作成する要求の例を以下に示します。

POST <serverUrl>/api/v2/runtimeEnvironment
Accept:application/json
icSessionId: <icSessionId>
{
  "@type": "runtimeEnvironment",
  "name": "14402",
  "isShared": true
}

Secure Agentグループにエージェントを追加する要求の例を以下に示します。

POST <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004
Accept:application/json
icSessionId: <icSessionId>
{
  "@type": "runtimeEnvironment",
  "name": "14401",
  "agents": [
    {
      "@type": "agent",
      "id": "01000308000000000003",
      "orgId": "010003"
    }
  ],
  "isShared": false
}

POST応答の例

次の例のような応答を受信します。

{
  "@type": "runtimeEnvironment",
  "id": "01000325000000000005",
  "orgId": "010003",
  "name": "USW1MJ02W6PP-2",
  "createTime": "2021-11-09T17:20:55.583Z",
  "updateTime": "2021-11-09T17:20:55.583Z",
  "createdBy": "ctan",
  "updatedBy": "ctan",
  "agents": [],
  "isShared": false,
  "federatedId": "9F4z0pY1kKqdlmLp5kYXkF",
  "createTimeUTC": "2021-11-09T22:20:55.583Z",
  "updateTimeUTC": "2021-11-09T22:20:55.583Z",
  "serverlessConfig": {
    "cloudProviderConfig": {
      "cloudConfig": []
    }
  }
}

DELETE要求

Secure Agentグループを削除するには、次のURIに示すようにエージェントグループIDを含めます。

/api/v2/runtimeEnvironment/00000425000000000034

ランタイム環境

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

Secure Agentグループの作成、更新、および削除

Secure Agentグループの作成、更新、および削除

POST要求

POST応答

POST要求の例

POST応答の例

DELETE要求