RegionInfo
地域信息
被如下接口引用：DescribeRegions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionId | 是 | 否 | Int64 | 地域ID 示例值： 50000001 |
| RegionCnCode | 是 | 否 | String | 地域编码 示例值： region |
| RegionEnCode | 是 | 否 | String | 地域英文编码 示例值： region |
| Zones | 是 | 否 | Array of ZoneInfo | 地域下的可用区列表 示例值：查看 |
SgUnit
安全组基础信息
被如下接口引用：DescribeUsg、DescribeVsms
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SgId | 是 | 是 | String | 安全组Id 示例值： sg-3qcokmyz |
| SgName | 是 | 是 | String | 安全组名称 示例值： 放通部分端口 |
| SgRemark | 是 | 是 | String | 备注 示例值： 测试用安全组 |
| CreateTime | 是 | 是 | String | 创建时间 示例值： 2022-02-10 14:24:04 |
UsgPolicy
安全组策略
被如下接口引用：DescribeUsgRule、DescribeVsmAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Ip | 是 | 是 | String | cidr格式地址 示例值： "0.0.0.0/0" |
| Id | 是 | 是 | String | 安全组id代表的地址集合 示例值： "sg-id" |
| AddressModule | 是 | 是 | String | 地址组id代表的地址集合 示例值： "addr-id" |
| Proto | 是 | 是 | String | 协议 示例值： "ALL" |
| Port | 是 | 是 | String | 端口 示例值： "ALL" |
| ServiceModule | 是 | 是 | String | 服务组id代表的协议和端口集合 示例值： "svc-id" |
| Desc | 是 | 是 | String | 备注 示例值： "自定义规则" |
| Action | 是 | 是 | String | 匹配后行为:ACCEPT/DROP 示例值： "ACCEPT" |
VsmAlgDescUnit
VSM算法描述信息
被如下接口引用：DescribeVsmProperty
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AlgType | 是 | 否 | String | 算法类型 示例值： 对称算法 |
| AlgDesc | 是 | 否 | String | 算法类型描述 示例值： 此种VSM所支持的对称算法的描述 |
VsmProperty
VSM属性信息
被如下接口引用：DescribeVsmProperty
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VsmTypeID | 是 | 否 | Int64 | VSM类型ID 示例值： 17 |
| AlgDescList | 是 | 否 | Array of VsmAlgDescUnit | 算法描述信息列表 示例值：查看 |
| PropertyList | 是 | 否 | Array of VsmPropertyUnit | 性能参数信息列表 示例值：查看 |
DeviceInfo
设备厂商信息
被如下接口引用：DescribeSupportedHsm
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Manufacturer | 是 | 否 | String | 厂商名称 示例值： TASS |
| HsmTypes | 是 | 否 | Array of HsmInfo | 此厂商旗下的设备信息列表 示例值：查看 |
HsmInfo
支持的加密机类型信息
被如下接口引用：DescribeSupportedHsm
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Model | 是 | 否 | String | 加密机型号 示例值： SJJ1528 |
| VsmTypes | 是 | 否 | Array of VsmInfo | 此类型的加密机所支持的VSM类型列表 示例值：查看 |
ZoneInfo
可用区信息
被如下接口引用：DescribeRegions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ZoneId | 是 | 否 | Int64 | 可用区ID 示例值： 50010001 |
| ZoneEnCode | 是 | 否 | String | 可用区英文编码 示例值： 云福1 |
| ZoneCnCode | 是 | 否 | String | 可用区编码 示例值： yf1 |
ResourceInfo
资源信息
被如下接口引用：DescribeVsms
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ResourceId | 是 | 是 | String | 资源Id 示例值： hsm-aj8fp8a0 |
| ResourceName | 是 | 是 | String | 资源名称 示例值： defaultHsmName |
| Status | 是 | 是 | Int64 | 资源状态 示例值： 1 |
| Vip | 是 | 是 | String | 资源IP 示例值： 1.2.3.4 |
| VpcId | 是 | 是 | String | 资源所属Vpc 示例值： vpc-7vv1q6x9 |
| SubnetId | 是 | 是 | String | 资源所属子网 示例值： subnet-1xaztwla |
| Model | 是 | 是 | String | 资源所属HSM规格 示例值： SJJ1528 |
| VsmType | 是 | 是 | Int64 | 资源类型 示例值： 17 |
| RegionId | 是 | 是 | Int64 | 地域Id 示例值： 1 |
| ZoneId | 是 | 是 | Int64 | 区域Id 示例值： 100001 |
| ExpireTime | 是 | 是 | Int64 | 过期时间 示例值： 0 |
| RegionName | 是 | 是 | String | 地域名 示例值： region |
| ZoneName | 是 | 是 | String | 区域名 示例值： zone-1 |
| SgList | 是 | 是 | Array of SgUnit | 实例的安全组列表 示例值：查看 |
| SubnetName | 是 | 是 | String | 子网名称 示例值： Default-Subnet |
| Expired | 是 | 是 | Bool | 当前实例是否已经过期 示例值： false |
| RemainSeconds | 是 | 是 | Int64 | 为正数表示实例距离过期时间还剩余多少秒，为负数表示已经过期多少秒 示例值： 29123420 |
| VpcName | 是 | 是 | String | Vpc名称 示例值： VPC-CLOUD-GZ |
| Tags | 否 | 否 | Array of TagUnit | Tag信息 示例值：查看 |
| TCEProjectID | 否 | 是 | String | TCE项目id 示例值： 0 |
ExtraFlags
辅助参数
被如下接口引用：DescribeExtraFlags
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ShowWeakAlgorithm | 是 | 是 | Bool | 是否展示弱算法 示例值： true |
UsgRuleDetail
安全组规则详情
被如下接口引用：DescribeUsgRule、DescribeVsmAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InBound | 是 | 是 | Array of UsgPolicy | 入站规则 示例值：查看 |
| OutBound | 是 | 是 | Array of UsgPolicy | 出站规则 示例值：查看 |
| SgId | 是 | 是 | String | 安全组Id 示例值： sg-1234abcd |
| SgName | 是 | 是 | String | 安全组名称 示例值： default-name |
| SgRemark | 是 | 是 | String | 备注 示例值： System created security group |
| CreateTime | 是 | 是 | String | 创建时间 示例值： 2023-06-05 10:59:39 |
| Version | 是 | 是 | Int64 | 版本 示例值： 1 |
VsmInfo
支持的Vsm类型信息
被如下接口引用：DescribeSupportedHsm
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TypeName | 是 | 否 | String | VSM类型名称 示例值： EVSM |
| TypeID | 是 | 否 | Int64 | VSM类型值 示例值： 17 |
TagUnit
Tag键值对
被如下接口引用：CreateResource、DescribeVsmAttributes、DescribeVsms
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | Tag Key 示例值： env |
| TagValue | 否 | 否 | String | Tag Value 示例值： test |
Vpc
VPC对象
被如下接口引用：DescribeVpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcName | 是 | 是 | String | Vpc名称 示例值： test_5 |
| VpcId | 是 | 是 | String | VpcId 示例值： vpc-nc9yvu5p |
| CreatedTime | 是 | 是 | String | 创建时间 示例值： 2024-05-09 19:51:48 |
| IsDefault | 是 | 是 | Bool | 是否为默认VPC 示例值： false |
VsmPropertyUnit
VSM性能参数信息
被如下接口引用：DescribeVsmProperty
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PropertyName | 是 | 否 | String | 性能参数名称 示例值： RSA |
| PropertyValue | 是 | 否 | String | 性能参数描述 示例值： 1K次/分钟 |
Subnet
Subnet对象
被如下接口引用：DescribeSubnet
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 是 | String | VPC实例ID。 示例值： vpc-2at5y1pn |
| SubnetId | 是 | 是 | String | 子网实例ID，例如：subnet-bthucmmy。 示例值： subnet-otu92seu |
| SubnetName | 是 | 是 | String | 子网名称。 示例值： 默认子网 |
| CidrBlock | 是 | 是 | String | 子网的 IPv4 CIDR。 示例值： 172.16.16.0/24 |
| CreatedTime | 是 | 是 | String | 创建时间。 示例值： 2017-04-20 11:30:48 |
| AvailableIpAddressCount | 是 | 是 | Int64 | 可用IP数。 示例值： 2 |
| Ipv6CidrBlock | 是 | 是 | String | 子网的 IPv6 CIDR。 示例值： 3402:4e00:20:1201::/64 |
| TotalIpAddressCount | 是 | 是 | Int64 | 总IP数 示例值： 254 |
| IsDefault | 是 | 是 | Bool | 是否为默认Subnet 示例值： false |
TagFilter
Tag过滤参数
被如下接口引用：DescribeVsms
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 否 | 否 | String | Tag Key 示例值： env |
| TagValue | 否 | 否 | Array of String | Tag Value 示例值： dev |