文档

ListIpMappingRules - 查询授权规则IP重定向信息

更新时间:

调用ListIpMappingRules接口查询授权规则IP重定向信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
IpMappingRuleIdsarray

需要进行 IP 重定向的授权规则的 ID。

string

需要进行 IP 重定向的授权规则的 ID。最多支持 20 个授权规则 ID。

im-irrp3bzuu5nrbx****
MappingIpsarray

需要进行重定向的 IP 地址。

string

需要进行重定向的 IP 地址。最多支持 20 个重定向的 IP 地址。

47.0.XX.XX
IpMappingRuleStatusesarray

授权规则 IP 重定向的状态。最多支持 20 个授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

string

授权规则 IP 重定向的状态。最多支持 20 个授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

Created
IpMappingRuleNamesarray

需要进行 IP 重定向的授权规则名称。

string

需要进行 IP 重定向的授权规则名称。最多支持 20 个授权规则名称。

长度为 2~128 个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

name
DestinationIpsarray

重定向的目标 IP 地址。

string

重定向的目标 IP 地址。最多支持 20 个目标 IP 地址。

192.168.10.8
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
RegionIdstring

实例所在的地域 ID。

您可以通过调用 ListRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

列表条目数。

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

20
IpMappingRulesobject []

授权规则 IP 重定向列表。

IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
IpMappingRuleIdstring

需要进行 IP 重定向的授权规则的 ID。

im-irrp3bzuu5nrbx****
IpMappingRuleStatusstring

授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

Created
MappingIpstring

需要进行重定向的 IP 地址。

47.0.XX.XX
DestinationIpstring

重定向的目标 IP 地址。

192.168.10.8
IpMappingRuleNamestring

需要进行 IP 重定向的授权规则名称。

name
IpMappingRuleDescriptionstring

需要进行 IP 重定向的授权规则描述。

description

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "IpMappingRules": [
    {
      "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
      "IpMappingRuleId": "im-irrp3bzuu5nrbx****",
      "IpMappingRuleStatus": "Created",
      "MappingIp": "47.0.XX.XX",
      "DestinationIp": "192.168.10.8",
      "IpMappingRuleName": "name",
      "IpMappingRuleDescription": "description"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法

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

变更历史

变更时间变更内容概要操作
2022-08-20新增 OpenAPI看变更集
  • 本页导读 (1)