跳转到正文
皓量云擎文档
接口参考SSH 密钥

修改 SSH 密钥名称与备注

PATCH /api/v1/tenants/{tenant_id}/ssh-keys/{key_id},updateSSHKey 的请求参数和响应结构。

PATCH /api/v1/tenants/{tenant_id}/ssh-keys/{key_id}

项目内容
操作标识updateSSHKey
认证登录会话 Cookie

仅保存公钥,按租户权限隔离并记录写入审计。删除记录不撤销已注入实例的公钥;实例密钥注入仍随原生交付接入。

会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。

请求参数

名称位置必填类型说明与约束
tenant_idpath是string格式:uuid
key_idpath是string格式:uuid

请求体

请求体必填。

内容类型:application/json。

字段类型必填说明与约束
namestring是最短 1;最长 64
descriptionstring否最长 500;默认 ""
完整请求结构(含引用定义)
{
  "$ref": "#/$defs/SSHKeyUpdate",
  "$defs": {
    "SSHKeyUpdate": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "description": {
          "type": "string",
          "maxLength": 500,
          "default": ""
        }
      }
    }
  }
}

响应

HTTP 状态含义
200成功
400错误
401错误
403错误
404错误
409错误
500错误
503错误
200 · application/json 响应结构
字段类型必填说明与约束
dataSSHKey是—
request_idstring是—
{
  "$ref": "#/$defs/SSHKeyResponse",
  "$defs": {
    "SSHKeyResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "data": {
          "$ref": "#/$defs/SSHKey"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "data",
        "request_id"
      ]
    },
    "SSHKey": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "description",
        "id",
        "tenant_id",
        "public_key",
        "algorithm",
        "bits",
        "fingerprint",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "description": {
          "type": "string",
          "maxLength": 500,
          "default": ""
        },
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "tenant_id": {
          "type": "string",
          "format": "uuid"
        },
        "public_key": {
          "type": "string",
          "description": "归一化后的 OpenSSH 公钥,不包含注释和私钥。"
        },
        "algorithm": {
          "type": "string",
          "enum": [
            "ssh-ed25519",
            "ssh-rsa"
          ]
        },
        "bits": {
          "type": "integer",
          "minimum": 256
        },
        "fingerprint": {
          "type": "string",
          "description": "公钥 SHA256 指纹。"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}
400 / 401 / 403 / 404 / 409 / 500 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录