修改憑證
PUT /accounts/{account_id}/core/v1/certificates/{certificate_id}
將整個儲存的資源替換為提供的 JSON 請求主體。
副作用
-
更新後的 CA 憑證將在信任存放區中更新。
-
如果現有的受信任 CA 憑證變成不受信任,則會從信任儲存區中刪除。
-
如果憑證主體已更新(「cert」欄位),則必須包含「isSelfSigned」指示符以指示新憑證的狀態。如果在這種情況下未包含「isSelfSigned」指示符,則其值將設定為「false」。
-
如果更新不修改憑證主體(「cert」欄位),則「isSelfSigned」指示符是可選的,如果未提供,則將保留現有值。
參數
| Name | 類型 | 在 | 必要 | 說明 |
|---|---|---|---|---|
account_id |
字串 |
路徑 |
True |
包含帳戶資源的 ID
|
certificate_id |
字串 |
路徑 |
True |
要列出的憑證集合 ID |
請求本文
將整個儲存的資源替換為提供的 JSON 請求主體。
副作用
-
更新後的 CA 憑證將在信任存放區中更新。
-
如果現有的受信任 CA 憑證變成不受信任,則會從信任儲存區中刪除。
-
如果憑證主體已更新(「cert」欄位),則必須包含「isSelfSigned」指示符以指示新憑證的狀態。如果在這種情況下未包含「isSelfSigned」指示符,則其值將設定為「false」。
-
如果更新不修改憑證主體(「cert」欄位),則「isSelfSigned」指示符是可選的,如果未提供,則將保留現有值。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
資源的媒體類型。定義的值為:
|
版本 |
字串 |
True |
資源版本。已定義值包括:
|
ID |
字串 |
錯誤 |
資源的全域唯一識別碼。定義的值為:
|
certUse |
字串 |
錯誤 |
指示憑證用途的 JSON 字串。如果未指定,則預設為 "rootCA"。已定義的值包括:
|
憑證 |
字串 |
錯誤 |
包含經過 base64 編碼的 PKCS-11 格式憑證(PEM)的 JSON 字串。定義值包括:
|
cn |
字串 |
錯誤 |
包含從憑證中擷取的通用名稱的 JSON 字串。已定義的值包括:
|
expiryTimestamp |
字串 |
錯誤 |
包含時間戳記的 JSON 字串,指示憑證的過期時間。已定義的值包括:
|
isSelfSigned |
字串 |
錯誤 |
指示憑證是否為自簽名憑證的 JSON 字串。如果在建立時未提供,則預設值為 "false"。更新時:
|
trustState |
字串 |
錯誤 |
包含一組列舉值之一的 JSON 字串,指示憑證是否受信任。定義的值包括:
|
trustStateTransitions |
錯誤 |
JSON 物件的 JSON 陣列,每個物件代表從給定已定義狀態出發的允許狀態轉換集。每個 JSON 物件包含「from」和「to」欄位,其中「from」值是狀態名稱,「to」值是允許的目標狀態陣列。 |
|
trustStateDesired |
字串 |
錯誤 |
JSON 字串包含一個值,指示憑證是否受信任。如果在建立時未指定,則預設值為 "trusted"。已定義的值包括:
|
trustStateDetails |
錯誤 |
包含 JSON 物件的 JSON 陣列,其中列出了憑證信任狀態的其他詳細資料。如果沒有可用的詳細資料,則此陣列為空白。
|
|
中繼資料 |
錯誤 |
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
|
範例請求
{
"type": "application/astra-certificate",
"version": "1.1",
"trustStateDesired": "trusted"
}
回應
Status: 204, Indicates if the certificate resource was updated.
回應
Status: 401, Unauthorized
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
|
invalidFields |
陣列["invalidFields"] |
錯誤 |
無效請求本文欄位清單 |
範例回應
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
回應
Status: 409, Conflict
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
|
invalidFields |
陣列["invalidFields"] |
錯誤 |
無效請求本文欄位清單 |
範例回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
狀態 |
字串 |
True |
|
correlationID |
字串 |
錯誤 |
範例錯誤回應
{
"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 | 類型 | 必要 | 說明 |
|---|---|---|---|
從 |
字串 |
True |
|
到 |
陣列[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
類型 |
字串 |
True |
|
標題 |
字串 |
True |
|
詳細資料 |
字串 |
True |
|
additionalDetails |
錯誤 |
type_astra_label
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
|
值 |
字串 |
True |
type_astra_metadata_update
與資源相關聯的用戶端和服務指定中繼資料。定義的值為:
-
遵循 Astra Metadata Schema。如果在建立時未指定,則建立的元資料物件將不帶任何標籤。如果在更新時未指定,元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
標籤 |
錯誤 |
||
建立時間戳記 |
字串 |
錯誤 |
|
修改時間戳記 |
字串 |
錯誤 |
|
建立者 |
字串 |
錯誤 |
|
modifiedBy |
字串 |
錯誤 |
invalidParams
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效查詢參數的名稱 |
原因 |
字串 |
True |
查詢參數無效的原因 |
invalidFields
| Name | 類型 | 必要 | 說明 |
|---|---|---|---|
姓名 |
字串 |
True |
無效請求內文欄位的名稱 |
原因 |
字串 |
True |
請求本文欄位無效的原因 |