API标准及多语言预置SDK
本产品（IoTCC/2021-05-13）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
服务开通
|
API |
标题 |
API概述 |
| OpenIoTCloudConnectorService | 开通云连接器服务 | 开通云连接器服务。 |
地域
|
API |
标题 |
API概述 |
| ListRegions | 查询云连接器支持的地域列表 | 查询云连接器支持的地域列表。 |
APN
|
API |
标题 |
API概述 |
| ListAPNs | 查询APN | 查询云连接器实例支持的APN列表。 |
云连接器
|
API |
标题 |
API概述 |
| CreateIoTCloudConnector | 创建云连接器实例 | 创建云连接器实例。 |
| UpdateIoTCloudConnectorAttribute | 更新云连接器实例信息 | 更新云连接器实例信息。 |
| ListIoTCloudConnectors | 查询云连接器实例信息 | 查询云连接器实例信息。 |
| ListIoTCloudConnectorAvailableZones | IoTCC实例绑定交换机可用区 | 查询支持云连接器实例绑定交换机的可用区。 |
| 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概述 |
| CreateGroupAuthorizationRule | 实例组创建授权规则 | 实例组创建授权规则。 |
| UpdateGroupAuthorizationRuleAttribute | 修改实例组的授权规则 | 修改实例组的授权规则。 |
| ListGroupAuthorizationRules | 查询实例组的授权规则 | 查询实例组的授权规则信息。 |
| DeleteGroupAuthorizationRule | 删除实例组的授权规则 | 删除实例组的授权规则。 |
授权VBR
|
API |
标题 |
API概述 |
| GrantVirtualBorderRouter | 授权绑定VBR | 获取边界路由器VBR的服务关联角色SLR权限。 |
DNS授权规则
|
API |
标题 |
API概述 |
| CreateDNSServiceRule | 创建DNS授权规则 | 创建DNS授权规则。 |
| UpdateDNSServiceRuleAttribute | 修改DNS授权规则 | 修改DNS授权规则。 |
| ListDNSServiceRules | 查询DNS授权规则 | 查询DNS授权规则。 |
| DeleteDNSServiceRule | 删除DNS授权规则 | 删除DNS授权规则。 |
| MoveAuthorizationRuleToDNSService | 授权规则转移到DNS授权规则 | 将授权规则转移到DNS授权规则中。 |
实例组DNS授权规则
|
API |
标题 |
API概述 |
| CreateGroupDNSServiceRule | 实例组创建DNS授权规则 | 实例组创建DNS授权规则。 |
| UpdateGroupDNSServiceRuleAttribute | 改实例组的DNS授权规则 | 修改实例组的DNS授权规则。 |
| ListGroupDNSServiceRules | 查询实例组的DNS授权规则 | 查询实例组的DNS授权规则。 |
| MoveGroupAuthorizationRuleToDNSService | 实例组规则转移到DNS授权规则 | 将实例组的授权规则转移到DNS授权规则中。 |
| DeleteGroupDNSServiceRule | 删除实例组的DNS授权规则 | 删除实例组的DNS授权规则。 |
访问日志
|
API |
标题 |
API概述 |
| EnableIoTCloudConnectorAccessLog | 开启访问日志功能 | 指定云连接器开启访问日志功能。 |
| DisableIoTCloudConnectorAccessLog | 关闭访问日志功能 | 关闭访问日志功能。 |
| GetIoTCloudConnectorAccessLog | 获取指定云连接器访问日志 | 获取指定云连接器访问日志状态信息。 |
分应用统计服务
|
API |
标题 |
API概述 |
| CreateService | 创建分应用统计服务 | 创建分应用统计服务。 |
| UpdateServiceAttribute | 修改分应用统计服务 | 修改分应用统计服务。 |
| ListService | 查询分应用统计服务 | 查询分应用统计服务。 |
| DeleteService | 删除分应用统计服务 | 删除分应用统计服务。 |
应用条目
|
API |
标题 |
API概述 |
| CreateServiceEntry | 分应用功能列表中添加应用条目 | 分应用统计服务列表中添加应用条目。 |
| UpdateServiceEntryAttribute | 修改分应用统计列表的应用条目 | 修改分应用统计服务列表中的应用条目。 |
| ListServiceEntries | 查询分应用统计条目 | 查询分应用统计条目。 |
| DeleteServiceEntry | 删除分应用统计条目 | 删除分应用统计条目。 |
网络诊断
|
API |
标题 |
API概述 |
| SubmitDiagnoseTaskForSingleCard | 提交单卡诊断任务 | 提交单卡诊断任务。 |
| GetDiagnoseResultForSingleCard | 获取单卡诊断结果 | 获取单卡诊断结果。 |
| ListDiagnoseInfoForSingleCard | 查询单卡诊断的诊断结果信息 | 查询单卡诊断的诊断结果信息。 |
回程路由
|
API |
标题 |
API概述 |
| CreateIoTCloudConnectorBackhaulRoute | 创建当前云连接器实例绑定VPC后的回程路由 | 调用CreateIoTCloudConnectorBackhaulRoute接口创建当前云连接器实例绑定VPC后的回程路由。 |
| ListIoTCoudConnectorBackhaulRoute | 查询当前云连接器实例绑定VPC后的回程路由 | 调用ListIoTCoudConnectorBackhaulRoute接口查询当前云连接器实例绑定VPC后的回程路由。 |
| DeleteIoTCloudConnetorBackhaulRoute | 删除当前云连接器实例绑定VPC后的回程路由 | 调用DeleteIoTCloudConnetorBackhaulRoute接口删除当前云连接器实例绑定VPC后的回程路由。 |
授权规则IP重定向
|
API |
标题 |
API概述 |
| CreateIpMappingRule | 创建授权规则IP的重定向功能 | 调用CreateIpMappingRule接口创建授权规则IP的重定向功能。 |
| UpdateIpMappingRule | 修改授权规则IP重定向的相关信息 | 调用UpdateIpMappingRule接口修改授权规则IP重定向的相关信息。 |
| ListIpMappingRules | 查询授权规则IP重定向信息 | 调用ListIpMappingRules接口查询授权规则IP重定向信息。 |
| DeleteIpMappingRule | 删除授权规则IP重定向信息 | 调用DeleteIpMappingRule接口删除授权规则IP重定向信息。 |
实例组授权规则IP重定向
|
API |
标题 |
API概述 |
| CreateGroupIpMappingRule | 创建实例组授权规则IP的重定向规则 | 调用CreateGroupIpMappingRule接口创建实例组授权规则IP的重定向规则。 |
| UpdateGroupIpMappingRule | 修改实例组授权规则IP重定向的相关信 | 调用UpdateGroupIpMappingRule接口修改实例组授权规则IP重定向的相关信息。 |
| ListGroupIpMappingRules | 查询实例组授权规则IP重定向信息 | 调用ListGroupIpMappingRules接口查询实例组授权规则IP重定向信息。 |
| DeleteGroupIpMappingRule | 删除实例组授权规则IP重定向信息 | 调用DeleteGroupIpMappingRule接口删除实例组授权规则IP重定向信息。 |
实例过户
|
API |
标题 |
API概述 |
| ConfirmIoTCloudConnector | 确认或拒绝云连接器实例过户 | 调用ConfirmIoTCloudConnector接口确认或拒绝云连接器实例过户。 |
| RevertIoTCloudConnector | 归还已拒绝过户的云连接器实例 | 调用RevertIoTCloudConnector接口归还已拒绝过户的云连接器实例。 |
其他
|
API |
标题 |
API概述 |
| DeleteAuthorizationRules | 批量删除授权规则 | 批量删除授权规则。 |
该文章对您有帮助吗？