Skip to content

API

Jump to bottom
Zheng Ya edited this page Sep 22, 2022 · 3 revisions

目录

资源 操作 HTTP Method
云平台 获取全部 GET
创建单个云平台 GET
修改单个云平台 PATCH
删除单个云平台 DELETE

云平台

GET

  • URL:

    /v1/domains/

  • filter

    字段 类型 支持多个
    lcuuid string 否

  • Response:

      {
      'OPT_STATUS': 'SUCCESS',
      'WAIT_CALLBACK': False,
      'TASK': None,
      'DESCRIPTION': '',
      'TYPE': 'dict',
      'DATA': [{
          "ID": 159,
          "NAME": "aliyun#2",
          "ICON_ID": 125,
          "DISPLAY_NAME": "aliyun#2",
          "IP": null,
          "ROLE": null,
          "TYPE": 9,
          "LCUUID": "cc78ce1d-96ce-4eb7-959d-24a1a75794dd",
          "PUBLIC_IP": null,
          "CREATED_AT": "2020-09-11 14:27:14",
          "CONFIG": "{\"region_uuid\":\"\",\"secret_id\":\"1\",\"secret_key\":\"1\",\"exclude_regions\":\"\"}",
          "ERROR_MSG": null,
          "ENABLED": 0,
          "DELETED": 0,
          "STATE": 1,
          "AZ_COUNT": 0,
          "REGION_COUNT": 0
      }]
  }

POST

  • URL:

    /v1/domains/

  • Request：

      {
      "NAME": "aliyun#2",
      "CONFIG": {"region_uuid": "", "secret_id": "1", "secret_key": "1", "exclude_regions": ""},
      "ICON_ID": 3,
      "TYPE": 2
  }

  • Response:

      {
      'OPT_STATUS': 'SUCCESS',
      'WAIT_CALLBACK': False,
      'TASK': None,
      'DESCRIPTION': '',
      'TYPE': 'dict',
      'DATA': {
          "ID": 159,
          "NAME": "aliyun#2",
          "ICON_ID": 125,
          "DISPLAY_NAME": "aliyun#2",
          "IP": null,
          "ROLE": null,
          "TYPE": 9,
          "LCUUID": "cc78ce1d-96ce-4eb7-959d-24a1a75794dd",
          "PUBLIC_IP": null,
          "CREATED_AT": "2020-09-11 14:27:14",
          "CONFIG": "{\"region_uuid\":\"\",\"secret_id\":\"1\",\"secret_key\":\"1\",\"exclude_regions\":\"\"}",
          "ERROR_MSG": null,
          "ENABLED": 0,
          "DELETED": 0,
          "STATE": 1,
          "AZ_COUNT": 0,
          "REGION_COUNT": 0
      }
  }

PATCH

  • URL:

    /v1/domains/{lcuuid}/

  • Request：

      {
      "STATE": 1,
      "CONFIG": {
          "region_uuid": "",
          "secret_id": "1",
          "secret_key": "1",
          "exclude_regions": ""
      },
      "ICON_ID": 3
  }

  • Response:

      {
      'OPT_STATUS': 'SUCCESS',
      'WAIT_CALLBACK': False,
      'TASK': None,
      'DESCRIPTION': '',
      'TYPE': 'dict',
      'DATA': {
          "ID": 159,
          "NAME": "aliyun#2",
          "ICON_ID": 125,
          "DISPLAY_NAME": "aliyun#2",
          "IP": null,
          "ROLE": null,
          "TYPE": 9,
          "LCUUID": "cc78ce1d-96ce-4eb7-959d-24a1a75794dd",
          "PUBLIC_IP": null,
          "CREATED_AT": "2020-09-11 14:27:14",
          "CONFIG": {
              "region_uuid": "",
              "secret_id": "1",
              "secret_key": "1",
              "exclude_regions": ""
          },
          "ERROR_MSG": null,
          "ENABLED": 0,
          "DELETED": 0,
          "STATE": 1,
          "AZ_COUNT": 0,
          "REGION_COUNT": 0
      }
  }

DELETE

  • URL:

    /v1/domains/{lcuuid}/

  • Response:

      {
      'OPT_STATUS': 'SUCCESS',
      'WAIT_CALLBACK': False,
      'TASK': None,
      'DESCRIPTION': '',
      'TYPE': 'dict',
      'DATA': {}
  }
Clone this wiki locally