获取用户VSM列表

最近更新时间: 2026-09-17 00:07:24

1. 接口描述

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

获取用户VSM列表

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

接口更新时间：2021-11-01 15:47:50。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeVsms
Version	是	否	String	公共参数，本接口取值：2019-11-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	是	否	Int64	偏移示例值： 0
Limit	是	否	Int64	最大数量示例值： 10
SearchWord	否	否	String	查询关键字示例值： hsm-r19rq1b0
TagFilters	否	否	Array of TagFilter	Tag过滤参数示例值：查看
Manufacturer	否	否	String	厂商名称示例值： TASS

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	获取实例的总个数示例值： 10
VsmList	Array of ResourceInfo	资源信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
UnauthorizedOperation	未授权操作。
ResourceNotFound	资源不存在。

5. 示例

示例1 获取用户VSM列表

输入示例

https://kms.api3.fincloud.tencent.cn/?Action=DescribeVsms
&Offset=0&Limit=10&SearchWord=xxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount":1,
        "VsmList": {
            "ResourceId":"xxxx",
            "ResourceName":"xxxxx",
            "Status":1,
            "Vip":"1.2.3.4",
            "VpcId":"xxxxx",
            "SubnetId":"xxxxxx",
            "Model":"SJJ1528",
            "VsmType":17,
            "RegionId":1,
            "RegionName":"region",
            "ZoneName":"zone-1",
            "ZoneId":1,
            "ExpireTime":1234567890,
            "SgList":[{
                    "SgId":"SgIdxxxxx",
                    "SgName":"SgNamexxxxxx"
                 }
            ]
        },
        "RequestId": "6010cd3d-a85a-4e00-b37b-22606d017420"
    }
}