内网VIP详情

1. 描述

获取内网VIP详情

2. 请求地址

请求地址的格式如下：

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

3. 请求参数

4. 请求示例

以获取华东一区某内网VIP的详细信息为例：

4.1. 请求地址

POST https://cn-east-1.api.yovole.com/v1/vip/detail 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",
  "id": "f14c4e48-006f-42e6-94e1-ca40865c297c"
}

5. 返回结果示例

5.1. 返回正确结果示例

{
  "requestId": "16bead1a-1d40-47da-b9b3-3cf0a65b7c9f",
  "success": true,
  "code": 200,
  "message": null,
  "model": {
    "id": "7f7091e4-1215-449f-bb24-e6b3d25b2124",
    "name": "update_name",
    "sn": "VIP-21-8KP28",
    "regionSn": "CN-EAST-1",
    "created": "2019-05-24 10:37:06",
    "subnetId": "bb4251f3-40ce-49a9-88ce-a7866d1be8ac",
    "subnetSn": "SN-218KP5A",
    "vpcId": "cf9f6aef-4613-4586-a084-8eead34d7f34",
    "ipAddress": "172.16.10.8",
    "bindCount": 0,
    "eipId": null,
    "eipSn": null,
    "eipName": null,
    "eipAddress": null,
    "eipTypeName": null,
    "vipAttachmentList": [
        {
            "relatedType":"VM",
            "relatedId":"07f788be-93ea-4850-b4df-6eca23d6adee",
            "relatedSn":"VM-21A-8KP60",
            "relatedName":"xxxxxx"
        }
    ]
  }
}

5.2. 返回错误结果示例

{
  "requestId": "8835c71f-cec3-4bdf-92f1-4d55c7f431e9",
  "success": false,
  "code": 404,
  "message": "Vip Not Found",
  "errorCode": "NotFound"
}

6. 错误码

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

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