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

ドメインの登録解除

PATCH要求を使用して、IDMCからCDI-PCドメインを登録解除します。

PATCH要求

CDI-PCドメインを登録解除するには、次のPATCH要求を使用します。
PATCH /public/api/v1/domains/{ldoId}/deregister
注:
URLパスには、それぞれに対応するPODの完全なドメイン管理サービスパスが含まれている必要があります。要求の先頭にこのパスを付けてください。

パラメータ

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

PATCH /public/api/v1/domains/{ldoId}/deregister

{
"domainAuthInfo": {
"username": "admin",
"password": "secretPassword",
"namespace": "Native"
}
次の表に、ヘッダーコンポーネントのパラメータを示します。
属性
タイプ
説明
IDS-SESSION-ID
文字列
セッションID値を保持するヘッダーのIDS-SESSION-ID属性。
組織でセッションID認証タイプを使用する場合は、セッションベースの認証が使用されます。セッションIDは、30分間の非アクティブ状態の後で期限切れになります。ネットワークまたは予期しない遅延を考慮して、最大2分間の猶予期間が含まれる場合があります。
ldoId
文字列
組織内の論理ドメインオブジェクトに割り当てられる一意識別子。ldoIdを、調整するドメインの実際のIDに置き換えてください。

要求本文

要求本文には、認証のためにdomainAuthInfoオブジェクトが必要です。

{ "domainAuthInfo": {
"username": "string",
"password": "string",
"namespace": "string"
}
}
次の表に、domainAuthInfoのフィールドを示します。
フィールド
タイプ
説明
username
文字列
特定のドメインへのアクセス認証に使用するユーザー名。これにより、ドメインの認証システム内でユーザーを識別します。
password
String
ユーザー名に対応するパスワード。
namespace
文字列
ドメイン認証に関連付けられている名前空間。

応答

次の表に、登録解除API要求に対する一般的な応答を示します。
フィールド
説明
サンプル例
200
成功応答。
{
"message": "string"
}
400
不正な要求です。無効な文字がある、文字列の長さが正しくないなど、フィールドまたは形式の問題である可能性があります。
{
"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"
]
}
}
}
}
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"
]
}
}
}
}