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

無料証明書を申請します。

今すぐお試しください

この 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:ApplyCertificate

create

*Site

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	必須	サイト ID。	1234567890123
Domains	string	必須	カンマ区切りのドメイン名のリスト。	www.example.com,blog.example.com
Type	string	任意	証明書タイプ。有効な値：`lets_encrypt` (Let's Encrypt 証明書)、`digicert_single` (Digicert シングルドメイン証明書)、`digicert_wildcard` (Digicert ワイルドカード証明書)。列挙値: digicert_wildcard : digicert_wildcard lets_encrypt : lets_encrypt digicert_single : digicert_single	lets_encrypt

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
SiteName	string	サイト名。	example.com
TotalCount	integer	リクエストされた証明書の総数。リクエストで指定されたドメイン名の数と一致します。	2
Result	array<object>	各無料証明書の申請詳細のリスト。
	object	無料証明書申請の詳細。
Domain	string	証明書のドメイン名。	*.example.com
Status	string	証明書の申請ステータス。	Applying
Id	string	証明書 ID。	30000478
RequestId	string	リクエスト ID。	156A6B-677B1A-4297B7-9187B7-2B44792

例

成功レスポンス

JSONJSON

{
  "SiteName": "example.com ",
  "TotalCount": 2,
  "Result": [
    {
      "Domain": "*.example.com ",
      "Status": "Applying",
      "Id": "30000478"
    }
  ],
  "RequestId": "156A6B-677B1A-4297B7-9187B7-2B44792"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	SiteNotFound	The specified site is not found.
400	SiteNotActivated	The site is not activated, the process is not allowed.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.
400	InvalidParameter.Domains	You have already submitted a certificate application for the domain name.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	QuotaCheckFailed	Failed to check free certificate Quota, please try again later.
400	InvalidParameter.Type	The specified Type parameter is invalid, please check and try again.
400	QuotaExceed.RecordCount	The maximum number of records has been reached. Delete some and try again or upgrade your plan.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.
403	Unauthorized.InvalidToken	Token authentication failed.
403	QuotaExceeded	The quota is exceeded.

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

変更履歴

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