Compute Systems Manager REST API リファレンスガイド

[目次][前へ][次へ]

7.3 特定の認証情報を取得する

instanceIDに指定した認証情報を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials/＜instanceID＞

instanceID:
Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

Credential 

{
    "Credential":[{
        "instanceID":"...",
        "protocolType":"...",
        "credentialName":"...",
        "description":"...",
        "userID":"...",
        "emptyPassword":"...",
        "password":"...",
        "portNo":...,
        "userPassword":"...",
        "suPassword":"...",
        "domainName":"...",
        "defaultAuthorization":"...",
        "defaultPort":"...",
        "discoverHyperV":"..."
    }]
}
属性 データ型 数 説明
instanceID string 1 Compute Systems Managerによって割り当てられた識別キー。
protocolType string 1 管理対象に対応した値。
  • WMI：Windowsホストを管理する場合に使用する認証情報。
  • SSH：Linuxホストを管理する場合に使用する認証情報。
  • VMWARE：VMware ESXiを管理する場合に使用する認証情報。
  • SVP：ブレードサーバまたはラックマウントサーバを管理する場合に使用する認証情報。
credentialName string 1 認証情報名（1～32バイト）。
description string 1 認証情報の説明（0～500バイト）。
userID string 1 探索するリソースにアクセスするためのユーザーID。
emptyPassword string 1 パスワードを指定するかどうか。protocolTypeが'WMI'以外の場合は空文字列。
  • Disable：パスワードを指定します。
  • Enable：パスワードを指定しません。
password string 1 パスワードの文字列をbase64でエンコードした文字列。protocolTypeが'SVP'以外の場合は空文字列。
portNo integer 1 ポート番号。
userPassword string 1 パスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SVP'の場合は空文字列。
suPassword string 1 rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードの文字列は1～256バイト）。protocolTypeが'SSH'以外の場合は空文字列。
domainName string 1 ドメイン名。protocolTypeが'WMI'以外の場合は空文字列。
defaultAuthorization string 1 ブレードサーバまたはラックマウントサーバへの接続にデフォルトのユーザーIDとパスワードを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。
  • Disable：指定したユーザーIDとパスワードを使用します。
  • Enable：デフォルトのユーザーIDとパスワードを使用します。
defaultPort string 1 ブレードサーバまたはラックマウントサーバへの接続にデフォルトポートを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。
  • Disable：指定したポートを使用します。
  • Enable：デフォルトポートを使用します。
discoverHyperV string 1 Hyper-Vを探索対象にするかどうか。resourceTypeが'WMI'以外の場合は空文字列。
  • Disable：Hyper-Vを探索対象にしません。
  • Enable：Hyper-Vを探索対象にします。

リターンコード

HTTPステータスコード 結果コード 詳細コード 説明
200 - - 正常終了。
204 - - 指定したinstanceIDまたはcollectionはありません。
401 1000 1 HTTPヘッダーのAuthorizationが指定されていません。
401 1000 2 HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 1000 3 HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 1000 4 ログインに失敗しました。
401 1002 1 ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 1003 1 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 2017 1 管理対象を参照する権限がありません。
405 - - サポートされていないメソッドです。
406 2010 1 HTTPヘッダーのAcceptの値が不正です。
415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 1000 1 ログインに失敗しました（内部エラー）。
503 2020 1 要求の数がAPIの同時最大接続数を超えました。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.