Uploading or Updating the Database Private Key
Function
This API is used to upload or update the database private key.
URI
POST /v2/{project_id}/audit/{instance_id}/databases/{db_id}/sslkey
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. You can obtain the value by calling the IAM API for obtaining the project list of a specified IAM user. Constraints N/A Range You can obtain the value of the IAM service interface. The value contains 32 to 64 characters. Default value N/A |
| instance_id | Yes | String | Definition Instance ID. You can obtain the value from the ID field in the API for querying the instance list. Constraints N/A Range You can obtain the value from the API for querying the instance list. The value contains 32 to 64 characters. Default value N/A |
| db_id | Yes | String | Definition Database ID. You can obtain the value from the ID field returned by the API for querying the instance database list. Constraints N/A Range The value is subject to the database API. The value is a string of 16 to 64 characters. Default value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| pem_key_txt | Yes | String | Private key text |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| result | String | Operation result. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
Example Requests
/v2/{project_id}/audit/{instance_id}/databases/{db_id}/sslkey
{
"pem_key_txt" : "-----BEGIN PRIVATE KEY----- XXXX -----END PRIVATE KEY-----"
} Example Responses
Status code: 200
Success.
{
"result" : "success"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Success. |
| 400 | Invalid request parameter. |
| 401 | Authorization failed. |
| 403 | Unauthorized |
| 500 | Server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot