获取VSM属性

最近更新时间:2020-03-16 08:23:25

1. 接口描述

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

获取VSM属性

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cloudhsm.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
ResourceId String 资源Id
ResourceName String 资源名称
Status Integer 资源状态
Vip String 资源IP
VpcId String 资源所属Vpc
SubnetId String 资源所属子网
Model String 资源所属HSM的规格
VsmType Integer 资源类型
RegionId Integer 地域Id
ZoneId Integer 区域Id
ExpireTime Integer 过期时间
SgList Array of UsgRuleDetail 安全组详情信息
注意:此字段可能返回 null,表示取不到有效值。
SubnetName String 子网名
注意:此字段可能返回 null,表示取不到有效值。
RegionName String 地域名
注意:此字段可能返回 null,表示取不到有效值。
ZoneName String 区域名
注意:此字段可能返回 null,表示取不到有效值。
Expired Boolean 实例是否已经过期
注意:此字段可能返回 null,表示取不到有效值。
RemainSeconds Integer 为正数表示实例距离过期时间剩余秒数,为负数表示实例已经过期多少秒
注意:此字段可能返回 null,表示取不到有效值。
VpcName String 私有虚拟网络名称
注意:此字段可能返回 null,表示取不到有效值。
VpcCidrBlock String VPC的IPv4 CIDR
注意:此字段可能返回 null,表示取不到有效值。
SubnetCidrBlock String 子网的CIDR
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取VSM属性

获取VSM属性

输入示例

https://kms.tencentcloudapi.com/?Action= DescribeVsmAttributes
&ResourceId=xxxxxxxxxxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "ResourceId": "xxxxxxxxxxxx",
    "ResourceName": "xxxxxxxxxxxxx",
    "Status": 1,
    "Vip": "1.2.3.4",
    "VpcId": "xxxxxxxxxx",
    "SubnetId": "xxxxxxxxxxxxx",
    "SubnetName": "xxxxx",
    "RegionName": "ap-shanghai",
    "ZoneName": "上海四区",
    "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"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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