接口参考SSH 密钥
列出租户 SSH 密钥
GET /api/v1/tenants/{tenant_id}/ssh-keys,listSSHKeys 的请求参数和响应结构。
GET /api/v1/tenants/{tenant_id}/ssh-keys
| 项目 | 内容 |
|---|---|
| 操作标识 | listSSHKeys |
| 认证 | 登录会话 Cookie |
仅保存公钥,按租户权限隔离并记录写入审计。删除记录不撤销已注入实例的公钥;实例密钥注入仍随原生交付接入。
请求参数
| 名称 | 位置 | 必填 | 类型 | 说明与约束 |
|---|---|---|---|---|
| tenant_id | path | 是 | string | 格式:uuid |
| page | query | 否 | integer | 最小值 1;默认 1 |
| page_size | query | 否 | integer | 最小值 1;最大值 100;默认 20 |
响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 400 | 错误 |
| 401 | 错误 |
| 403 | 错误 |
| 404 | 错误 |
| 409 | 错误 |
| 500 | 错误 |
| 503 | 错误 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | SSHKey[] | 是 | — |
| request_id | string | 是 | — |
| meta | PageInfo | 是 | — |
{
"$ref": "#/$defs/SSHKeyListResponse",
"$defs": {
"SSHKeyListResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/$defs/SSHKey"
}
},
"request_id": {
"type": "string"
},
"meta": {
"$ref": "#/$defs/PageInfo"
}
},
"required": [
"data",
"request_id",
"meta"
]
},
"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"
}
}
},
"PageInfo": {
"type": "object",
"additionalProperties": false,
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"page",
"page_size",
"total"
]
}
}
}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 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
