边界安全云服务器详细信息

1. 描述

查询边界安全云服务器详细信息。

2. 请求地址

请求地址的格式如下：

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

3. 请求参数

4. 请求示例

4.1. 请求地址

POST https://cn-east-1.api.yovole.com/v1/ess/detail 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",
  "id": "f75d31d7-f624-44ab-b334-814f23a624d4"
}

5. 返回结果

5.1. 返回正确结果示例

{
  "success": true,
  "code": 200,
  "requestId": "68aee942-4aa2-11ed-b9ed-fb9af83c2b16",
  "model": {
    "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",
        "masterPortFlag": false,
        "eipId": "e569711a-e831-4079-bc17-daa1062fd36a",
        "eipSn": "EIP-214SYC7",
        "eipName": "api_test_EIP",
        "eipAddress": "10.3.31.56",
        "eipTypeName": "BGP",
        "securityGroups": [
          {
            "id": "34b507c7-fb5b-41b8-8500-b5375e0b6e10",
            "name": "ESS-21A-0017X",
            "sn": "ESS-21A-0017X"
          }
        ]
      },
      {
        "subnetId": "fb37e457-3bb6-4b19-a541-a41e6ade48e6",
        "subnetName": "默认子网",
        "subnetSn": "SN-21A-4TN43",
        "subnetIp": "10.0.0.11",
        "subnetCidr": "10.0.0.0/24",
        "masterPortFlag": true,
        "securityGroups": [
          {
            "id": "740490ca-67cf-41dd-aaab-b1168e7c8d9c",
            "name": "默认安全组",
            "sn": "SG-214TJZ2"
          }
        ]
      }
    ],
    "flavorId": "ess.c1.medium",
    "flavorName": "ess.c1.medium",
    "cpu": 2,
    "ram": 2,
    "imageId": "SANGFOR-1",
    "imageName": "深信服云防火墙vAF8.0.32R1",
    "updated": "2022-10-13 10:51:57",
    "description": "ess desc",
    "vpcVO": {
      "id": "2984ede8-adf5-4ef8-b289-f79bb69ee649",
      "sn": "VPC-214TA9R",
      "name": "默认VPC",
      "cidr": "10.0.0.0/16"
    }
  }
}

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字段了解错误分类和具体的错误原因。

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