サービス・リストの取得
get
/services/{version}/installation/services
必要なロール: ユーザー
インストールのすべてのOracle GoldenGateサービスのリストを取得します。
リクエスト
パス・パラメータ
- version(必須): string
Oracle GoldenGateサービスのAPIバージョン。
指定できる値:[ "v2" ]
問合せパラメータ
- deployment: string
結果をフィルタリングするためのデプロイメントの名前
- service: string
結果をフィルタリングするためのサービスの名前
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
サービス・リストが正常に取得されました。
ルート・スキーマ: Oracle GoldenGate Services for the Installation
型:
objectタイトル:
Oracle GoldenGate Services for the InstallationインストールのすべてのOracle GoldenGateサービスのリスト
ソースの表示
- $schema:
指定できる値:
[ "ogg:installationServices" ] - services(必須): array services
最小アイテム数:
1最大アイテム数:64インストールのサービスの配列
ネストされたスキーマ: items
型:
objectサービス特性
ソースの表示
- critical(必須): boolean
デフォルト値:
trueサービスがデプロイメントにとってクリティカルであることを示します - deploymentId(必須): string
最小長:
36最大長:36パターン:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$このサービスのデプロイメントの一意の識別子 - deploymentName(必須): string
最小長:
1最大長:32パターン:^[A-Za-z][A-Za-z0-9-_.]*$このサービスのデプロイメントの名前 - enabled(必須): boolean
デフォルト値:
trueサービスがService Managerによって管理されることを示します - isSsl: boolean
サービスがSSL接続を想定することを示します
- links: array links
最小アイテム数:
0最大アイテム数:16サービスの追加のリンク - listeners: array listeners
最小アイテム数:
1最大アイテム数:64サービスのリスナー指定の配列 - locked: boolean
デフォルト値:
falseサービスがセキュリティ管理者によってロックされており、開始できないことを示します - serviceId(必須): string
最小長:
36最大長:36パターン:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$このサービスの一意の識別子 - serviceName(必須): string
最小長:
1最大長:64このサービスの名前 - status(必須):
デフォルト値:
stopped指定できる値:[ "starting", "running", "stopped", "restart", "killed", "abended" ]サービスのステータスを示します
ネストされたスキーマ: listeners
型:
array最小アイテム数:
1最大アイテム数:
64サービスのリスナー指定の配列
ソースの表示
- 配列: object items
サービス・リスナーの説明
ネストされたスキーマ: items
型:
ソースの表示
object- $schema:
指定できる値:
[ "ogg:link" ] - description: string
最小長:
1最大長:4095このリンク固有の情報と詳細を提供する、人が読むための説明。 - href(必須): string
最小長:
2最大長:4095パターン:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$リンクの絶対URI - mediaType: string
最小長:
6最大長:255パターン:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$メディア・タイプ - RFC 4288 (https://tools.ietf.org/html/rfc4288)を参照 - rel(必須):
指定できる値:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]hrefとリクエスト対象のリンクlinkの関係
ネストされたスキーマ: items
型:
objectサービス・リスナーの説明
ソースの表示
- address(必須): address
サービスがリスニングするIPアドレス
- port(必須): integer
最小値:
1最大値:65535サービスがリスニングするポート番号
ネストされたスキーマ: address
サービスがリスニングするIPアドレス
1つに一致
ソースの表示
- string
最小長:
7最大長:15パターン:^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ネットワークIPv4アドレス - string
最小長:
1最大長:256パターン:^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$ネットワークIPv6アドレス
レスポンスの例(application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9012/services/v2/installation/services",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/installation/services",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:9012/services/v2/metadata-catalog/services",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:installationServices",
"services":[
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
"status":"running",
"critical":true,
"serviceName":"adminsrvr",
"links":[
{
"href":"http://localhost:9012/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
},
{
"href":"http://localhost:9012/services/v2/content/",
"mediaType":"text/html",
"rel":"ogg://service"
}
],
"locked":false,
"serviceId":"515c56a9-b1f2-434b-ba7b-5af584e00dcd",
"listeners":[
{
"address":"127.0.0.1",
"port":"9012"
},
{
"address":"172.17.0.6",
"port":"9012"
},
{
"address":"172.18.0.1",
"port":"9012"
},
{
"address":"172.20.0.1",
"port":"9012"
},
{
"address":"172.21.0.1",
"port":"9012"
},
{
"address":"192.168.80.1",
"port":"9012"
},
{
"address":"192.168.96.1",
"port":"9012"
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
"status":"running",
"critical":true,
"serviceName":"distsrvr",
"links":[
{
"href":"http://localhost:9013/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
},
{
"href":"http://localhost:9013/services/v2/content/",
"mediaType":"text/html",
"rel":"ogg://service"
}
],
"locked":false,
"serviceId":"bb732d56-3dd2-4f86-b09c-de1fe01832f4",
"listeners":[
{
"address":"127.0.0.1",
"port":"9013"
},
{
"address":"172.17.0.6",
"port":"9013"
},
{
"address":"172.18.0.1",
"port":"9013"
},
{
"address":"172.20.0.1",
"port":"9013"
},
{
"address":"172.21.0.1",
"port":"9013"
},
{
"address":"192.168.80.1",
"port":"9013"
},
{
"address":"192.168.96.1",
"port":"9013"
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
"status":"running",
"critical":false,
"serviceName":"pmsrvr",
"links":[
{
"href":"http://localhost:9015/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
},
{
"href":"http://localhost:9015/services/v2/content/",
"mediaType":"text/html",
"rel":"ogg://service"
}
],
"locked":false,
"serviceId":"8cf6db2f-5f72-412d-b4e3-a2f49f3d804e",
"listeners":[
{
"address":"127.0.0.1",
"port":"9015"
},
{
"address":"172.17.0.6",
"port":"9015"
},
{
"address":"172.18.0.1",
"port":"9015"
},
{
"address":"172.20.0.1",
"port":"9015"
},
{
"address":"172.21.0.1",
"port":"9015"
},
{
"address":"192.168.80.1",
"port":"9015"
},
{
"address":"192.168.96.1",
"port":"9015"
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"fb399546-9e6e-4acb-a776-a53360c8c106",
"status":"running",
"critical":true,
"serviceName":"recvsrvr",
"links":[
{
"href":"http://localhost:9014/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
},
{
"href":"http://localhost:9014/services/v2/content/",
"mediaType":"text/html",
"rel":"ogg://service"
}
],
"locked":false,
"serviceId":"2ffa1858-0109-44a1-8fa2-c47dcca7948c",
"listeners":[
{
"address":"127.0.0.1",
"port":"9014"
},
{
"address":"172.17.0.6",
"port":"9014"
},
{
"address":"172.18.0.1",
"port":"9014"
},
{
"address":"172.20.0.1",
"port":"9014"
},
{
"address":"172.21.0.1",
"port":"9014"
},
{
"address":"192.168.80.1",
"port":"9014"
},
{
"address":"192.168.96.1",
"port":"9014"
}
]
}
]
}
}