调用该接口设置实例支持的IP协议版本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateInstanceInternetProtocol

系统规定参数。取值:UpdateInstanceInternetProtocol。

IotInstanceId String iot-cn-n6w1y59****

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见实例概述

IpVersion String IPv4

IP协议版本:

  • IPv4(默认)
  • IPv6
说明 当IP协议版本设置为IPv6,流媒体相关地址会修改为IPv4/IPv6双栈地址,请确保您的设备和应用端已完成IPv6相关设置,否则会出现播放画面加载失败等异常情况。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String 200

接口返回码:

  • 200:表示成功。
  • 其它:表示错误码。错误码详情,请参见错误码
Data Map

响应结果。

ErrorMessage String InvalidParameter

调用失败时,返回的出错信息。

RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功:

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=UpdateInstanceInternetProtocol
&IotInstanceId=iot-cn-n6w1y59****
&IpVersion=IPv4
&<公共请求参数>

正常返回示例

XML格式

<UpdateInstanceInternetProtocolResponse>
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</UpdateInstanceInternetProtocolResponse>

JSON格式

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Code": 200,
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 iot.lv.requestParamError Request parameter error. 请求参数错误
403 iot.lv.requestAuthError Request auth error. 认证出错
400 iot.lv.requestError Request error 请求出错

访问错误中心查看更多错误码。