跳至主内容

获取已配置集成

此方法可获取指定公司在 集成中心 .

参数

参数

描述

包含在请求中

类型

取值

companyID

需要获取配置的公司ID。

可选

字符串

发起请求的用户必须拥有该ID所属公司的网络管理员权限。

默认值:请求所用API密钥关联的公司ID。

这些是公共API方法通用的参数。

参数

描述

包含在请求中

类型

取值

id

该参数为请求添加标识符,用于关联对应响应。

目标方在响应中返回相同值,便于调用追踪。

必填

字符串

无额外要求

method

请求所使用的API方法名称。

必填

字符串

必须是有效的方法名。

jsonrpc

请求与响应所使用的JSON-RPC协议版本。

必填

整数

可选值:

  • 2.0

params

包含请求配置参数的对象。

必填

对象

无额外要求。

params 对象中

page

结果页码。

可选

整数

默认值: 1

perPage

每页显示的结果数量。

可选

整数

每页上限为100条。

默认值: 30

返回值

属性

类型

描述

total

整数

表示目标公司配置的集成总数。

data

对象数组

提供每个集成详细信息的对象列表。

对象

data

属性

类型

描述

id

字符串

集成的ID。

name

字符串

集成的名称。

type

整数

集成的类型。

可选值:

  • 1 - VMware集成

详情

对象

集成服务的配置设置。

类别

对象

包含与集成服务关联的类别。

更多信息请参阅 类别 .

公司

对象

包含集成服务配置所在公司的相关信息。

状态

整数

请求时集成服务的状态。

可能取值:

  • 0 - 未授权

  • 1 - 可用

  • 2 - 已停止

  • 3 - 需操作

  • 4 - 待处理

  • 5 - 活跃

  • 6 - 错误

  • 7 - 许可证使用已达上限

具体说明

属性

类型

描述

主机名

字符串

集成vCenter服务器的 IP主机名

端口

整数

用于连接vCenter的端口号。

用户名

字符串

用于vCenter认证的用户名。

重试认证

布尔值

指示集成是否在认证失败时重试。

认证重试等待时间

整数

认证重试之间的等待时间(秒)。

最大认证重试次数

整数

允许的最大认证重试次数。

验证TLS证书

布尔值

指定连接vCenter服务器时是否验证TLS证书。

viewType

Integer

集成类型。

可选值:

  • 1 - 虚拟机和模板

  • 2 - 主机和集群。

category

Attribute

Type

Description

Backup

Boolean

指示该集成是否归类于 Backup 类别。

备份类集成用于执行定期数据备份,帮助防范数据丢失、损坏或勒索软件攻击。

DirectoryServices

Boolean

指示该集成是否归类于 DirectoryServices 类别。

目录服务类集成用于通过Active Directory或LDAP等集中式系统管理用户身份和访问权限。

InventoryManagement

Boolean

指示该集成是否归类于 InventoryManagement 类别。

库存管理类集成用于跟踪和管理IT资产,包括硬件、软件及系统配置。

虚拟化

布尔值

表示该集成是否归类于 虚拟化 类别。

虚拟化集成用于创建、管理和监控虚拟机及虚拟环境。

邮件保护

布尔值

表示该集成是否归类于 邮件保护 类别。

邮件保护集成用于检测和防范钓鱼邮件、垃圾邮件、恶意软件及其他基于邮件的威胁。

云保护

布尔值

表示该集成是否归类于 云保护 类别。

云保护集成用于保护云基础设施、SaaS平台及云端存储数据的安全。

安全培训

布尔值

表示该集成是否归类于 安全培训 类别。

安全培训集成用于提供网络安全意识课程,帮助教育用户并降低人为风险。

公司

属性

类型

描述

ID

字符串

公司的ID。

名称

字符串

公司的名称。

示例

请求 :

{
  "method": "getConfiguredIntegrations",
  "id": "f197ade6-c4b3-4378-9076-11dccaeebdd6",
  "jsonrpc": "2.0",
  "params": {
    "companyId": "679b694c5dd72429d20a72c3"
  }
}

响应 :

{
  "id": "f197ade6-c4b3-4378-9076-11dccaeebdd6",
  "jsonrpc": "2.0",
  "result": {
    "data": [
      {
        "id": "679b6952a5d00afed203cbd7",
        "name": "integrationI4n6dw9O5y0szQDIMpv1",
        "type": 1,
        "specifics": {
          "hostname": "XhYqpld4GW.com",
          "port": 443,
          "username": "username",
          "viewType": 1,
          "retryAuthentication": true,
          "retryAuthenticationTimeToWait": 5,
          "retryAuthenticationMaxAttempts": 3,
          "verifyTLSCertificate": true
        },
        "category": {
          "virtualization": true,
          "directoryServices": true
        },
        "company": {
          "id": "679b694c5dd72429d20a72c3",
          "name": "GetConfiguredIntegrations1738238284.468232BHk5q6E9V2"
        },
        "status": 3
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 30
  }
}