ssh密钥列表

SSH密钥列表

1. 描述

获取SSH密钥列表

2. 请求地址

请求地址的格式如下:

https://<区域服务地址>/v1/sshkey/list

3. 请求参数

Name Type Description Required
projectId String 项目ID
curPage Integer 当前页码,默认值1
perPage Integer 每页显示条数,默认值10

4. 请求示例

以获取华东一区某项目下的SSH密钥列表信息为例:

4.1. 请求地址

POST https://cn-east-1.api.yovole.com/v1/sshkey/list HTTP/1.1
  x-ycs-timestamp: 2019-06-19T14:26:26Z
  x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
  x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=

4.2. 接口请求参数

{
  "projectId": "8a83a0906b692378016b6d5ec5f40250",
  "curPage":1,
  "perPage":10
}

5. 返回结果

5.1. 返回正确结果示例

{
  "requestId": "287870f7-0efa-466c-9267-c7d0daea61b1",
  "success": true,
  "code": 200,
  "message": null,
  "model": null,
  "pager": {
    "curPage": 1,
    "perPage": 10,
    "totalRecords": 2,
    "totalPages": 1,
    "pageData": [
      {
        "id": "8a83a0906ab085e2016ad46044a20025",
        "name": "approve",
        "sn": "SSH-8KP2A",
        "regionSn": "CN-EAST-1",
        "created": "2019-05-20 16:33:59",
        "encryptType": "RSA",
        "using": "UNUSED"
      },
      {
        "id": "8a838eac6ad3f9cf016ad3fd84710000",
        "name": "create-test",
        "sn": "SSH-8KP29",
        "regionSn": "CN-EAST-1",
        "created": "2019-05-20 14:46:08",
        "encryptType": "DSA",
        "using": "UNUSED"
      }
    ]
  }
}

5.2. 返回错误结果示例

{
  "requestId": "19c0e7ff-5554-4e90-b3a5-3aab644a8e30",
  "success": false,
  "code": 401,
  "message": "client enabled is false",
  "errorCode": "InvalidUserAccount"
}

6. 错误码

可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。

该接口没有特殊错误码,错误码信息和简单的错误分析方法可以参考公共错误码

个结果匹配 ""

    无结果匹配 ""