2.14.1 ポッドの一覧の取得
ポッドの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Pods
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "name":"...", "status":"...", "monitorStatus":"...", "nodeID":"...", "nodeName":"...", "nodeMonitorStatus":"...", "clusterName":"...", "namespace":"...", "ownerReferences":"...", "labels":"...", "groupIDs":["...", ...], "groupNames":["...", ...], "gradeNames":["...", ...], "gradeOrders":["...", ...], "collectorID":"...", "collectorName":"...", "autoCollectionType":"...", "usedCredentialID":"...", "usedCredentials":"...", "accessPointType":"...", "accessPointIpAddress":"...", "accessPointUser":"...", "pluginId":"...", "pluginName":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Pod[] |
Podのコレクション。Podの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Pod)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
ポッドの名称 |
status |
enum |
ポッドの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
ポッドの監視状態。 (指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
nodeID |
long |
ポッドが属するコンテナノードのID |
nodeName |
string |
ポッドが属するコンテナノードの名称 |
nodeMonitorStatus |
enum |
ポッドが属するコンテナノードの監視状態 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
clusterName |
string |
ポッドが属するクラスタの名称 |
namespace |
string |
ポッドのネームスペース |
ownerReferences |
string |
ポッドの制御元 |
labels |
string |
ポッドのラベル |
groupIDs |
long[] |
ポッドが割り当たっているコンシューマーを特定するID |
groupNames |
string[] |
ポッドが割り当たっているコンシューマーの名称 |
gradeNames |
string[] |
ポッドが割り当たっているコンシューマーのグレード |
gradeOrders |
integer[] |
ポッドが割り当たっているコンシューマーのグレードの優先度 |
collectorID |
long |
発見に使用されたコレクターを特定するID |
collectorName |
string |
発見に使用されたコレクターの名称 |
autoCollectionType |
enum |
発見に使用されたコレクターの種別 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
usedCredentialID |
long |
発見時に使用された認証情報を特定するID |
usedCredentials |
string |
発見時に使用された認証情報の名称 |
accessPointType |
enum |
発見時に使用された認証情報のプロトコルまたはコレクターの種別 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointIpAddress |
string |
監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名 |
accessPointUser |
string |
監視対象または管理ソフトウェアへの接続に使用したユーザーID |
pluginId |
string |
ポッドに適用されているプラグインのID |
pluginName |
string |
ポッドに適用されているプラグインの名称 |
pagination (Type: Pagination)
属性 |
データ型 |
説明 |
---|---|---|
page |
integer |
ページ |
pageSize |
integer |
ページサイズ |
numPages |
integer |
ページの数 |
totalCount |
integer |
オブジェクトの数 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
参照権限がない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] GET /Analytics/v1/objects/Pods HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.33.0 Host: localhost:22015 Accept: application/json Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 07:11:36 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 16, "name" : "api-6f6f887c55-cqwdv", "status" : "Normal", "monitorStatus" : "InUse", "nodeID" : 50, "nodeName" : "k8s-master.local", "nodeMonitorStatus" : "Manage", "clusterName" : "zzops", "namespace" : "ml-smore", "ownerReferences" : "ReplicaSet/api-6f6f887c55", "labels" : "api,2929443711", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "collectorID" : 0, "collectorName" : "kubernetes", "autoCollectionType" : "AutoConnect", "accessPointType" : "HTTP", "accessPointIpAddress" : "10.197.101.177", "accessPointUser" : "system", "pluginId" : "com.hitachi.software.ias.KubernetesPlugin", "pluginName" : "Kubernetes Plugin A" }, { "instanceID" : 15, "name" : "api-9b96d4c5d-crpzj", "status" : "Normal", "monitorStatus" : "InUse", "nodeID" : 50, "nodeName" : "k8s-master.local", "nodeMonitorStatus" : "Manage", "clusterName" : "zzops", "namespace" : "ml-aem", "ownerReferences" : "ReplicaSet/api-9b96d4c5d", "labels" : "api,565280718", "groupIDs" : [ 0 ], "groupNames" : [ "#Unassigned Resources" ], "gradeNames" : [ "" ], "gradeOrders" : [ -1 ], "collectorID" : 0, "collectorName" : "kubernetes", "autoCollectionType" : "AutoConnect", "accessPointType" : "HTTP", "accessPointIpAddress" : "10.197.101.177", "accessPointUser" : "system", "pluginId" : "com.hitachi.software.ias.KubernetesPlugin", "pluginName" : "Kubernetes Plugin A" } ], "count" : 2 }