証明書を変更する
PUT /accounts/{account_id}/core/v1/certificates/{certificate_id}
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えます。
副作用
-
更新された CA 証明書がトラストストアで更新されます。
-
既存の信頼済みCA証明書が信頼できなくなった場合、信頼ストアから削除されます。
-
証明書本体が更新された場合(「cert」フィールド)、新しい証明書の状態を示すために「isSelfSigned」インジケータを含める必要があります。この場合、「isSelfSigned」インジケータが含まれていない場合、値は「false」に設定されます。
-
更新によって証明書本体(「cert」フィールド)が変更されない場合、「isSelfSigned」インジケーターはオプションであり、指定しない場合は既存の値が保持されます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
certificate_id |
string |
path(パス) |
True |
一覧表示する証明書コレクションのID |
要求の本文
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えます。
副作用
-
更新された CA 証明書がトラストストアで更新されます。
-
既存の信頼済みCA証明書が信頼できなくなった場合、信頼ストアから削除されます。
-
証明書本体が更新された場合(「cert」フィールド)、新しい証明書の状態を示すために「isSelfSigned」インジケータを含める必要があります。この場合、「isSelfSigned」インジケータが含まれていない場合、値は「false」に設定されます。
-
更新によって証明書本体(「cert」フィールド)が変更されない場合、「isSelfSigned」インジケーターはオプションであり、指定しない場合は既存の値が保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
False |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
certUse |
string |
False |
証明書の使用状況を示すJSON文字列。指定しない場合は、「rootCA」がデフォルトとなります。定義された値は次のとおりです:
|
cert |
string |
False |
Base64エンコードされたPKCS-11形式の証明書(PEM)を含むJSON文字列。定義された値は次のとおりです:
|
cn |
string |
False |
証明書から抽出された共通名を含むJSON文字列。定義された値は次のとおりです:
|
expiryTimestamp |
string |
False |
証明書の有効期限を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです:
|
isSelfSigned |
string |
False |
証明書が自己署名されているかどうかを示すJSON文字列。作成時に指定されない場合、値はデフォルトで「false」になります。更新時:
|
trustState |
string |
False |
証明書が信頼されているかどうかを示す、列挙された値のセットのうちの1つを含むJSON文字列。定義された値は次のとおりです:
|
trustStateTransitions |
False |
JSONオブジェクトのJSON配列。各オブジェクトは、特定の定義済み状態からの許可された状態遷移のセットを表します。各JSONオブジェクトには「from」と「to」というフィールドが含まれており、「from」の値は状態の名前、「to」の値は許可された宛先状態の配列です。 |
|
trustStateDesired |
string |
False |
証明書が信頼されているかどうかを示す値を含むJSON文字列。作成時に指定しない場合、デフォルト値は"trusted"になります。定義された値は次のとおりです:
|
trustStateDetails |
False |
証明書の信頼状態に関する詳細情報を一覧表示するJSONオブジェクトのJSON配列。詳細情報が利用できない場合、この配列は空になります。
|
|
メタデータ |
False |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
リクエスト例
{
"type": "application/astra-certificate",
"version": "1.1",
"trustStateDesired": "trusted"
}
応答
Status: 204, Indicates if the certificate resource was updated.
応答
Status: 401, Unauthorized
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
応答
Status: 400, Bad request
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
応答
Status: 409, Conflict
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
配列["invalidFields"] |
False |
無効なリクエストボディフィールドのリスト |
回答例
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
応答
Status: 403, Forbidden
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
応答
Status: 503, Service unavailable
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
回答例
{
"type": "https://astra.netapp.io/problems/41",
"title": "Service not ready",
"detail": "Currently, the service can't respond to this request.",
"status": "503"
}
エラー
Status: 404, Not found
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
ステータス |
string |
True |
|
correlationID |
string |
False |
エラー応答の例
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
用語の意味
定義を参照
type_astra_stateTransition
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
- |
string |
True |
|
- |
array[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
additionalDetails |
False |
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata_update
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |
invalidFields
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なリクエストボディフィールドの名前 |
理由 |
string |
True |
リクエスト本文フィールドが無効な理由 |