跳转到主要内容
API Explorer|API Explorer
容器管理/容器管理相关接口
POSTContainer Management APIs起始版本 5.3.6同步需要认证

添加容器管理端点

添加容器管理端点

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • managementIpString必填

      管理IP

    • vendorString必填

      供应商

    • managementPortInteger必填

      管理端口

    • containerAccessKeyIdString必填

      容器访问密钥ID

    • containerAccessKeySecretString必填

      容器访问密钥

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    添加接口调用是否成功

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryContainerManagementEndpointInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • accessKeyIdString必填

      访问密钥ID。手动模式时必填。

    • managementIpString必填

      容器管理节点的IP地址

    • managementPortInteger必填

      容器管理节点的端口

    • vendorString必填

      容器管理节点的厂商

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/container/management/endpoint

/zstack/v1/container/management/endpoint

操作 ID

AddContainerManagementEndpoint

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/container/management/endpoint' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","managementIp":"<managementIp>","vendor":"<vendor>","managementPort":1,"containerAccessKeyId":"<containerAccessKeyId>","containerAccessKeySecret":"<containerAccessKeySecret>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "name": "containerEndpoint1", "description": "This is a container management endpoint", "managementIp": "192.168.0.1", "managementPort": 8080, "vendor": "VendorName" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史