修改密钥对属性
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： cvm.api3.cloud.sunhongs.com。
本接口 (ModifyKeyPairAttribute) 用于修改密钥对属性。
- 修改密钥对ID所指定的密钥对的名称和描述信息。
- 密钥对名称不能和已经存在的密钥对的名称重复。
- 密钥对ID是密钥对的唯一标识，不可修改。
默认接口请求频率限制：10次/秒。
接口更新时间：2023-07-19 10:40:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyKeyPairAttribute |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| KeyId | 是 | 否 | String | 密钥对ID，密钥对ID形如：skey-11112222。<br><br>可以通过以下方式获取可用的密钥 ID：<br><li>通过登录控制台查询密钥 ID。<br><li>通过调用接口 DescribeKeyPairs ，取返回信息中的 KeyId 获取密钥对 ID。 |
| KeyName | 否 | 否 | String | 修改后的密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。 |
| Description | 否 | 否 | String | 修改后的密钥对描述信息。可任意命名，但不得超过60个字符。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidKeyPairId.Malformed | |
| InternalServerError | |
| InvalidParameter | |
| InvalidKeyPairId.NotFound | |
| MissingParameter | |
| InvalidKeyPairName.Duplicate |