更新时间:2022-03-31 GMT+08:00
分享

更改密钥对

功能介绍

  • 接口名称

    UpdateKeypair

  • 功能描述

    修改连接云手机的密钥对。

URI

PUT /v1/{project_id}/cloud-phone/servers/open-access

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

请求消息

  • 请求参数

    参数

    是否必选

    参数类型

    描述

    servers

    Array of objects

    待更改密钥对的云手机服务器信息,详情请参见表2

    表2 servers数据结构说明

    参数

    是否必选

    参数类型

    描述

    server_id

    String

    云手机服务器ID,不得超过32个字节。

    可通过查询云手机服务器列表响应消息的“server_id”字段获取该参数的值。

    keypair_name

    String

    密钥对名称

    • 若更改为当前账号下已有密钥对,可通过查询SSH密钥列表查看账号下所有密钥对信息,获取“keypair_name”。
    • 若更改为新创建的密钥对,可登录控制台的“密钥对”页面进行创建,详细操作请参考创建密钥对
  • 请求样例
    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"
            }
        ]
    }

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    jobs

    Array of objects

    任务信息,详情请参见表3

    表3 job数据结构说明

    参数

    参数类型

    描述

    server_id

    String

    云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。

    job_id

    String

    任务的唯一标识

  • 响应样例
    { 
        "request_id": "6837531fd3f54550927b930180a706bf",
        "jobs": [
            {
                "server_id": "ae4d231e44d2a4ccf612660a473fe1e3",
                "job_id": "1564567b8bab40f34711234cb80d0123"
            },
            {
                "server_id": "2347275010d3440d963d3fcb8931ff55",
                "job_id": "1564567b8bab40f34711234cb80d5678"
            }
        ]
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

close