云加密机获取用户VSM列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cloudhsm.tencentcloudapi.com 。

获取用户VSM列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVsms。
Version	是	String	公共参数，本接口取值：2019-11-12。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	是	Integer	偏移示例值：0
Limit	是	Integer	最大数量示例值：10
SearchWord	否	String	资源ID或者资源名字模糊查询的关键字示例值：abc
TagFilters.N	否	Array of TagFilter	标签过滤条件
Manufacturer	否	String	设备所属的厂商名称，根据厂商来进行筛选示例值：TASS
HsmType	否	String	Hsm服务类型，可选virtualization、physical、GHSM、EHSM、SHSM、all 示例值：virtualization

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	获取实例的总个数示例值：1
VsmList	Array of ResourceInfo	资源信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用户VSM列表

输入示例

https://cloudhsm.tencentcloudapi.com/?Action=DescribeVsms
&Offset=0
&Limit=10
&SearchWord=xxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "7787c490-8c73-48af-bb5a-5d85cc7d4f35",
        "TotalCount": 1,
        "VsmList": [
            {
                "AlarmStatus": 0,
                "CreateUin": "2942368751",
                "ExpireTime": 1738234083,
                "Expired": false,
                "Manufacturer": "TASS",
                "Model": "SJJ1528",
                "RegionId": 1,
                "RegionName": "广州",
                "RemainSeconds": 29123420,
                "RenewFlag": 2,
                "ResourceId": "hsm-aj8fp8a0",
                "ResourceName": "default-hsmName",
                "SgList": [
                    {
                        "CreateTime": "2023-06-05 10:59:39",
                        "SgId": "sg-f51mj0kl",
                        "SgName": "casb-proxy-2023060510592885829",
                        "SgRemark": "自定义"
                    }
                ],
                "Status": 1,
                "SubnetId": "subnet-1xaztwla",
                "SubnetName": "Default-Subnet3",
                "Tags": [
                    {
                        "TagKey": "运营部门",
                        "TagValue": "测试"
                    }
                ],
                "Vip": "172.16.16.89",
                "VpcId": "vpc-7vv1q6x9",
                "VpcName": "Default-VPC",
                "VsmType": 17,
                "ZoneId": 100003,
                "ZoneName": "广州三区"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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