获取VSM属性

最近更新时间:2024-11-07 01:21:21

我的收藏

1. 接口描述

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

获取VSM属性

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVsmAttributes。
Version String 公共参数,本接口取值:2019-11-12。
Region String 公共参数,详见产品支持的 地域列表
ResourceId String 资源Id
示例值:hsm-r19rq1b0

3. 输出参数

参数名称 类型 描述
ResourceId String 资源Id
示例值:hsm-r19rq1b0
ResourceName String 资源名称
示例值:default-hsmName
Status Integer 资源状态,1表示资源为正常,2表示资源处于隔离状态
示例值:1
Vip String 资源IP
示例值:192.168.1.1
VpcId String 资源所属Vpc
示例值:vpc-nc9yvu5p
SubnetId String 资源所属子网
示例值:subnet-4vxnrlco
Model String 资源所属HSM的规格
示例值:SJJ1528
VsmType Integer 资源类型,17表示EVSM,33表示GVSM,49表示SVSM
示例值:17
RegionId Integer 地域Id,返回腾讯云地域代码,如广州为1,北京为8
示例值:1
ZoneId Integer 区域Id,返回腾讯云每个地域的可用区代码
示例值:100001
ExpireTime Integer 资源过期时间,以时间戳形式展示。
示例值:1612332287
SgList Array of UsgRuleDetail 安全组详情信息,如果未配置字段返回null
示例值:[ { "CreateTime": "2024-02-02 16:53:18", "InBound": [ { "Action": "ACCEPT", "AddressModule": "", "Desc": "Default rule", "Id": "", "Ip": "0.0.0.0/0", "Port": "ALL", "Proto": "ALL", "ServiceModule": "" } ], "OutBound": [ { "Action": "ACCEPT", "AddressModule": "", "Desc": "Default rule", "Id": "", "Ip": "0.0.0.0/0", "Port": "ALL", "Proto": "ALL", "ServiceModule": "" } ], "SgId": "sg-6tjv5yxb", "SgName": "default", "SgRemark": "System created security group", "Version": 0 } ]
SubnetName String 子网名
示例值:Default-Subnet
RegionName String 地域名
示例值:广州
ZoneName String 区域名
示例值:广州三区
Expired Boolean 实例是否已经过期
示例值:false
RemainSeconds Integer 为正数表示实例距离过期时间剩余秒数,为负数表示实例已经过期多少秒
示例值:123
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 Tag 资源所关联的标签Tag
示例值: [ { "TagKey": "运营部门", "TagValue": "测试" } ]
RenewFlag Integer 资源续费标识,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
示例值:1
Manufacturer String 厂商
示例值:TASS
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取VSM属性

获取VSM属性

输入示例

https://cloudhsm.tencentcloudapi.com/?Action=DescribeVsmAttributes
&ResourceId=hsm-aj8fp8a0
&<公共请求参数>

输出示例

{
    "Response": {
        "ExpireTime": 1738234083,
        "Expired": false,
        "Manufacturer": "TASS",
        "Model": "SJJ1528",
        "RegionId": 1,
        "RegionName": "广州",
        "RemainSeconds": 29124028,
        "RenewFlag": 2,
        "RequestId": "98119ebc-93c2-43c6-b0db-be2efdf93ffb",
        "ResourceId": "hsm-aj8fp8a0",
        "ResourceName": "default-hsmName",
        "SgList": [
            {
                "CreateTime": "2023-06-05 10:59:39",
                "InBound": [
                    {
                        "Action": "ACCEPT",
                        "Desc": "一键放通入站规则",
                        "Ip": "0.0.0.0/0",
                        "Port": "20,21,22,3389,80,443",
                        "Proto": "tcp"
                    },
                    {
                        "Action": "ACCEPT",
                        "Desc": "一键放通入站规则",
                        "Ip": "0.0.0.0/0",
                        "Port": "ALL",
                        "Proto": "ALL"
                    },
                    {
                        "Action": "ACCEPT",
                        "Desc": "desc-test ",
                        "Ip": "172.16.0.0/16",
                        "Port": "ALL",
                        "Proto": "ALL"
                    }
                ],
                "OutBound": [
                    {
                        "Action": "ACCEPT",
                        "Desc": "放通所有",
                        "Ip": "0.0.0.0/0",
                        "Port": "ALL",
                        "Proto": "ALL"
                    }
                ],
                "SgId": "sg-f51mj0kl",
                "SgName": "casb-proxy-2023060510592885829",
                "SgRemark": "自定义",
                "Version": 0
            }
        ],
        "Status": 1,
        "SubnetCidrBlock": "172.16.16.0/20",
        "SubnetId": "subnet-1xaztwla",
        "SubnetName": "Default-Subnet3",
        "Tags": [
            {
                "TagKey": "运营部门",
                "TagValue": "测试"
            }
        ],
        "Vip": "172.16.16.89",
        "VpcCidrBlock": "172.16.0.0/16",
        "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。

命令行工具

6. 错误码

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

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