本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeSslCertificateAttribute

処理概要

指定したSSL証明書の詳細情報を取得します。1回のリクエストで、1つのSSL証明書の1つの詳細情報を取得できます。

SSL証明書を指定するためには、SSL証明書の発行識別子(fqdnId)が必要です。削除済みのSSL証明書を指定した、管理外のSSL証明書を指定したなど、無効なSSL証明書を指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
FqdnId SSL証明書の識別子
Type : String
111
Attribute 取得する情報の項目名
Type : String
値 : certAuthority(SSL証明書の認証局を取得)
count (SSL証明書の数量を取得) |
certState (SSL証明書の発行ステータスを取得) |
period (SSL証明書の有効期間を取得) |
keyLength (SSL証明書の鍵長を取得) |
uploadState (SSL証明書の種別を取得) |
description (SSL証明書のメモ情報を取得) |
certInfo (SSL証明書の発行申請情報を取得) |
caState (中間証明書の有無を取得)
  certInfo

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeSslCertificate
AttributeResponse
DescribeSslCertificateAttribute レスポンス
Type : DescribeSslCertificateAttributeResponseType
Ancestor : なし
Children : requestId, fqdnId, fqdn, certAuthority, count, certState, period, keyLength, uploadState, description, certInfo
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeSslCertificateAttributeResponse
Children : なし
320fc738-a1c7-4a2f-abcb-20813a4e997c
fqdnId SSL証明書の発行識別子
Type : xsd:string
Ancestor : DescribeSslCertificateAttributeResponse
Children : なし
111
fqdn FQDN
Type : xsd:string
Ancestor : DescribeSslCertificateAttributeResponse
Children : なし
aaa.aaa.aaa
certAuthority SSL証明書の認証局の情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書の認証局
Type : xsd:string
値 : [作成証明書]: cybertrust | GeoTrust | GeoTrustWildCard
[独自証明書]: 証明書に設定されている認証局(取得できた場合)
Ancestor : certAuthority
Children : なし
 
count SSL証明書の数量の情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書の数量
Type : xsd:integer
Ancestor : count
Children : なし
 
certState SSL証明書の発行ステータスの情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書の発行ステータス
Type : xsd:string
値 : valid (有効) | waiting (発行待ち) | expired (有効期限切れ) | invalid (失効) | warning (発行エラー)
Ancestor : certState
Children : なし
 
period SSL証明書の有効期間の情報
Type : validDateType
Ancestor : DescribeSslCertificateAttributeResponse
Children : startDate, endDate
 
startDate SSL証明書の有効期間(開始日)
Type : xsd:dateTime
Ancestor : period
Children : なし
 
endDate SSL証明書の有効期間(終了日)
Type : xsd:dateTime
Ancestor : period
Children : なし
 
keyLength SSL証明書の鍵長の情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書の鍵長
Type : xsd:integer
値 : 1024 (1024bit) | 2048 (2048bit)
Ancestor : keyLength
Children : なし
 
uploadState SSL証明書の種別の情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書のアップロード情報
Type : xsd:boolean
値 : true (アップロードした独自証明書) | false (発行証明書)
Ancestor : uploadState
Children : なし
 
description SSL証明書のメモ情報
Type : NullableAttributeValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value SSL証明書のメモ
Type : xsd:string
Ancestor : description
Children : なし
 
certInfo SSL証明書の発行申請情報
Type : certInfoType
Ancestor : DescribeSslCertificateAttributeResponse
Children : organizationName, organizationUnitName, countryName, stateName, locationName, emailAddress
 
organizationName 申請組織(企業)名
Type : xsd:string
Ancestor : certInfo
Children : なし
NIFTY
organizationUnitName 申請部署名
Type : xsd:string
Ancestor : certInfo
Children : なし
Center Department
countryName 申請国名
Type : xsd:string
Ancestor : certInfo
Children : なし
JP
stateName 事業所住所の都道府県名
Type : xsd:string
Ancestor : certInfo
Children : なし
Tokyo
locationName 事業所住所の市区町村名
Type : xsd:string
Ancestor : certInfo
Children : なし
Shinjuku-ku
emailAddress メールアドレス
Type : xsd:string
Ancestor : certInfo
Children : なし
 
caState 中間証明書の有無ステータス情報
Type : NullableAttributeBooleanValueType
Ancestor : DescribeSslCertificateAttributeResponse
Children : value
 
value 中間証明書の有無ステータス
Type : xsd:boolean
値 : true (有) | false (無)
Ancestor : item
Children :なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeSslCertificateAttribute&FqdnId=111&Attribute=certInfo&CommonParams

応答サンプル

<DescribeSslCertificateAttributeResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>320fc738-a1c7-4a2f-abcb-20813a4e997c</requestId>
  <fqdnId>111</fqdnId>
  <fqdn>ccc.aaa.com</fqdn>
  <certInfo>
    <organizationName>NIFTY</organizationName>
    <organizationUnitName>Center Department</organizationUnitName>
    <countryName>JP</countryName>
    <stateName>Tokyo</stateName>
    <locationName>Shinjuku-ku</locationName>
    <emailAddress />
  </certInfo>
</DescribeSslCertificateAttributeResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上