API概览

更新时间: 2023-10-17 13:14:30
本产品(云连接器/2021-05-13)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务开通

API标题API概述
OpenIoTCloudConnectorService开通云连接器服务开通云连接器服务。

APN

API标题API概述
ListAPNs查询APN查询云连接器实例支持的APN列表。

云连接器

API标题API概述
CreateIoTCloudConnector创建云连接器实例创建云连接器实例。
UpdateIoTCloudConnectorAttribute更新云连接器实例信息更新云连接器实例信息。
ListIoTCloudConnectors查询云连接器实例信息查询云连接器实例信息。
ListIoTCloudConnectorAvailableZonesIoTCC实例绑定交换机可用区查询支持云连接器实例绑定交换机的可用区。
AssociateVSwitchWithIoTCloudConnector交换机与云连接器实例进行关联将交换机与云连接器实例进行关联。
DissociateVSwitchFromIoTCloudConnector解绑vsw/vpc将交换机与云连接器实例解关联。
ListIoTCloudConnectorEIPs查询云连接器实例关联的弹性公网IP列表调用ListIoTCloudConnectorEIPs接口查询云连接器实例关联的弹性公网IP列表。
DeleteIoTCloudConnector删除云连接器实例删除云连接器实例。

连接池

API标题API概述
CreateConnectionPool创建连接地址池创建连接地址池。
AddCidrToConnectionPool连接池增加连接IP段连接池增加连接IP段,主要用于动态IP增加IP方式,区别于单个卡IP添加方式。
UpdateConnectionPoolAttribute更新连接地址池更新连接地址池。
ListConnectionPools查询云连接地址池查询云连接地址池。
ListConnectionPoolIps查询连接地址池中的IP地址状态查询连接地址池中的IP地址状态信息。
GetStsInfoAndOssPath获取服务账号信息和提交地址获取服务账号STS信息和模板文件临时提交地址。
AssociateIpWithConnectionPool绑定IP地址与云连接器关联的连接地址池绑定某个已存在的IP访问控制。
DissociateIpFromConnectionPool解绑卡IP解除IP地址与云连接器关联的连接地址池的绑定关系。
GetConnectionPoolIpOperationResult获取IP地址绑定与解绑结果获取IP地址与连接地址池绑定与解绑的操作结果。
ListConnectionPoolAllIps查询连接地址池所有IP地址查询连接地址池所有IP地址信息。
DeleteConnectionPool删除连接地址池删除连接地址池。

授权规则

API标题API概述
CreateAuthorizationRule创建授权规则创建授权规则。
CreateAuthorizationRules创建多条授权规则调用CreateAuthorizationRules接口创建多条授权规则。
UpdateAuthorizationRuleAttribute更新授权规则信息更新授权规则信息。
ListAuthorizationRules查询授权规则查询授权规则信息。
DeleteAuthorizationRule删除授权规则删除授权规则。

实例组

API标题API概述
CreateIoTCloudConnectorGroup创建实例组创建实例组。
AddIoTCloudConnectorToGroup添加云连接器到分组中为实例组添加云连接器实例。
UpdateIoTCloudConnectorGroupAttribute修改云连接器分组属性修改云连接器分组属性。
ListIoTCloudConnectorGroups查询实例组列表信息查询实例组列表信息。
RemoveIoTCloudConnectorFromGroup将云连接器实例从实例组中移除将云连接器实例从实例组中移除。
DeleteIoTCloudConnectorGroup删除实例组删除实例组。

实例过户

API标题API概述
RevertIoTCloudConnector归还已拒绝过户的云连接器实例调用RevertIoTCloudConnector接口归还已拒绝过户的云连接器实例。

其他

API标题API概述
DeleteAuthorizationRules批量删除授权规则批量删除授权规则。
阿里云首页 云连接器 相关技术圈