本产品(
5G高速上云服务/2022-03-14
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
地域信息
API | 标题 | API概述 |
---|---|---|
ListRegions | 查询可用地域列表 | 查询5G高速上云服务支持的地域列表。 |
ListZones | 查询可用区的列表 | 查询5G高速上云服务支持的可用区列表。 |
权限管理
API | 标题 | API概述 |
---|---|---|
OpenCc5gService | 开通服务 | 开通5G高速上云服务。 |
GetCreateCustomerInformation | 获取客户资料录入地址和录入状态 | 获取客户资料录入地址和录入状态。 |
5G上云实例
API | 标题 | API概述 |
---|---|---|
ListAPNs | 查询APN列表 | 查询5G高速上云服务支持的APN列表。 |
CreateWirelessCloudConnector | 创建5G高速上云服务实例 | 创建5G高速上云服务实例。 |
DeleteWirelessCloudConnector | 删除5G高速上云实例 | 删除5G高速上云实例。 |
UpdateWirelessCloudConnector | 更新5G高速上云实例 | 更新5G高速上云实例信息。 |
ListWirelessCloudConnectors | 查询5G高速上云实例列表 | 查询5G高速上云实例列表。 |
AttachVpcToNetLink | 关联用户Vpc和Vswitch | 关联用户Vpc和Vswitch到5G高速上云实例。 |
DetachVpcFromNetLink | 取消关联Vpc和Vswitch | 取消用户Vpc和Vswitch的关联。 |
GetWirelessCloudConnector | 查询5G高速上云实例详情 | 查询5G高速上云实例详细信息。 |
ListDataPackages | 查询流量包信息 | 查询流量包信息列表。 |
CreateIoTCloudConnectorBackhaulRoute | 创建5G高速上云实例反向访问路由 | 开启了反向访问高级特性场景下,针对连接实例下发反向访问路由。 |
DeleteIoTCloudConnectorBackhaulRoute | 删除5G高速上云实例反向访问路由 | 开启了反向访问高级特性场景下,针对连接实例删除反向访问路由 。 |
ModifyWirelessCloudConnectorFeature | 修改5G高速上云实例高级属性 | 修改5G高速上云实例高级属性,例如开启反向访问功能。 |
ListIoTCloudConnectorBackhaulRoute | 查询5G高速上云实例反向访问路由 | 开启了反向访问高级特性场景下,查询特定连接实例的反向访问路由列表。 |
SwitchWirelessCloudConnectorToBusiness | 切换5G上云服务实例到商业模式 | 用于把5G上云服务测试实例切换到商业实例。 |
订单管理
API | 标题 | API概述 |
---|---|---|
ListOrders | 查询订单列表 | 查询订单列表。 |
卡管理
API | 标题 | API概述 |
---|---|---|
LockCards | 批量锁定卡 | 批量锁定卡。 |
UnlockCards | 批量解锁卡 | 批量解锁卡。 |
StopCards | 卡停机操作 | 单卡停机,支持批量操作。 |
ResumeCards | 激活/恢复卡状态 | 激活单卡,或恢复运营商侧卡状态,支持批量操作。 |
UpdateCard | 更新卡信息 | 更新卡实例的名称和描述。 |
ListCards | 查询5G高速上云实例下的卡信息 | 查询5G高速上云实例下的卡信息列表。 |
ListCardUsages | 查询卡流量使用信息 | 查询物联网卡流量使用信息。 |
GetCard | 获取单卡信息 | 获取单卡信息。 |
GetCardLockReason | 获取锁卡原因 | 获取锁卡原因。 |
FailCards | 销卡 | 销卡。 |
RebindCards | 换绑解锁单卡 | 换绑解锁单卡。 |
ListCardDayUsages | 查询单卡单日流量 | 查询单卡单日流量。 |
ResetAreaLimitCards | 区域限制解锁 | 物联网卡区域限制解锁 |
ListCardAreaLimitSupportArea | 查询卡区域解锁支持的省份 | 查询卡区域解锁支持的省份。 |
授权规则
API | 标题 | API概述 |
---|---|---|
CreateAuthorizationRule | 创建授权规则 | 创建授权规则。 |
DeleteAuthorizationRule | 删除授权规则 | 删除授权规则。 |
UpdateAuthorizationRule | 更新授权规则 | 更新授权规则。 |
AddDNSAuthorizationRule | 创建DNS授权规则 | 创建DNS授权规则。 |
UpdateDNSAuthorizationRule | 更新DNS授权规则 | 更新DNS授权规则。 |
ListAuthorizationRules | 查询授权规则 | 查询授权规则列表。 |
卡批量操作
API | 标题 | API概述 |
---|---|---|
CreateBatchOperateCardsTask | 创建批量操作卡任务 | 创建批量操作卡任务。 |
DeleteBatchOperateCardsTask | 删除批量操作卡任务 | 删除批量操作卡任务。 |
UpdateBatchOperateCardsTask | 更新批量操作卡任务 | 更新批量操作卡任务。 |
ListBatchOperateCardsTasks | 列出批量操作卡任务 | 列出批量操作卡任务。 |
网络诊断
API | 标题 | API概述 |
---|---|---|
SubmitDiagnoseTaskForSingleCard | 发起单卡网络诊断 | 发起单张物联网卡的网络诊断。 |
GetDiagnoseResultForSingleCard | 查询单卡诊断结果 | 查询单张物联网卡的网络诊断结果。 |
ListDiagnoseInfoForSingleCard | 查询历史诊断记录 | 查询5G上云实例的历史诊断信息(不包含诊断结果)。 |
授权分享
API | 标题 | API概述 |
---|---|---|
GrantNetLink | 授权云连接器 | 授权云连接器给第三方客户。 |
RevokeNetLink | 撤销授权 | 主动撤销之前授权动作。 |
实例组
API | 标题 | API概述 |
---|---|---|
CreateWirelessCloudConnectorGroup | 创建分组 | 创建cc5g实例分组。 |
UpdateWirelessCloudConnectorGroup | 更新分组信息 | 修改cc5g实例分组信息。 |
ListWirelessCloudConnectorGroups | 查询分组信息 | 查询cc5g实例分组。 |
DeleteWirelessCloudConnectorGroup | 删除分组 | 删除cc5g实例分组。 |
AddWirelessCloudConnectorToGroup | 给分组增加cc5g实例 | 给cc5g实例分组增加cc5g实例。 |
RemoveWirelessCloudConnectorFromGroup | 从分组中移除cc5g实例 | 从cc5g实例分组移除cc5g实例。 |
CreateGroupAuthorizationRule | 创建分组授权规则 | 创建cc5g分组的授权规则。 |
UpdateGroupAuthorizationRule | 更新分组授权规则 | 修改cc5g实例组的授权规则。 |
ListGroupAuthorizationRules | 查询分组授权规则列表 | 查询分组的授权规则列表。 |
DeleteGroupAuthorizationRule | 删除分组授权规则 | 删除cc5g分组授权规则。 |
AddGroupDnsAuthorizationRule | 创建分组DNS授权规则 | 实例组创建DNS授权规则。 |
UpdateGroupDnsAuthorizationRule | 更新分组DNS授权规则 | 修改实例组的DNS授权规则。 |