ListCertificatesByRecord - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

Record に一致するサイト証明書のリストを照会します。バッチ Record マッチングがサポートされています。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListCertificatesByRecord

none

*サイト。

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。 ListSites 操作を呼び出してサイト ID をクエリできます。	1234567890123
RecordName	string	必須	Record 名。	www.example.com
ValidOnly	boolean	任意	有効な証明書のみを返すかどうかを指定します。	true
Detail	boolean	任意	証明書の詳細を返すかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエスト ID。	65C66B7B-671A-8297-9187-2R5477247B76
TotalCount	integer	エントリの総数。Record の数と同じです。	12
SiteId	integer	サイト ID。	1234567890123
SiteName	string	サイト名。	example.com
Result	array<object>	結果の配列。
	array<object>	結果。
RecordName	string	Record 名。	www.example.com
Count	integer	Record に一致する証明書の数。	3
Certificates	array<object>	Record に一致する証明書のリスト。
	object	証明書の情報。フォーマットはオブジェクトです。
CasId	string	Alibaba Cloud 証明書の ID。	30000137
Id	string	証明書の ID。	babab022c5e9b27bf9c64d7f4b1667f4
Name	string	証明書の名前。	yourCertName
Region	string	証明書が保存されているリージョン。	cn-hangzhou
Status	string	証明書のステータス。	OK
Type	string	証明書のタイプ。有効な値：列挙値: cas : Alibaba Cloud 証明書。 upload : アップロードされたカスタム証明書。 keyless : Keyless 証明書。 free : 無料証明書。	free
CommonName	string	証明書の共通名。	www.example.com
NotBefore	string	証明書が有効になる日時。	2023-02-28 06:17:11
NotAfter	string	証明書の有効期限が切れる日時。	2024-02-28 06:17:11
Issuer	string	証明書の発行者。	GlobalSign nv-sa
IssuerCN	string	証明書発行者の共通名。	GlobalSign Organization Validation CA - SHA256 - G3
SAN	string	証明書のサブジェクト代替名 (SAN)。	www.example.com,*.example.com
SigAlg	string	証明書の署名アルゴリズム。	SHA256-RSA
PubAlg	string	証明書の公開鍵アルゴリズム。	RSA
CreateTime	string	証明書が作成された時間。	2023-02-28 06:17:11
UpdateTime	string	証明書が最終更新された時間。	2023-02-28 06:17:11
SerialNumber	string	証明書のシリアル番号。	baba39055622c008b90285a8838ed09a
FingerprintSha256	string	証明書の SHA-256 フィンガープリント。	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
KeyServerId	string	Keyless サーバー ID。このパラメーターは、`Type` が `keyless` に設定されている場合にのみ有効です。	baba39055622c008b90285a8838e****
ApplylingCount	integer	申請中の証明書の数。	1
Status	string	Record の証明書構成ステータス。有効な値: none: 未構成。 configured: 構成済み。 applying: 申請中。 failed: 申請失敗した。列挙値: configured : 構成済み。 applying : 申請中。 none : 未構成。 failed : 申請失敗した。	none

例

成功レスポンス

JSONJSON

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "TotalCount": 12,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "RecordName": "www.example.com ",
      "Count": 3,
      "Certificates": [
        {
          "CasId": "30000137",
          "Id": "babab022c5e9b27bf9c64d7f4b1667f4",
          "Name": "yourCertName",
          "Region": "cn-hangzhou",
          "Status": "OK",
          "Type": "free",
          "CommonName": "www.example.com ",
          "NotBefore": "2023-02-28 06:17:11",
          "NotAfter": "2024-02-28 06:17:11",
          "Issuer": "GlobalSign nv-sa",
          "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
          "SAN": "www.example.com,*.example.com",
          "SigAlg": "SHA256-RSA",
          "PubAlg": "RSA",
          "CreateTime": "2023-02-28 06:17:11",
          "UpdateTime": "2023-02-28 06:17:11",
          "SerialNumber": "baba39055622c008b90285a8838ed09a",
          "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66",
          "KeyServerId": "baba39055622c008b90285a8838e****\n"
        }
      ],
      "ApplylingCount": 1,
      "Status": "none"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.SiteId	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	MissingParameter	Required parameter RecordName missing. Specify RecordName and try again.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.
403	Unauthorized.InvalidToken	Token authentication failed.

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

変更履歴

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