ModifyKeyPairAttribute

1. 接口描述

本接口(ModifyImageAttribute)用于修改一个密钥对的属性。

注意事项

  • 目前支持修改描述的属性,不支持名称的修改。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

keyId

String

密钥对ID。

示例值:key-xxxxxxxx

keyDescription

String

密钥对描述信息。 不超过255个字符。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

  1. 修改密钥对描述信息。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyKeyPairAttribute
<Common Request Params>

Request:
{
  "keyId": "key-xxxx",
  "keyDescription": "test-description"
}

Response:
{
  "requestId": "TE5661D09-28A7-4BDA-ACB1-106EDD916682",
  "response": {
    "requestId": "TE5661D09-28A7-4BDA-ACB1-106EDD916682"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_KEY_PAIR_NOT_FOUND

没有找到指定的密钥对。

最后更新于