获取VSM属性

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

1. 接口描述

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

获取VSM属性

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

接口更新时间：2025-07-23 11:44:01。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeVsmAttributes
Version	是	否	String	公共参数，本接口取值：2019-11-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ResourceId	是	否	String	资源Id 示例值： hsm-r19rq1b0

3. 输出参数

参数名称	类型	描述
ResourceId	String	资源Id 示例值： hsm-r19rq1b0
ResourceName	String	资源名称示例值： default-hsmName
Status	Int64	资源状态示例值： 1
Vip	String	资源IP 示例值： 192.168.1.1
VpcId	String	资源所属Vpc 示例值： vpc-nc9yvu5p
SubnetId	String	资源所属子网示例值： subnet-4vxnrlco
Model	String	资源所属HSM的规格示例值： SJJ1528
VsmType	Int64	资源类型示例值： 17
RegionId	Int64	地域Id 示例值： 1
ZoneId	Int64	区域Id 示例值： 100001
ExpireTime	Int64	过期时间示例值： 1612332287
SgList	Array of UsgRuleDetail	安全组详情信息示例值：查看
SubnetName	String	子网名示例值： Default-Subnet
RegionName	String	地域名示例值： region
ZoneName	String	区域名示例值： Zone-3
Expired	Bool	实例是否已经过期示例值： false
RemainSeconds	Int64	为正数表示实例距离过期时间剩余秒数，为负数表示实例已经过期多少秒示例值： 20
VpcName	String	私有虚拟网络名称示例值： VPC-CLOUD-GZ
VpcCidrBlock	String	VPC的IPv4 CIDR 示例值： 192.168.0.0/16
SubnetCidrBlock	String	子网的CIDR 示例值： 192.168.1.0/24
Tags	Array of TagUnit	Tag参数示例值：查看
RenewFlag	Int64	更新flag 示例值： 0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 获取VSM属性

获取VSM属性

输入示例

https://kms.api3.fincloud.tencent.cn/?Action= DescribeVsmAttributes
&ResourceId=xxxxxxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "ResourceId": "xxxxxxxxxxxx",
        "ResourceName": "xxxxxxxxxxxxx",
        "Status": 1,
        "Vip": "1.2.3.4",
        "VpcId": "xxxxxxxxxx",
        "SubnetId": "xxxxxxxxxxxxx",
                "SubnetName":"xxxxx",
                "RegionName":"region",
                "ZoneName":"zone-1",
        "Model": "SJJ1528",
        "VsmType": 17,
        "RegionId": 1,
        "ZoneId": 1,
        "ExpireTime": 1234567890,
                "VpcName": "testVpcName",
                "VpcCidrBlock": "1.2.0.0/16",
                "SubnetCidrBlock": "1.2.3.0/16",
        "SgList": [{
            "Version": 0,
            "UsgId": "UsgIdxxxxx",
            "UsgName": "UsgNamexxxxxx",
            "InBound": {
                "Ip": "xxxxx",
                "Id": "xxxxxxx",
                "AddressModule": "xxxxxx",
                "Proto": "tcp",
                "Port": "80",
                "ServiceModule": "xxxxxx",
                "Desc": "xxxxxx",
                "Action": "DROP"
            }
        }],
        "RequestId": "6010cd3d-a85a-4e00-b37b-22606d017420"
    }
}