显示带外映射

最近更新时间: 2026-11-06 00:17:12

1. 接口描述

接口请求域名： bms.api3.fincloud.tencent.cn。

显示带外映射

默认接口请求频率限制：20次/秒。

接口更新时间：2025-12-30 17:10:15。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeOutbandIP
Version	是	否	String	公共参数，本接口取值：2018-08-13
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	否	否	String	BMS实例ID 示例值： bms-adafghjk
Offset	否	否	Int64	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介]中的相关小节。示例值： 0
Limit	否	否	Int64	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介]中的相关小节。示例值： 20

3. 输出参数

参数名称	类型	描述
InstanceSet	Array of OutbandInfo	BMS映射详细信息示例值：查看
TotalCount	Uint64	信息条目总数量示例值： 100
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.InstanceIdMalformed	无效实例`ID`。指定的实例`ID`格式错误。例如实例`ID`长度错误`bms-1122`。

5. 示例

示例1 显示带外映射

输入示例

{"Limit":20,"Offset":0}

输出示例

DescribeOutbandIP
{
    "Response": {
        "InstanceSet": [
            {
                "InstanceId": "bms-79180c7d",
                "InstanceName": "TEST",
                "UniqVpcId": "vpc-7z9vr80d",
                "Vip": "10.1.0.39",
                "Vport": "443 (web);5001 (KVM)",
                "UniqSubnetId": "subnet-qx4hz7jm"
            }
        ],
        "TotalCount": 1,
        "RequestId": "ceba06af-4490-1c4d-4ccb-35e40ee0a34d"
    }
}