{
  "name": "cloudhsm",
  "display_name": "云加密机",
  "description": "介绍如何使用API对云加密机进行操作，包括虚拟加密机实例相关操作等。",
  "domain": "other",
  "api_version": "2019-11-12",
  "endpoint": "cloudhsm.tencentcloudapi.com",
  "actions": [
    {
      "name": "DescribeHSMBySubnetId",
      "description": "通过SubnetId获取Hsm资源数",
      "status": "online",
      "parameters": [
        {
          "name": "SubnetId",
          "type": "string",
          "required": true,
          "description": "Subnet标识符",
          "example": "subnet-4vxnrlco"
        }
      ],
      "required": [
        "SubnetId"
      ]
    },
    {
      "name": "DescribeHSMByVpcId",
      "description": "通过VpcId获取Hsm资源数",
      "status": "online",
      "parameters": [
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "VPC标识符",
          "example": "vpc-rhx6fnd7"
        }
      ],
      "required": [
        "VpcId"
      ]
    },
    {
      "name": "DescribeSubnet",
      "description": "查询子网列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回数量。Limit需要在[1, 100]之间。",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。偏移量最小为0。",
          "example": "0"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "查询指定VpcId下的子网信息。",
          "example": "vpc-nc9yvu5p"
        },
        {
          "name": "SearchWord",
          "type": "string",
          "required": false,
          "description": "过滤条件",
          "example": "subnet-4vxnrlco"
        }
      ],
      "required": [
        "Limit",
        "Offset",
        "VpcId"
      ]
    },
    {
      "name": "DescribeSupportedHsm",
      "description": "获取当前地域所支持的设备列表",
      "status": "online",
      "parameters": [
        {
          "name": "HsmType",
          "type": "string",
          "required": false,
          "description": "Hsm类型，可选值all、virtulization、GHSM、EHSM、SHSM",
          "example": "all"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeUsg",
      "description": "根据用户的AppId获取用户安全组列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回量，当Offset和Limit均为0时将一次性返回用户所有的安全组列表。",
          "example": "10"
        },
        {
          "name": "SearchWord",
          "type": "string",
          "required": false,
          "description": "过滤条件，支持安全组id",
          "example": "sg-p9k0swj3"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeUsgRule",
      "description": "获取安全组详情",
      "status": "online",
      "parameters": [
        {
          "name": "SgIds",
          "type": "array",
          "required": true,
          "description": "安全组Id列表",
          "example": "[\"sg-6tjv5yxb\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SgIds"
      ]
    },
    {
      "name": "DescribeVpc",
      "description": "查询用户的私有网络列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "返回偏移量。Offset最小为0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "返回数量。Limit需要在[1, 100]之间。",
          "example": "10"
        },
        {
          "name": "SearchWord",
          "type": "string",
          "required": false,
          "description": "搜索关键字",
          "example": "vpc-nc9yvu5p"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeVsmAttributes",
      "description": "获取VSM属性",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源Id",
          "example": "hsm-r19rq1b0"
        }
      ],
      "required": [
        "ResourceId"
      ]
    },
    {
      "name": "DescribeVsms",
      "description": "获取用户VSM列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "最大数量",
          "example": "10"
        },
        {
          "name": "SearchWord",
          "type": "string",
          "required": false,
          "description": "资源ID或者资源名字模糊查询的关键字",
          "example": "hsm-r19rq1b0"
        },
        {
          "name": "TagFilters",
          "type": "array",
          "required": false,
          "description": "标签过滤条件",
          "example": "[{\"TagKey\":\"env\",\"TagValue\":[\"dev\"]}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "env"
            },
            {
              "name": "TagValue",
              "type": "array",
              "required": false,
              "description": "标签值",
              "example": "dev",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Manufacturer",
          "type": "string",
          "required": false,
          "description": "设备所属的厂商名称，根据厂商来进行筛选",
          "example": "TASS"
        },
        {
          "name": "HsmType",
          "type": "string",
          "required": false,
          "description": "Hsm服务类型，可选virtualization、physical、GHSM、EHSM、SHSM、all",
          "example": "virtualization"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "GetAlarmEvent",
      "description": "获取告警事件",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "GetVsmMonitorInfo",
      "description": "获取VSM监控信息",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源Id",
          "example": "hsm-1234abcd"
        },
        {
          "name": "ResourceName",
          "type": "string",
          "required": false,
          "description": "资源名称",
          "example": "default-hsmName"
        }
      ],
      "required": [
        "ResourceId"
      ]
    },
    {
      "name": "InquiryPriceBuyVsm",
      "description": "购买询价接口",
      "status": "online",
      "parameters": [
        {
          "name": "GoodsNum",
          "type": "integer",
          "required": true,
          "description": "需购买实例的数量",
          "example": "1"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": true,
          "description": "付费模式：0表示按需计费/后付费，1表示预付费",
          "example": "1"
        },
        {
          "name": "TimeSpan",
          "type": "string",
          "required": true,
          "description": "商品的时间大小，整型参数，举例：当TimeSpan为1，TImeUnit为m时，表示询价购买时长为1个月时的价格",
          "example": "1"
        },
        {
          "name": "TimeUnit",
          "type": "string",
          "required": true,
          "description": "商品的时间单位，m表示月，y表示年",
          "example": "m"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "默认为CREATE，可选RENEW",
          "example": "CREATE"
        },
        {
          "name": "HsmType",
          "type": "string",
          "required": true,
          "description": "Hsm服务类型，可选值virtualization、physical、GHSM、EHSM、SHSM",
          "example": "virtualization"
        },
        {
          "name": "Currency",
          "type": "string",
          "required": false,
          "description": "货币类型，默认为CNY",
          "example": "CNY"
        }
      ],
      "required": [
        "GoodsNum",
        "PayMode",
        "TimeSpan",
        "TimeUnit",
        "Type",
        "HsmType"
      ]
    },
    {
      "name": "ModifyAlarmEvent",
      "description": "修改告警事件",
      "status": "online",
      "parameters": [
        {
          "name": "Event",
          "type": "string",
          "required": true,
          "description": "告警事件，支持CPU、MEM、TCP",
          "example": "CPU"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "告警阈值",
          "example": "70"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "告警状态，0表示停用，1表示启动",
          "example": "0"
        },
        {
          "name": "BeginTime",
          "type": "string",
          "required": false,
          "description": "告警开始时间，只有在这个时间后才会发送告警，当跟EndTime同时为空时表示全天告警",
          "example": "00:00:00"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "告警结束时间，只有在这个时间前才会发送告警，当跟BeginTime同时为空时表示全天告警",
          "example": "23:59:59"
        }
      ],
      "required": [
        "Event",
        "Limit",
        "Status"
      ]
    },
    {
      "name": "ModifyVsmAttributes",
      "description": "修改VSM属性",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源Id",
          "example": "hsm-1234abcd"
        },
        {
          "name": "Type",
          "type": "array",
          "required": true,
          "description": "UpdateResourceName-修改资源名称, UpdateSgIds-修改安全组名称, UpdateNetWork-修改网络, Default-默认不修改",
          "example": "[\"Default\"]",
          "item_type": "string"
        },
        {
          "name": "ResourceName",
          "type": "string",
          "required": false,
          "description": "资源名称",
          "example": "default-hsmName"
        },
        {
          "name": "SgIds",
          "type": "array",
          "required": false,
          "description": "安全组Id",
          "example": "[\"sg-abcdefgh\"]",
          "item_type": "string"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "虚拟专网Id",
          "example": "vpc-abcdefgh"
        },
        {
          "name": "SubnetId",
          "type": "string",
          "required": false,
          "description": "子网Id",
          "example": "subnet-1234abcd"
        },
        {
          "name": "AlarmStatus",
          "type": "integer",
          "required": false,
          "description": "告警开关，0表示关闭告警，1表示启用告警",
          "example": "0"
        }
      ],
      "required": [
        "ResourceId",
        "Type"
      ]
    }
  ]
}