Updating a Key Pair
Function
This API is used to update the key pair for connecting to the cloud phone.
URI
PUT /v1/{project_id}/cloud-phone/servers/open-access
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
servers |
Yes |
Array of ServerKeypair objects |
Specifies the information about the cloud phone server whose key pair is to be changed. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the unique request ID. |
jobs |
Array of ServerJob objects |
Task information |
Parameter |
Type |
Description |
---|---|---|
server_id |
String |
Specifies the unique ID of a cloud phone server. This parameter is contained in tasks related to cloud phone servers. |
job_id |
String |
Specifies the unique ID of a task. |
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
Modifying the Key Pair of the Corresponding Server in the Server List
PUT https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/open-access { "servers" : [ { "keypair_name" : "mykeypair", "server_id" : "ae4d231e44d2a4ccf612660a473fe1e3" }, { "keypair_name" : "mykeypair", "server_id" : "2347275010d3440d963d3fcb8931ff55" } ] }
Example Responses
Status code: 200
OK
{ "request_id" : "6837531fd3f54550927b930180a706bf", "jobs" : [ { "server_id" : "ae4d231e44d2a4ccf612660a473fe1e3", "job_id" : "1564567b8bab40f34711234cb80d0123" }, { "server_id" : "2347275010d3440d963d3fcb8931ff55", "job_id" : "1564567b8bab40f34711234cb80d5678" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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