网关列表

最近更新时间:2024-11-04 16:57:45

我的收藏

1. 接口描述

接口请求域名: csip.tencentcloudapi.com 。

获取网关列表

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGatewayAssets。
Version String 公共参数,本接口取值:2022-11-21。
Region String 公共参数,此参数为可选参数。
MemberId.N Array of String 集团账号的成员id
示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"]
Filter Filter 过滤参数
示例值:{ "Filters": [ { "Name": "Status", "Values": [ "0" ], "OperatorType": 7 }, { "Name": "Uin", "Values": [ "100065" ], "OperatorType": 7 } ], "Limit": 10, "Offset": 0, "StartTime": "2024-10-26 00:00:00", "EndTime": "2024-11-01 23:59:59" }

3. 输出参数

参数名称 类型 描述
Data Array of GateWayAsset 列表
示例值:[ { "AddressIPV6": "27::1", "AppId": "1827324", "AssetId": "cfwnat-a2b9957b", "AssetName": "autoDev", "AssetType": "NATFW", "ConfigureRisk": 0, "CreateTime": "2022-11-28 01:30:55", "EngineRegion": "sg", "ExposedPort": 0, "ExposedVUL": 0, "InboundCumulativeFlow": "352.00KB", "InboundPeakBandwidth": "1.75Kbps", "IsCore": 1, "IsNewAsset": 0, "LastScanTime": "2024-08-22 21:45:10", "NetworkAttack": 0, "Nick": "master", "OutboundCumulativeFlow": "38.67KB", "OutboundPeakBandwidth": "272.00bps", "PrivateIp": "172.0.12.3", "PublicIp": "1..*.59", "Region": "ap-shanghai", "RiskExposure": 0, "ScanTask": 0, "Status": "1", "Tag": [{"Name":"name1","Value":"value1"}], "Uin": "18146", "VpcId": "vpc-omoo5lv", "VpcName": "vpc-omoo5lv" } ]
TotalCount Integer 总数
示例值:10
RegionList Array of FilterDataObject 地域列表
示例值:[ { "Text": "上海", "Value": "ap-shanghai" }, { "Text": "北京", "Value": "ap-beijing" }, { "Text": "广州", "Value": "ap-guangzhou" } ]
AssetTypeList Array of FilterDataObject 资产类型列表
示例值:[ { "Text": "ENI", "Value": "ENI" } ]
VpcList Array of FilterDataObject vpc列表
示例值:[ { "Text": "fengqqian3", "Value": "vpc-m819242" }, { "Text": "fengqqian2", "Value": "vpc-fw2dus5f" }, { "Text": "Default-VPC", "Value": "vpc-omoo5lv" } ]
AppIdList Array of FilterDataObject appid列表
示例值:[ { "Value": "1894", "Text": "1894" } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayAssets
<公共请求参数>

{
    "MemberId": [
        "mem-68b8087a65268000",
        "mem-tencent-522badef8ad96a4d"
    ]
}

输出示例

{
    "Response": {
        "AppIdList": [
            {
                "Text": "1827324",
                "Value": "1827324"
            },
            {
                "Text": "1302396215",
                "Value": "1302396215"
            }
        ],
        "AssetTypeList": [
            {
                "Text": "NATFW",
                "Value": "NATFW"
            },
            {
                "Text": "NAT",
                "Value": "NAT"
            },
            {
                "Text": "PROBE",
                "Value": "PROBE"
            },
            {
                "Text": "CLB",
                "Value": "CLB"
            }
        ],
        "Data": [
            {
                "AddressIPV6": "27::1",
                "AppId": "1827324",
                "AssetId": "cfwnat-a2b9957b",
                "AssetName": "autoDev",
                "AssetType": "NATFW",
                "ConfigureRisk": 0,
                "CreateTime": "2022-11-28 01:30:55",
                "EngineRegion": "sg",
                "ExposedPort": 0,
                "ExposedVUL": 0,
                "InboundCumulativeFlow": "352.00KB",
                "InboundPeakBandwidth": "1.75Kbps",
                "IsCore": 1,
                "IsNewAsset": 0,
                "LastScanTime": "2024-08-22 21:45:10",
                "NetworkAttack": 0,
                "Nick": "master",
                "OutboundCumulativeFlow": "38.67KB",
                "OutboundPeakBandwidth": "272.00bps",
                "PrivateIp": "172.0.12.3",
                "PublicIp": "1.**.***.59",
                "Region": "ap-shanghai",
                "RiskExposure": 0,
                "ScanTask": 0,
                "Status": "1",
                "Tag": [
                    {
                        "Name": "name1",
                        "Value": "value1"
                    }
                ],
                "Uin": "18146",
                "VpcId": "vpc-omoo5lv",
                "VpcName": "vpc-omoo5lv"
            }
        ],
        "RegionList": [
            {
                "Text": "上海",
                "Value": "ap-shanghai"
            },
            {
                "Text": "北京",
                "Value": "ap-beijing"
            },
            {
                "Text": "广州",
                "Value": "ap-guangzhou"
            }
        ],
        "RequestId": "7cf2ba3d-87ad-4691-a374-fd92ec11d9c8",
        "TotalCount": 6,
        "VpcList": [
            {
                "Text": "fengqqian3",
                "Value": "vpc-m819242"
            },
            {
                "Text": "fengqqian2",
                "Value": "vpc-fw2dus5f"
            },
            {
                "Text": "Default-VPC",
                "Value": "vpc-omoo5lv"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码