Classic/VPC環境で利用できます。
Advanced証明書オーダー(Order)のサブスクリプション期間を延長します。
参考
サブスクリプションの延長は、Advanced証明書でのみ提供されます。同一のオーダー内で進行中の延長がない必要があります。延長の可否は、サブスクリプションの終了年度と今年度の差に基づいて判断します。
- 年度の差が0年: 1年、2年、3年延長可能
- 年度の差が1年: 1年、2年延長可能
- 年度の差が2年: 1年延長可能
- 年度の差が3年以上: 延長不可
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /api/v2/certificate/subscription/extend |
リクエストヘッダ
Certificate Manager APIで共通して使用されるヘッダの詳細は、Certificate Managerのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
orderId |
String | Required | 延長するオーダー ID |
subscriptionPeriod |
String | Required | 延長期間
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://certificatemanager.apigw.ntruss.com/api/v2/certificate/subscription/extend' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"orderId": "1",
"subscriptionPeriod": "1Y"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
returnCode |
String | - | レスポンスコード |
returnMessage |
String | - | レスポンスメッセージ |
レスポンスステータスコード
Certificate Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Certificate Managerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"returnCode": "0",
"returnMessage": "Success"
}