REST APIリファレンス

前へ次へ

ランタイム環境の詳細の取得

runtimeEnvironmentリソースを使用して、ランタイム環境の詳細を取得します。

特定のランタイム環境の詳細または組織のすべてのランタイム環境の詳細を要求できます。

組織のランタイム環境情報を要求するには、次のURIを使用します。

/api/v2/runtimeEnvironment

特定のランタイム環境の詳細を要求する場合、URIにランタイム環境IDまたは名前を含めることができます。次のいずれかのURIを使用します。

/api/v2/runtimeEnvironment/<id>

/api/v2/runtimeEnvironment/name/<name>

URIにランタイム環境名を使用し、ランタイム環境名にスペースが含まれる場合、スペースは

%20

に置き換えます。以下に例を示します。

/api/v2/runtimeEnvironment/name/my%20runtime%20environment

GET応答

要求されたランタイム環境のランタイム環境情報を返します。runtimeEnvironmentオブジェクトには次の属性が含まれます。

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

サーバーレスランタイム環境の情報を取得する場合、runtimeEnvironmentオブジェクトにはserverlessConfigオブジェクトも含まれます。serverlessConfigオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
platform	String	サーバーレスランタイム環境をホストするクラウドプラットフォーム。
applicationType	String	サーバーレスランタイム環境を使用できるアプリケーション。
status	String	サーバーレスランタイム環境のステータス。
statusMessage	String	サーバーレスランタイム環境のステータスメッセージ。
statusMessageDetails	String	サーバーレスランタイム環境のAWSからの検証エラーデータ。
cloudProviderConfig		基本のプロパティとデータ統合プロパティを定義します。
infaAccountNumber	String	cloudProviderConfigオブジェクトに含まれます。クラウドプラットフォームでの情報のアカウント番号。
externalId	String	cloudProviderConfigオブジェクトに含まれます。ロールに関連付ける外部ID。
configurationName	String	cloudProviderConfigオブジェクトに含まれます。サーバーレスランタイム環境の名前
configurationDescription	String	cloudProviderConfigオブジェクトに含まれます。サーバーレスランタイム環境の説明。
params		AWSリソース設定プロパティを定義します。
s3	String	paramsオブジェクトに含まれます。補足ファイルを保存するためのAmazon S3の場所。
subnet	String	paramsオブジェクトに含まれます。サブネットのID。
role	String	paramsオブジェクトに含まれます。サーバーレスランタイム環境が使用するロールの名前。
vpc	String	paramsオブジェクトに含まれます。 VPC（Amazon Virtual Private Cloud）のID。
externalId	String	paramsオブジェクトに含まれます。ロールに設定される外部ID。
securityGroup	String	paramsオブジェクトに含まれます。セキュリティグループID
accountNumber	String	paramsオブジェクトに含まれます。クラウドプラットフォームでのアカウント番号。
referenceId	String	paramsオブジェクトに含まれます。サーバーレスランタイム環境の参照に使用される内部ID。
computeUnits	String	paramsオブジェクトに含まれます。タスクが使用できるサーバーレスコンピューティングユニットの最大数。
executionTimeout	String	paramsオブジェクトに含まれます。タスクが完了するまでの待機時間（分）。
cloudInstanceId	String	paramsオブジェクトに含まれます。インスタンスID。
zone	String	paramsオブジェクトに含まれます。可用性ゾーンID。
region	String	paramsオブジェクトに含まれます。クラウドプラットフォームでのリージョン。
infaAccountNumber	String	paramsオブジェクトに含まれます。クラウドプラットフォームでの情報のアカウント番号。
awsTags	String	paramsオブジェクトに含まれます。 AWSタグ。
maxComputeUnits	String	タスクが使用できるサーバーレスコンピューティングユニットの最大数。
executionTimeout	String	タスクが完了するまでの待機時間（分）。

GETの例

特定のランタイム環境の詳細を要求するには、次の要求を使用できます。

GET <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

次のテキストは、JSON形式で返されたリストのサンプルです。

{
    "@type": "runtimeEnvironment",
    "id": "00000425000000000004",
    "orgId": "000004",
    "name": "SUT_Agent",
    "createTime": "2016-12-09T12:34:01.000Z",
    "updateTime": "2016-12-09T17:54:00.000Z",
    "createdBy": "org1@mycompany.com",
    "updatedBy": "org1@mycompany.com",
    "agents": [],
    "isShared": true,
    "federatedId": "<ID>"
  }

次のテキストは、サーバーレスランタイム環境の戻りのサンプルです。

{
        "@type": "runtimeEnvironment",
        "id": "01000000000000000039",
        "orgId": "010211",
        "name": "Serverless runtime environment 1",
        "description": "My serverless runtime environment",
        "createTime": "2020-08-25T13:21:16.000Z",
        "updateTime": "2020-08-25T13:29:43.000Z",
        "createdBy": "admin",
        "updatedBy": "admin",
        "agents": [],
        "isShared": false,
        "federatedId": "<ID>",
        "serverlessConfig": {
            "platform": "AWS",
            "applicationType": "CDI",
            "status": "RUNNING",
            "statusMessage": "Serverless runtime is running",
            "cloudProviderConfig": {
                "cloudConfig": [
                    {
                        "infaAccountNumber": "<ACCT_NUMBER>",
                        "externalId": "<EXT_ID>",
                        "configurationName": "Serverless runtime environment 1",
                        "configurationDescription": "My serverless runtime environment",
                        "params": {
                            "s3": "s3://my-bucket",
                            "subnet": "subnet-12345",
                            "role": "CDI_Serverless_Role",
                            "vpc": "vpc-12345",
                            "externalId": "<EXT_ID>",
                            "securityGroup": "sg-<SG_NUMBER>",
                            "accountNumber": "<ACCT_NUMBER",
                            "referenceId": "<REF_ID>",
                            "computeUnits": "1",
                            "executionTimeout": "2880",
                            "cloudInstanceId": "i-123456789",
                            "zone": "usw2-az3",
                            "region": "us-west-2",
                            "infaAccountNumber": "<ACCT_NUMBER>",
                            "awsTags": "Key=NAME,Value=test1 Key=EMAIL,Value=test1@informatica.com"
                        }
                    }
                ]
            },
            "maxComputeUnits": "1",
            "executionTimeout": "2880"
        }

ランタイム環境

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

ランタイム環境の詳細の取得

ランタイム環境の詳細の取得

GET応答

GETの例