REST APIリファレンス > PowerCenter用クラウドデータ統合（CDI-PC）REST API > ドメインの登録
  

ドメインの登録

POST要求を使用して、IDMCにCDI-PCドメインを登録します。
注:
Kerberos認証済みのCDI-PCドメインは、REST APIを使用して登録することはできません。ドメインがKerberos認証を使用している場合は、IDMCサービスにログインし、CDI-PCホームページでドメインを登録してください。

POST要求

CDI-PCドメインを登録するには、次のPOST要求を使用します。
POST /public/api/v1/domains

パラメータ

REST APIを使用してIDMCでCDI-PCドメインを登録するには、ドメインの設定と認証資格情報を詳細に記した特定のパラメータを持つ要求を指定します。
次の例は、ドメイン登録APIに対する一般的な要求の構造と内容を示しています。
POST /public/api/v1/domains
Content-Type: application/json
IDS-SESSION-ID: <your-session-token>

{
"domainAuthInfo": {
"username": "string",
"password": "string",
"namespace": "string"
},
"domainName": "string",
"domainDisplayName": "string",
"domainHost": "string",
"domainPort": 1,
"description": "string",
"kerberos": false,
"environmentType": "NONE",
"secureAgentGroup": {
"agentGroupSaasId": "string"
}
}
次の表に、ヘッダーコンポーネントのパラメータを示します。
属性
タイプ
説明
IDS-SESSION-ID
文字列
セッションID値を保持するヘッダーのIDS-SESSION-ID属性。
組織でセッションID認証タイプを使用する場合は、セッションベースの認証が使用されます。セッションIDは、30分間の非アクティブ状態の後で期限切れになります。ネットワークまたは予期しない遅延を考慮して、最大2分間の猶予期間が含まれる場合があります。

要求本文

次の表に、要求本文の属性を示します。
属性
タイプ
説明
domainAuthInfo
文字列
ドメインの認証の詳細が含まれています。
  • - username: 特定のドメインへのアクセス認証に使用するユーザー名。これにより、ドメインの認証システム内でユーザーを識別します。
  • - password: ユーザー名に対応するパスワード。
  • - namespace: ドメイン認証に関連付けられている名前空間。
domainName
文字列
登録するCDI-PCドメインの名前。
domainDisplayName
文字列
CDI-PCドメインの表示名。
デフォルトでは、表示名はドメイン名と同じになります。
必要に応じて名前を更新できます。名前はドメイン名とは異なる場合がありますが、組織内で一意である必要があります。
domainHost
文字列
ゲートウェイノードマシンのホスト名またはIPアドレス。
domainPort
整数
ドメインホストに接続するときに使用するHTTPSポート番号。
説明
文字列
ドメインとその目的についての簡単な説明。
kerberos
ブール
Kerberos認証が有効か（true）または無効か（false）どうかを示すブールフラグ。
environmentType
文字列
ドメインの環境タイプを指定します。例えば、 NONE、DEV、QA、PRODなどです。
secureAgentGroup
文字列
ドメインに関連付けられたSecure Agentグループに関する情報が含まれます。
agentGroupSaasId
文字列
データ統合タスクの管理に使用するSecure AgentグループのSaaS ID。

応答

次の表に、登録API要求に対する一般的な応答を示します。
フィールド
説明
サンプル例
200
成功応答。
注:
応答には論理ドメインオブジェクトID（ldoId）が含まれます。これはIDMCが登録時にドメインに割り当てる一意の識別子です。
このドメインに対する今後すべてのAPI要求のURLに、このldoIdを含める必要があります。ldoIdを使用して、登録解除や調整などさまざまなライフサイクルアクション全体でドメインを追跡します。
{
"message": "string",
"domainVersion": "string",
"latestAvailableVersion": "string",
"applyDeadline": 0,
"domainVersionState": "SUPPORTED",
"ldoId": "string",
"pdoId": "string"
}
400
不正な要求です。無効な文字がある、文字列の長さが正しくないなど、フィールドまたは形式の問題である可能性があります。
{
"result": {
"output": {
"errorInfo": {
"error": {
"code": "string",
"message": "string",
"debugMessage": "string",
"requestId": "string",
"details": [
"errorContext": {
"component": "string",
"componentId": "string",
"sanitizedLogDirectoryPaths": string
}
}
}
}
}
401
認証の問題。例えば、無効な認証情報または無効なセッションIDです。
認証情報またはセッションIDが無効である場合、「JWT処理中に例外が発生しました」または「不正リクエストエラー」などの応答が表示されることがあります。
500
予期せぬ状況が発生した場合の内部サーバーエラー。
{
"result": {
"output": {
"status": "string",
"message": "string",
"data": {}
},
"errorInfo": {
"error": {
"code": "string",
"message": "string",
"debugMessage": "string",
"requestId": "string",
"details": [
{
"code": "string",
"message": "string",
"debugMessage": "string"
}
],
"errorContext": {
"component": "string",
"componentId": "string",
"sanitizedLogDirectoryPaths": [
"string"
]
}
}