边界安全云服务器列表

1. 描述

获取可用边界安全云服务器列表

2. 请求地址

请求地址的格式如下：

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

3. 请求参数

4. 请求示例

4.1. 请求地址

POST https://cn-east-1.api.yovole.com/v1/ess/list HTTP/1.1
  x-ycs-timestamp: 2022-10-10T14: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": "8a83a0966a681da5016a874df50b10ce",
  "azSN": "CN-EAST-1-A",
  "curPage": 1,
  "perPage": 10
}

5. 返回结果

5.1. 返回正确结果示例

{
  "success": true,
  "code": 200,
  "requestId": "47116bfa-49fe-11ed-ab19-fb9af83c2b16",
  "pager": {
    "curPage": 1,
    "perPage": 10,
    "totalRecords": 2,
    "totalPages": 1,
    "pageData": [
      {
        "id": "d86d4e09-09c2-497c-8ba1-4be876d83bc0",
        "name": "api_test",
        "sn": "ESS-21A-0017X",
        "regionSn": "CN-EAST-1",
        "azSn": "CN-EAST-1-A",
        "created": "2022-10-09 16:40:45",
        "billingType": "PRE_PAID",
        "expired": "2022-12-12 00:00:00",
        "azName": "可用区国定",
        "status": "ACTIVE",
        "osTypeName": "深信服",
        "sysDiskSize": 200,
        "portInfos": [
          {
            "subnetId": "public_subnet",
            "subnetName": "public_subnet",
            "subnetSn": "public_subnet",
            "subnetIp": "10.3.21.5",
            "subnetCidr": "10.3.20.0/24"
          },
          {
            "subnetId": "fb37e457-3bb6-4b19-a541-a41e6ade48e6",
            "subnetName": "默认子网",
            "subnetSn": "SN-21A-4TN43",
            "subnetIp": "10.0.0.11",
            "subnetCidr": "10.0.0.0/24"
          }
        ],
        "flavorId": "ess.c1.medium",
        "flavorName": "ess.c1.medium",
        "cpu": 2,
        "ram": 2,
        "imageId": "SANGFOR-1",
        "imageName": "深信服云防火墙vAF8.0.32R1"
      },
      {
        "id": "be5a0ead-ebb2-41ea-911f-c90d53019f83",
        "name": "test",
        "sn": "ESS-21A-000WM",
        "regionSn": "CN-EAST-1",
        "azSn": "CN-EAST-1-A",
        "created": "2022-10-09 14:57:30",
        "billingType": "PRE_PAID",
        "expired": "2022-11-09 14:56:55",
        "azName": "可用区国定",
        "status": "ACTIVE",
        "osTypeName": "深信服",
        "sysDiskSize": 200,
        "portInfos": [
          {
            "subnetId": "fb37e457-3bb6-4b19-a541-a41e6ade48e6",
            "subnetName": "默认子网",
            "subnetSn": "SN-21A-4TN43",
            "subnetIp": "10.0.0.4",
            "subnetCidr": "10.0.0.0/24"
          },
          {
            "subnetId": "public_subnet",
            "subnetName": "public_subnet",
            "subnetSn": "public_subnet",
            "subnetIp": "10.3.21.2",
            "subnetCidr": "10.3.20.0/24"
          }
        ],
        "flavorId": "ess.c1.medium",
        "flavorName": "ess.c1.medium",
        "cpu": 2,
        "ram": 2,
        "imageId": "SANGFOR-1",
        "imageName": "深信服云防火墙vAF8.0.32R1"
      }
    ]
  }
}

5.2. 返回错误结果示例

{
  "requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
  "success": false,
  "code": 400,
  "message": "Required attribute 'projectId' not specified",
  "errorCode": "Invalid argument"
}

6. 错误码

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

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