操作指南

最佳实践

故障处理

API 文档

修改密钥对属性

最近更新时间:2021-02-04 08:16:44

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (ModifyKeyPairAttribute) 用于修改密钥对属性。

  • 修改密钥对ID所指定的密钥对的名称和描述信息。
  • 密钥对名称不能和已经存在的密钥对的名称重复。
  • 密钥对ID是密钥对的唯一标识,不可修改。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyKeyPairAttribute。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
KeyId String 密钥对ID,密钥对ID形如:skey-xxxxxxxx

可以通过以下方式获取可用的密钥 ID:
  • 通过登录控制台查询密钥 ID。
  • 通过调用接口 DescribeKeyPairs ,取返回信息中的 KeyId 获取密钥对 ID。
  • KeyName String 修改后的密钥对名称,可由数字,字母和下划线组成,长度不超过25个字符。
    Description String 修改后的密钥对描述信息。可任意命名,但不得超过60个字符。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改密钥对名称

    本示例用于修改密钥对名称。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
    &KeyId=skey-mv9yzyjj
    &KeyName=Tencent
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    示例2 修改密钥对描述信息

    本示例用于修改密钥对描述信息。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ModifyKeyPairAttribute
    &KeyId=skey-mv9yzyjj
    &Description=Tencent
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "aea2227b-fbb7-4cc7-bf29-d49b2b6db97c"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidKeyPairId.Malformed 无效密钥对ID。指定的密钥对ID格式错误,例如 ID 长度错误skey-1122
    InvalidKeyPairId.NotFound 无效密钥对ID。指定的密钥对ID不存在。
    InvalidKeyPairName.Duplicate 密钥对名称重复。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    目录