ドキュメント
ホームページ Certificate Management Service 開発者リソース APIリファレンス (プライベート証明書) フロー制御情報 クライアント証明書とサーバー証明書 DescribeClientCertificate

DescribeClientCertificate

更新日時
Copy as MD
製品

この操作は、一意の識別子を使用して、特定のクライアント証明書またはサーバー証明書の詳細を照会するために使用されます。

操作説明

この操作を呼び出して、一意の識別子によってクライアント証明書またはサーバー証明書の詳細を照会できます。詳細には、証明書のシリアル番号、サブジェクト、コンテンツ、およびステータスが含まれます。

この操作を呼び出す前に、クライアント証明書またはサーバー証明書を作成する必要があります。

API を呼び出してクライアント証明書を作成する方法については、次のトピックをご参照ください：

API を呼び出してサーバー証明書を作成する方法については、次のトピックをご参照ください：

制限事項

この API 呼び出しの 1 秒あたりのクエリ数 (QPS) の上限は、ユーザーあたり 10 です。この上限を超えると、スロットリングがトリガーされ、ビジネスに影響を与える可能性があります。呼び出しを適切に計画してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API：アクションを具体的に実行するための API。

  • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

  • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cert:DescribeClientCertificate

get

*All Resource

*

 なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例
Identifier

string

必須

照会するクライアント証明書またはサーバー証明書の一意の識別子。

説明

ListClientCertificate を呼び出して、すべてのクライアント証明書とサーバー証明書の一意の識別子を照会します。

d3b95700998e47afc4d95f886579****

上記のリクエストパラメーターに加えて、この API を呼び出すときには、共通リクエストパラメーターを指定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

リクエストのフォーマットについては、このトピックの「例」セクションのリクエストサンプルをご参照ください。

レスポンスフィールド

フィールド

型

説明

例

object

DescribeCertificateResponse<CertificateWithContentDTO>

Certificate

object

クライアント証明書またはサーバー証明書の詳細。

X509Certificate

string

証明書のコンテンツ。

-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifier

string

証明書の一意の識別子。

d3b95700998e47afc4d95f886579****
SerialNumber

string

証明書のシリアル番号。

62b2b943a32d96883a6650e672ea0276****
SubjectDN

string

証明書のサブジェクトの識別名 (DN)。この値は、次のフィールドで構成されます：

  • C：国。

  • O：組織。

  • OU：組織単位。

  • CN：コモンネーム。

  • ST：州または省。

  • CN：コモンネーム。

C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName

string

証明書のコモンネーム。

aliyun.com
OrganizationUnit

string

証明書サブジェクトの組織単位。

Security
Organization

string

発行元の下位 CA の証明書に関連付けられている組織。

Aliyun
Locality

string

サブジェクト組織が所在する都市。

Hangzhou
State

string

サブジェクト組織が所在する州または省。

Zhejiang
CountryCode

string

サブジェクト組織の国コード。

国コードの詳細については、「会社プロファイルの管理」の「国際コード」セクションをご参照ください。

CN
Sans

string

証明書のサブジェクト代替名 (SAN) 拡張。SAN 拡張は、証明書に関連付けられている他のドメイン名または IP アドレスを示します。

このパラメーターは、JSON 配列から変換された文字列です。JSON 配列の各要素は、SAN 拡張に対応する構造体です。 各 SAN 拡張構造体には、次のパラメーターが含まれます：

  • Type：拡張のタイプ。このパラメーターは Integer 型です。有効値：

    • 1：メールアドレス。

    • 2：ドメイン名。

    • 6：Uniform Resource Identifier (URI)。

    • 7：IP アドレス。

  • Value：拡張のコンテンツ。このパラメーターは String 型です。

[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]
Status

string

証明書のステータス。有効値：

  • ISSUE：証明書は発行済みです。

  • REVOKE：証明書は失効済みです。

ISSUE
BeforeDate

integer

証明書の発行日。この値は UNIX タイムスタンプです。単位：ミリ秒。

1634283958000
AfterDate

integer

証明書の有効期限日。この値は UNIX タイムスタンプです。単位：ミリ秒。

1665819958000
Algorithm

string

暗号化アルゴリズムのタイプ。有効値：

  • RSA：RSA アルゴリズム。

  • ECC：ECC アルゴリズム。

  • SM2：SM2 アルゴリズム。

RSA
KeySize

integer

証明書の鍵長。

4096
SignAlgorithm

string

証明書の署名アルゴリズム。

SHA256WITHRSA
CertificateType

string

証明書のタイプ。有効値：

  • CLIENT：クライアント証明書。

  • SERVER：サーバー証明書。

SERVER
ParentIdentifier

string

証明書を発行した下位 CA 証明書の一意の識別子。

160ae6bb538d538c70c01f81dcf2****
Sha2

string

証明書の SHA-256 フィンガープリント。

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5

string

証明書の MD5 フィンガープリント。

d3b95700998e47afc4d95f886579****
Days

integer

証明書の有効期間。単位：日。

365
ResourceGroupId

string

証明書が属するリソースグループの ID。

rg-acfmxllajdpw3fi
CertChain

string

完全な証明書チェーン。

-----BEGIN CERTIFICATE----- cert -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- subCA -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- rootCA -----END CERTIFICATE-----
CustomIdentifier

string

一意のキーであるカスタム識別子。

***3a32d96883a6650e672ea0276****
UploadFlag

integer

証明書がデジタル証明書管理サービスに同期されているかどうかを示します。

1
FullAlgorithm

string

アルゴリズムとその長さ。

RSA_2048
AliasName

string

発行された証明書のエイリアス。

rsa_root_2048
Id

integer

証明書オーダーが属するデータソースの ID。

1137354
Tags

array<object>

タグのリスト。

mtls

object

タグ値。

TagKey

string

タグキー。

testKey
TagValue

string

タグ値。

[{\"tag\":\"PROPERTY_TYPE\",\"values\":[]}]
RequestId

string

リクエストの ID。

15C66C7B-671A-4297-9187-2C4477247A74

例

成功レスポンス

JSONJSON

{
  "Certificate": {
    "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "Identifier": "d3b95700998e47afc4d95f886579****",
    "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
    "SubjectDN": "C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "CommonName": "aliyun.com",
    "OrganizationUnit": "Security",
    "Organization": "Aliyun",
    "Locality": "Hangzhou",
    "State": "Zhejiang",
    "CountryCode": "CN",
    "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "Status": "ISSUE",
    "BeforeDate": 1634283958000,
    "AfterDate": 1665819958000,
    "Algorithm": "RSA",
    "KeySize": 4096,
    "SignAlgorithm": "SHA256WITHRSA",
    "CertificateType": "SERVER",
    "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
    "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "Md5": "d3b95700998e47afc4d95f886579****",
    "Days": 365,
    "ResourceGroupId": "rg-acfmxllajdpw3fi",
    "CertChain": "-----BEGIN CERTIFICATE-----\ncert\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nsubCA\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nrootCA\n-----END CERTIFICATE-----",
    "CustomIdentifier": "***3a32d96883a6650e672ea0276****",
    "UploadFlag": 1,
    "FullAlgorithm": "RSA_2048",
    "AliasName": "rsa_root_2048",
    "Id": 1137354,
    "Tags": [
      {
        "TagKey": "testKey",
        "TagValue": "[{\\\"tag\\\":\\\"PROPERTY_TYPE\\\",\\\"values\\\":[]}]"
      }
    ]
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

前へ：DescribeCertificatePrivateKey次へ：DescribeClientCertificateStatus