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":"..."
   }]
}

属性データ型説明
instanceIDstring1Compute Systems Managerによって割り当てられた識別キー。
protocolTypestring1管理対象に対応した値。
  • WMI:Windowsホストを管理する場合に使用する認証情報。
  • SSH:Linuxホストを管理する場合に使用する認証情報。
  • VMWARE:VMware ESXiを管理する場合に使用する認証情報。
  • SVP:ブレードサーバまたはラックマウントサーバを管理する場合に使用する認証情報。
credentialNamestring1認証情報名(1~32バイト)。
descriptionstring1認証情報の説明(0~500バイト)。
userIDstring1探索するリソースにアクセスするためのユーザーID。
emptyPasswordstring1パスワードを指定するかどうか。protocolTypeが'WMI'以外の場合は空文字列。
  • Disable:パスワードを指定します。
  • Enable:パスワードを指定しません。
passwordstring1パスワードの文字列をbase64でエンコードした文字列。protocolTypeが'SVP'以外の場合は空文字列。
portNointeger1ポート番号。
userPasswordstring1パスワードの文字列をbase64でエンコードした文字列(エンコードの文字列は1~256バイト)。protocolTypeが'SVP'の場合は空文字列。
suPasswordstring1rootユーザーのパスワードの文字列をbase64でエンコードした文字列(エンコードの文字列は1~256バイト)。protocolTypeが'SSH'以外の場合は空文字列。
domainNamestring1ドメイン名。protocolTypeが'WMI'以外の場合は空文字列。
defaultAuthorizationstring1ブレードサーバまたはラックマウントサーバへの接続にデフォルトのユーザーIDとパスワードを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。
  • Disable:指定したユーザーIDとパスワードを使用します。
  • Enable:デフォルトのユーザーIDとパスワードを使用します。
defaultPortstring1ブレードサーバまたはラックマウントサーバへの接続にデフォルトポートを使用するかどうか。resourceTypeが'SVP'以外の場合は空文字列。
  • Disable:指定したポートを使用します。
  • Enable:デフォルトポートを使用します。
discoverHyperVstring1Hyper-Vを探索対象にするかどうか。resourceTypeが'WMI'以外の場合は空文字列。
  • Disable:Hyper-Vを探索対象にしません。
  • Enable:Hyper-Vを探索対象にします。

リターンコード

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