查询单张物联网卡的网络诊断结果。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| iotcc:GetDiagnoseResultForSingleCard | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DiagnoseTaskId | string | 是 | 网络诊断任务 ID。 | diagnoseTask-bp2qhwdp2n9x6zkvq**** |
| RegionNo | string | 否 | 地域 ID。 | cn-hangzhou |
返回参数
诊断部件的诊断指标项。取值:
Part: Card
- CardStatus: 卡状态
- CardOnlineStatus: 卡会话状态
Part: Apn
- GreTunnelStatus: 运营商隧道状态
Part: CCIOT
- CciotInstanceStatus: 云连接器实例状态
- CciotConnectionPoolConfiged: 云连接器连接池配置状态
- CciotAuthorizationRulesConfiged: 云连接器授权规则配置状态
- CardInCciotConnectionPool: 卡在云连接器实例连接池中
- DestinationInCciotAuthorizationRules: 目的地址在云连接器实例授权规则中
- DefaultDnsInCciotDnsServiceRules: 默认的 DNS 服务地址在授权规则中
- DestinationConflictWithIpMapping: 目的地址与 IP 映射冲突
- CciotAssociateWithVswitch: 云连接器实例关联 VPC
- BackhaulRoutePublishedInVpc: 云连接器实例回程路由发布状态
- BackhaulRouteExsited: 云连接器实例回程路由存在状态
- DnsParseStatus: 云连接器实例 DNS 解析状态
- AccessLogFromCardToDestination: 卡到目的地址的访问记录
- AccessLogFromDestinationToCard: 目的地址到卡的访问记录
- AccessLogOfCard: 卡的访问记录
- AccessLogOfDesination: 目的地址到访问记录
- DropLogOfCard: 卡的丢包记录
- DropLogOfDestination: 目的地址的丢包记录
- CciotCardOnlineStatus: 卡在线状态
示例
正常返回示例
JSON格式
{
"RequestId": "94032572-8758-575E-B306-86F59D1B826E",
"WirelessCloudConnectorId": "cc5g-xxxx",
"CardIp": "10.176.78.61",
"IccId": 89860477102170130000,
"Destination": "106.14.175.4",
"DestinationType": "Domain",
"BeginTime": 1646100223024,
"EndTime": 1646100223264,
"Status": "failed",
"ErrorResult": [
{
"ErrorLevel": "Warning",
"ErrorPart": "Terminal",
"ErrorItem": "CardStatus",
"ErrorDesc": "Terminal abnormal",
"ErrorSuggestion": "Please check whether the terminal and card are compatible or whether the terminal can send messages"
}
],
"DiagnoseItem": [
{
"Part": "Terminal",
"Status": "Wrong",
"SubItems": [
{
"SubItem": "CardStatus",
"SubItemStatus": "Normal",
"SubItemInfo": "Card status is real-time"
}
]
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.RAM | Ram user does not have permission to perform this operation. | 子账号未获取5G上云服务RAM权限。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-03-07 | OpenAPI 错误码发生变更 | 查看变更详情 |