2.1.1 認証情報の一覧の取得
JP1/OAが監視対象のリソースへの接続に使用する認証情報の一覧を取得します。
権限
Admin
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Credentials
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "name":"...", "credentialType":"...", "userId":"...", "passwordNotRequired":"...", "portNumber":"...", "ssl":"...", "domainname":"...", "namespace":"...", "community":"...", "snmpVersion":"...", "userName":"...", "authenticationEnabled":"...", "authenticationProtocol":"...", "privacyEnabled":"...", "privacyProtocol":"...", "numOfRelatedResources":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Credential[] |
Credentialのコレクション。Credentialの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Credential)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID |
name |
string |
認証情報の名称 |
credentialType |
enum |
監視対象への接続に使用するプロトコル。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
userId |
string |
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合,”username”メンバーの値が設定されます。 |
passwordNotRequired |
boolean |
認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。 ・true:パスワードは必要ない。 ・false:パスワードが必要である。 |
portNumber |
int |
ポート番号。監視対象への接続に使用するプロトコルが「ssh」,「SMI-S WBEM」,「SNMP」の場合のみ設定されます。 |
ssl |
boolean |
監視対象への接続時にSSL(https)を使用するかどうか。 ・true:SSLを使用する。 ・false:SSLを使用しない。 省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。 |
domainname |
string |
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。 |
namespace |
string |
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。 |
community |
string |
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 |
snmpVersion |
enum |
SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
userName |
string |
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationEnabled |
boolean |
SMTP認証を行うかどうか。 ・true:認証を有効にする。 ・false:認証を無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
authenticationProtocol |
enum |
認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
privacyEnabled |
boolean |
プライバシーを有効にするかどうか。 ・true:プライバシーを有効にする。 ・false:プライバシーを無効にする。 省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 |
privacyProtocol |
enum |
プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。 (指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。) 以下に示す値のみ指定可能です。
|
numOfRelatedResources |
int |
認証情報を用いて発見されたリソースの数。 |
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/Credentials 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 05:21:49 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 1d392a3baad40eab4e3a05ad6e71e3a1fcd577_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : 5, "name" : "smis", "credentialType" : "WBEM", "userId" : "smis", "portNumber" : 5989, "ssl" : true, "namespace" : "root/smis/current", "numOfRelatedResources" : 0 }, { "instanceID" : 4, "name" : "snmpv3", "credentialType" : "SNMP", "userId" : "snmp", "portNumber" : 161, "community" : "", "snmpVersion" : "V3", "userName" : "snmp", "authenticationEnabled" : true, "authenticationProtocol" : "MD5", "privacyEnabled" : true, "privacyProtocol" : "DES", "numOfRelatedResources" : 0 }, { "instanceID" : 3, "name" : "snmpv1", "credentialType" : "SNMP", "portNumber" : 161, "community" : "public", "snmpVersion" : "V1_V2C", "numOfRelatedResources" : 0 }, { "instanceID" : 2, "name" : "ssh", "credentialType" : "SSH", "userId" : "ssh", "portNumber" : 22, "numOfRelatedResources" : 0 }, { "instanceID" : 1, "name" : "wmi", "credentialType" : "WMI", "userId" : "wmi", "domainname" : "workspace", "numOfRelatedResources" : 0 } ], "count" : 5 }