# 批量更新资产 - BatchUpdateResources #### 功能介绍 批量更新资产，根据实际修改的属性更新，未修改的列不更新 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI PUT /v1/{project_id}/workspaces/{workspace_id}/sa/resources 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id，用于指定操作所属的工作空间，资产查询将在该工作空间范围内进行。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 是 | String | **参数解释：** 语言，参考值：zh-cn、en-us **约束限制：** 不涉及 **取值范围：** zh-cn:中文环境 en-us:英文环境 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | batch_ids | 是 | Array of strings | **参数解释：** 批量更新的资产ID列表。 **约束限制：** 不涉及 **取值范围：** 1\~100个元素 **默认取值：** 不涉及 | | data_object | 是 | [ResourceDetail] object | **参数解释：** 资产详情 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4ResourceDetail | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 资产id **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 资产名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | | provider | 是 | String | **参数解释：** 资产来源，云服务名称(云上)，线下机房（IDC） **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 是 | String | **参数解释：** 资产类型, 比如ECS/VPC/EVS/IP/URL等 **取值范围：** 不涉及 **默认取值：** 不涉及 | | checksum | 否 | String | **参数解释：** 资产详情校验码 **取值范围：** 不涉及 **默认取值：** 不涉及 | | created | 否 | String | **参数解释：** 资产创建时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2023-01-01T00:00:00Z **取值范围：** 不涉及 **默认取值：** 不涉及 | | provisioning_state | 否 | String | **参数解释：** 资产操作状态 **取值范围：** 不涉及 **默认取值：** 不涉及 | | environment | 是 | [ResourceEnvironment] object | **参数解释：** 资产所属环境 **取值范围：** 不涉及 **默认取值：** 不涉及 | | department | 否 | [Department] object | **参数解释：** 资产所属部门 **取值范围：** 不涉及 **默认取值：** 不涉及 | | governance_user | 否 | [GovernanceUser] object | **参数解释：** 资产治理责任人 **取值范围：** 不涉及 **默认取值：** 不涉及 | | level | 否 | Integer | **参数解释：** 0: 测试 1: 一般 2: 关键资产 **取值范围：** 不涉及 **默认取值：** 不涉及 | | properties | 是 | [Properties] object | **参数解释：** 资产详细属性。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表5ResourceEnvironment | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | vendor_type | 是 | String | **参数解释：** 环境供应商 **取值范围：** 不涉及 **默认取值：** 不涉及 | | domain_id | 是 | String | **参数解释：** 资产归属的账号ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | region_id | 否 | String | **参数解释：** 资产归属的区域，全局服务默认为global **取值范围：** 不涉及 **默认取值：** 不涉及 | | project_id | 否 | String | **参数解释：** 资产归属的项目ID，全局服务默认为null **取值范围：** 不涉及 **默认取值：** 不涉及 | | ep_id | 否 | String | **参数解释：** 资产归属的企业项目ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | ep_name | 否 | String | **参数解释：** 资产归属的企业项目名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vendor_name | 是 | String | **参数解释：** 包含资产探针或资产提供商 **取值范围：** 不涉及 **默认取值：** 不涉及 | | idc_name | 是 | String | **参数解释：** 线下机房名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | | idc_id | 否 | String | **参数解释：** 线下机房id **取值范围：** 不涉及 **默认取值：** 不涉及 | 表6Department | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 所属部门名称id，若不填写为default **取值范围：** 不涉及 **默认取值：** 不涉及资产 | | name | 否 | String | **参数解释：** 资产所属部门名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表7GovernanceUser | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释：** 资产治理责任人类型 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 资产治理责任人名称，为空则忽略，不存在则创建 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表8Properties | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | hwc_ecs | 否 | [HwcEcs] object | **参数解释：** 云弹性云服务器详情 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hwc_eip | 否 | [HwcEip] object | **参数解释：** 云弹性公网IP **取值范围：** 不涉及 **默认取值：** 不涉及 | | hwc_vpc | 否 | [HwcVpc] object | **参数解释：** 云虚拟私有云 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hwc_subnet | 否 | [HwcSubnet] object | **参数解释：** 云子网 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hwc_rds | 否 | [HwcRds] object | **参数解释：** 云关系型数据库 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hwc_domain | 否 | [HwcDomain] object | **参数解释：** 云域名 **取值范围：** 不涉及 **默认取值：** 不涉及 | | website | 否 | [Website] object | **参数解释：** 网站 **取值范围：** 不涉及 **默认取值：** 不涉及 | | oca_ip | 否 | [OcaIp] object | **参数解释：** 云外资产IP **取值范围：** 不涉及 **默认取值：** 不涉及 | 表9HwcEcs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 弹性云服务器ID，格式为UUID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 弹性云服务器名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | protected_status | 是 | String | **参数解释：** 主机安全开启状态：OPEN \| CLOSE **取值范围：** 不涉及 **默认取值：** 不涉及 | | description | 是 | String | **参数解释：** 弹性云服务器的描述信息。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | status | 是 | String | **参数解释：** 弹性云服务器状态。 **取值范围：** ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED **默认取值：** 不涉及 | | locked | 是 | Boolean | **参数解释：** 弹性云服务器是否为锁定状态。 **取值范围：** true:锁定 false:未锁定 **默认取值：** 不涉及 | | enterprise_project_id | 否 | String | **参数解释：** 弹性云服务器所属的企业项目ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | user_id | 是 | String | **参数解释：** 创建弹性云服务器的用户ID，格式为UUID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | project_id | 是 | String | **参数解释：** 弹性云服务器所属项目id，格式为UUID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | host_id | 是 | String | **参数解释：** 弹性云服务器所在主机的主机ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | host_name | 是 | String | **参数解释：** 弹性云服务器所在主机的主机名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | host_status | 是 | String | **参数解释：** 云服务器所在主机状态。 **取值范围：** UP:服务正常 UNKNOWN:状态未知 DOWN:服务异常 MAINTENANCE:维护状态 空字符串：弹性云服务器无主机信息 **默认取值：** 不涉及 | | addresses | 是 | Array of [HwcEcsAddress] objects | **参数解释：** 弹性云服务器的网络属性。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | security_groups | 是 | Array of [HwcEcsSecurityGroup] objects | **参数解释：** 弹性云服务器所属安全组列表。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | availability_zone | 是 | String | **参数解释：** 弹性云服务器所在可用区名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | flavor | 否 | [HwcEcsFlavor] object | **参数解释：** 弹性云服务器规格信息。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | volumes_attached | 是 | Array of [HwcEcsVolume] objects | **参数解释：** 挂载到弹性云服务器上的磁盘。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | metadata | 是 | [HwcEcsMetadata] object | **参数解释：** 弹性云服务器元数据。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | updated | 是 | String | **参数解释：** 弹性云服务器最近一次更新时间，例如开机、关机、重启等操作。 时间格式例如：2019-05-22T03:30:52Z **取值范围：** 不涉及 **默认取值：** 不涉及 | | created | 是 | String | **参数解释：** 弹性云服务器创建时间。 时间格式例如：2019-05-22T03:19:19Z **取值范围：** 不涉及 **默认取值：** 不涉及 | | key_name | 否 | String | **参数解释：** 弹性云服务器使用的密钥对名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | scheduler_hints | 否 | [HwcEcsSchedulerHint] object | **参数解释：** 弹性云服务器调度信息。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | hypervisor | 否 | [HwcEcsHypervisor] object | **参数解释：** 虚拟化信息。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表10HwcEcsAddress | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | version | 是 | String | **参数解释：** IP地址版本。 **取值范围：** "4":代表IPv4。 "6":代表IPv6。 **默认取值：** 不涉及 | | addr | 是 | String | **参数解释：** IP地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 是 | String | **参数解释：** IP地址类型。 **取值范围：** fixed:代表私有IP地址。 floating:代表浮动IP地址 **默认取值：** 不涉及 | | mac_addr | 是 | String | **参数解释：** MAC地址。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | port_id | 是 | String | **参数解释：** IP地址对应的端口ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vpc_id | 是 | String | **参数解释：** 所属虚拟私有云的ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表11HwcEcsSecurityGroup | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 安全组ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 安全组名称或者UUID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表12HwcEcsFlavor | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 云服务器规格ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 是 | String | **参数解释：** 云服务器规格名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | disk | 否 | String | **参数解释：** 该云服务器规格对应要求系统盘大小，0为不限制。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vcpus | 否 | String | **参数解释：** 该云服务器规格对应的CPU核数。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ram | 否 | String | **参数解释：** 该云服务器规格对应的内存大小，单位为MB。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表13HwcEcsVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 磁盘ID，格式为UUID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | delete_on_termination | 否 | String | **参数解释：** 删除云服务器时是否一并删除该磁盘。 **取值范围：** true:是 false:否 **默认取值：** 不涉及 | | boot_index | 否 | String | **参数解释：** 云硬盘启动顺序。 **取值范围：** 0为系统盘。 非0为数据盘。 **默认取值：** 不涉及 | | device | 否 | String | **参数解释：** 云硬盘挂载盘符，即磁盘挂载点。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表14HwcEcsMetadata | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | image_id | 否 | String | **参数解释：** 云服务器操作系统对应的镜像ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | image_type | 否 | String | **参数解释：** 镜像类型，目前支持： 公共镜像（gold） 私有镜像（private） 共享镜像（shared） **取值范围：** 不涉及 **默认取值：** 不涉及 | | image_name | 否 | String | **参数解释：** 云服务器操作系统对应的镜像名称。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | os_bit | 否 | String | **参数解释：** 操作系统位数，一般取值为"32"或者"64"。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | os_type | 否 | String | **参数解释：** 操作系统类型，取值为：Linux、Windows。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vpc_id | 否 | String | **参数解释：** 云服务器所属的虚拟私有云ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | resource_spec_code | 否 | String | **参数解释：** 云服务器对应的资源规格。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | resource_type | 否 | String | **参数解释：** 云服务器对应的资源类型。 **取值范围：** 取值为"1"，代表资源类型为云服务器。 **默认取值：** 不涉及 | | agency_name | 否 | String | **参数解释：** 委托的名称。 委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务器的临时凭证。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表15HwcEcsSchedulerHint | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group | 否 | Array of strings | **参数解释：** 云服务器组ID，UUID格式。 云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | tenancy | 否 | Array of strings | **参数解释：** 在指定的专属主机或者共享主机上创建弹性云服务器。 参数值为shared或者dedicated。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dedicated_host_id | 否 | Array of strings | **参数解释：** 专属主机的ID。 说明： 专属主机的ID仅在tenancy为dedicated时生效。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表16HwcEcsHypervisor | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | hypervisor_type | 否 | String | **参数解释：** 虚拟化类型。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | csd_hypervisor | 否 | String | **参数解释：** 预留属性。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表17HwcEip | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 弹性公网IP唯一标识 **取值范围：** 不涉及 **默认取值：** 不涉及 | | alias | 是 | String | **参数解释：** 弹性公网IP名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | | protected_status | 是 | String | **参数解释：** DDoS或CFW开启状态：OPEN \| CLOSE **取值范围：** 不涉及 **默认取值：** 不涉及 | | project_id | 是 | String | **参数解释：** 项目ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | enterprise_project_id | 是 | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | ip_version | 是 | Integer | **参数解释：** IP版本信息 **取值范围：** 4:公网IP地址为public_ip_address地址 6:公网IP地址为public_ipv6_address地址 **默认取值：** 不涉及 | | public_ip_address | 否 | String | **参数解释：** 弹性公网IP或者IPv6端口的地址 **取值范围：** 不涉及 **默认取值：** 不涉及 | | public_ipv6_address | 否 | String | **参数解释：** IPv4时无此字段，IPv6时为申请到的弹性公网IP **取值范围：** 不涉及 **默认取值：** 不涉及 | | publicip_pool_name | 否 | String | **参数解释：** 弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户申请的专属池。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | publicip_pool_id | 否 | String | **参数解释：** 公网IP所属网络的ID，publicip_pool_name对应的网络ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | status | 是 | String | **参数解释：** 弹性公网IP的状态 **取值范围：** FREEZED:冻结 BIND_ERROR:绑定失败 BINDING:绑定中 PENDING_DELETE:释放中 PENDING_CREATE:创建中 NOTIFYING:创建中 NOTIFY_DELETE:释放中 PENDING_UPDATE:更新中 DOWN:未绑定 ACTIVE:绑定 ELB:绑定ELB VPN:绑定VPN ERROR:失败 **默认取值：** 不涉及 | | description | 否 | String | **参数解释：** 弹性公网IP描述信息 **取值范围：** 不涉及 **默认取值：** 不涉及 | | tags | 否 | Array of strings | **参数解释：** 功能说明：用户标签。（默认不显示） **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 否 | String | **参数解释：** 弹性公网IP类型 **取值范围：** 枚举值： EIP DUALSTACK DUALSTACK_SUBNET **默认取值：** 不涉及 | | vnic | 否 | [HwcEipVnic] object | **参数解释：** 公网IP绑定实例有PORT时，PORT的相关信息 **取值范围：** 不涉及 **默认取值：** 不涉及 | | bandwidth | 否 | [HwcEipBandwidth] object | **参数解释：** 公网IP绑定带宽信息 **取值范围：** 不涉及 **默认取值：** 不涉及 | | lock_status | 否 | String | **参数解释：** 记录公网IP当前的冻结状态 约束：metadata类型，标识欠费冻结、公安冻结 **取值范围：** police locked **默认取值：** 不涉及 | | associate_instance_type | 否 | String | **参数解释：** 公网IP绑定的实例类型 **取值范围：** PORT NATGW ELB ELBV1 VPN null **默认取值：** 不涉及 | | associate_instance_id | 否 | String | **参数解释：** 公网IP绑定的实例ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | allow_share_bandwidth_types | 否 | Array of strings | **参数解释：** 表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该 publicip不能加入任何共享带宽 约束：publicip只能加入到有该带宽类型的共享带宽中 **取值范围：** 不涉及 **默认取值：** 不涉及 | | created_at | 否 | String | **参数解释：** 资产创建UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ **取值范围：** 不涉及 **默认取值：** 不涉及 | | updated_at | 否 | String | **参数解释：** 资产更新UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ **取值范围：** 不涉及 **默认取值：** 不涉及 | | public_border_group | 否 | String | **参数解释：** 表示中心站点资产或者边缘站点资产 约束：publicip只能绑定该字段相同的资产 **取值范围：** center、边缘站点名称 **默认取值：** 不涉及 | 表18HwcEipVnic | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | private_ip_address | 否 | String | **参数解释：** 私网IP地址 **取值范围：** 不涉及 **默认取值：** 不涉及 | | device_id | 否 | String | **参数解释：** 端口所属设备ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | device_owner | 否 | String | **参数解释：** 设备所属 **取值范围：** 合法设备所属 network:dhcp network:VIP_PORT network:router_interface_distributed network:router_centralized_snat 约束：不支持设置和更新,由系统自动维护 **默认取值：** 不涉及 | | vpc_id | 否 | String | **参数解释：** 虚拟私有云ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | port_id | 否 | String | **参数解释：** 端口ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | port_profile | 否 | String | **参数解释：** 端口profile信息 **取值范围：** 不涉及 **默认取值：** 不涉及 | | mac | 否 | String | **参数解释：** 端口MAC地址 **取值范围：** 不涉及 **默认取值：** 不涉及 | | vtep | 否 | String | **参数解释：** VTEP IP **取值范围：** 不涉及 **默认取值：** 不涉及 | | vni | 否 | String | **参数解释：** VXLAN ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | instance_id | 否 | String | **参数解释：** 端口所属实例ID,例如RDS实例ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | instance_type | 否 | String | **参数解释：** 端口所属实例类型,例如"RDS" **取值范围：** 不涉及 **默认取值：** 不涉及 | 表19HwcEipBandwidth | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 带宽ID **取值范围：** 不涉及 **默认取值：** 不涉及 | | size | 否 | Integer | **参数解释：** 带宽大小 **取值范围：** 默认5Mbit/s\~2000Mbit/s **默认取值：** 不涉及 | | share_type | 否 | String | **参数解释：** 带宽类型，标识是否是共享带宽 **取值范围：** PER:独享带宽 WHOLE:共享带宽 约束：其中IPv6暂不支持WHOLE类型带宽。 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 带宽名称 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表20HwcVpc | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** VPC对应的唯一标识。 **取值范围：** 长度为32\~36个字符。 | | name | 是 | String | **参数解释：** VPC对应的名称。 **取值范围：** 长度为0\~128个字符。 | | description | 否 | String | **参数解释：** VPC的描述信息。 **取值范围：** 长度为0\~255个字符。 | | protected_status | 是 | String | **参数解释：** CFW开启或安全组规则配置状态。 **取值范围：** - OPEN:已开启 - CLOSE:已关闭 | | cidr | 否 | String | **参数解释：** VPC下可用子网的范围，必须是ipv4 cidr格式，例如192.168.0.0/16。 **取值范围：** - 10.0.0.0/8\~10.255.255.240/28 - 172.16.0.0/12\~172.31.255.240/28 - 192.168.0.0/16\~192.168.255.240/28 | | extend_cidrs | 否 | Array of strings | **参数解释：** VPC的扩展网段，String类型的数组。 **取值范围：** 不涉及 | | status | 是 | String | **参数解释：** VPC对应的状态。 **取值范围：** - PENDING:创建中 - ACTIVE:创建成功 | | project_id | 是 | String | **参数解释：** VPC所属的项目ID。 **取值范围：** 长度为32\~36个字符。 | | enterprise_project_id | 否 | String | **参数解释：** VPC所属的企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | created_at | 是 | String | **参数解释：** VPC创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | 是 | String | **参数解释：** VPC更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | cloud_resources | 否 | Array of [HwcVpcCloudResource] objects | **参数解释：** VPC关联资产类型和数量，HwcVpcCloudResource对象类型的数组。目前只返回VPC关联的routetable和virsubnet，virsubnet数量为ipv4和ipv6子网总数。 **取值范围：** 不涉及 | | tags | 否 | Array of [Tag] objects | **参数解释：** VPC的标签信息，Tag对象类型的数组。详情参见Tag对象。 **取值范围：** 不涉及 | 表21HwcVpcCloudResource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource_type | 否 | String | **参数解释：** 资产类型。 **取值范围：** 长度为0\~32个字符。 | | resource_count | 否 | Integer | **参数解释：** 资产数量。 **取值范围：** 0\~65535 | 表22HwcSubnet | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 子网对应的唯一标识。 **取值范围：** 长度为32\~36个字符。 | | name | 是 | String | **参数解释：** 子网名称。 **取值范围：** 长度为0\~64个字符。 | | description | 否 | String | **参数解释：** 子网的描述信息。 **取值范围：** 长度为0\~255个字符。 | | project_id | 是 | String | **参数解释：** 子网所属的项目ID。 **取值范围：** 长度为32\~36个字符。 | | created_at | 是 | String | **参数解释：** 子网创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | 是 | String | **参数解释：** 子网更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | enterprise_project_id | 否 | String | **参数解释：** 子网所属的企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | security_group_rules | 否 | Array of [HwcSubnetSecurityGroupRule] objects | **参数解释：** 安全组规则，HwcSubnetSecurityGroupRule对象类型的数组。 **取值范围：** 不涉及 | 表23HwcSubnetSecurityGroupRule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 安全组规则对应的唯一标识。 **取值范围：** 带"-"的标准UUID格式。 | | description | 否 | String | **参数解释：** 安全组规则的描述信息。 **取值范围：** 长度为0\~255个字符。 | | security_group_id | 是 | String | **参数解释：** 安全组规则所属的安全组ID。 **取值范围：** 长度为0\~36个字符。 | | direction | 是 | String | **参数解释：** 安全组规则的出入控制方向。 **取值范围：** - ingress:入方向 - egress:出方向 | | protocol | 是 | String | **参数解释：** 协议类型。为空表示支持所有协议。协议为icmpv6时，网络类型应该为IPv6；协议为icmp时，网络类型应该为IPv4。 **取值范围：** icmp、tcp、udp、icmpv6或IP协议号。 | | ethertype | 是 | String | **参数解释：** IP地址协议类型。不填默认值为IPv4。 **取值范围：** - IPv4 - IPv6 | | multiport | 是 | String | **参数解释：** 端口取值范围。 **取值范围：** 支持单端口(80)、连续端口(1-30)以及不连续端口(22,3389,80)。 | | action | 是 | String | **参数解释：** 安全组规则生效策略。默认值为deny。 **取值范围：** - allow:允许 - deny:拒绝 | | priority | 是 | Integer | **参数解释：** 优先级，1代表最高优先级。 **取值范围：** 1\~100 | | remote_group_id | 否 | String | **参数解释：** 远端安全组ID，表示该安全组内的流量允许或拒绝。与remote_ip_prefix、remote_address_group_id功能互斥。 **取值范围：** 租户下存在的安全组ID。 | | remote_ip_prefix | 否 | String | **参数解释：** 远端IP地址。当direction是egress时，为虚拟机访问端的地址；当direction是ingress时，为访问虚拟机的地址。与remote_group_id、remote_address_group_id互斥。 **取值范围：** IP地址，或者cidr格式。 | | remote_address_group_id | 否 | String | **参数解释：** 远端地址组ID。与remote_ip_prefix、remote_group_id功能互斥。 **取值范围：** 租户下存在的地址组ID。 | | created_at | 是 | String | **参数解释：** 安全组规则创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | 是 | String | **参数解释：** 安全组规则更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | project_id | 是 | String | **参数解释：** 安全组规则所属项目ID。 **取值范围：** 长度为32\~36个字符。 | 表24HwcRds | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 实例ID。 **取值范围：** 不涉及 | | name | 是 | String | **参数解释：** 创建的实例名称。 **取值范围：** 不涉及 | | protected_status | 是 | String | **参数解释：** DBSS开启状态：OPEN \| CLOSE **取值范围：** 不涉及 | | status | 是 | String | **参数解释：** 实例状态。 **取值范围：** 值为"BUILD"，表示实例正在创建。 值为"ACTIVE"，表示实例正常。 值为"FAILED"，表示实例异常。 值为"FROZEN"，表示实例冻结。 值为"MODIFYING"，表示实例正在扩容。 值为"REBOOTING"，表示实例正在重启。 值为"RESTORING"，表示实例正在恢复。 值为"MODIFYING INSTANCE TYPE"，表示实例正在转主备。 值为"SWITCHOVER"，表示实例正在主备切换。 值为"MIGRATING"，表示实例正在迁移。 值为"BACKING UP"，表示实例正在进行备份。 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。 值为"STORAGE FULL"，表示实例磁盘空间满。 | | alias | 否 | String | **参数解释：** 实例的备注信息。 **取值范围：** 不涉及 | | private_ips | 否 | Array of strings | **参数解释：** 实例内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。 **取值范围：** 不涉及 | | private_dns_names | 否 | Array of strings | **参数解释：** 实例内网域名列表。实例创建成功后，需要手动申请内网域名，否则查询内网域名为空。 **取值范围：** 不涉及 | | public_ips | 否 | Array of strings | **参数解释：** 实例外网IP地址列表。 **取值范围：** 不涉及 | | port | 是 | Integer | **参数解释：** 数据库端口号。 RDS for MySQL数据库端口设置范围为1024～65535（其中12017和33071被RDS系统占用不可设置）。 RDS for PostgreSQL数据库端口修改范围为2100～9500。 RDS for SQL Server实例的端口设置范围为1433和2100\~9500（其中5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版，5050、5353和5986不可设置）。 当不传该参数时，默认端口如下： RDS for MySQL默认3306。 RDS for PostgreSQL默认5432。 RDS for SQL Server默认1433。 **取值范围：** 不涉及 | | enable_ssl | 是 | Boolean | **参数解释：** 实例开启SSL标志。 **取值范围：** 取值为"true":表示实例已开启SSL。 取值为"false":表示实例未开启SSL。 | | type | 是 | String | **参数解释：** 实例类型，取值为"Single"，"Ha"或"Replica", "Enterprise"，分别对应于单机实例、主备实例、只读实例、分布式实例（企业版）。 **取值范围：** 不涉及 | | ha | 是 | [HwcRdsHa] object | **参数解释：** HA信息，获取HA实例时返回。 **取值范围：** 不涉及 | | region | 是 | String | **参数解释：** 实例所在区域。 **取值范围：** 不涉及 | | datastore | 是 | [HwcRdsDatastore] object | **参数解释：** 数据库信息。 **取值范围：** 不涉及 | | created | 是 | String | **参数解释：** 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 **取值范围：** 不涉及\|- | | updated | 否 | String | **参数解释：** 更新时间，格式与"created"字段对应格式完全相同。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 **取值范围：** 不涉及 | | db_user_name | 否 | String | **参数解释：** 默认用户名。 **取值范围：** 不涉及 | | vpc_id | 是 | String | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及 | | subnet_id | 是 | String | **参数解释：** 子网的网络ID信息。 **取值范围：** 不涉及 | | security_group_id | 是 | String | **参数解释：** 安全组ID。 **取值范围：** 不涉及 | | flavor_ref | 是 | String | **参数解释：** 规格码。 **取值范围：** 不涉及 | | cpu | 是 | String | **参数解释：** CPU核数，单位为核（U）。例如，1表示1个vCPU。 **取值范围：** 不涉及 | | mem | 是 | String | **参数解释：** 内存大小（单位：GB）。 **取值范围：** 不涉及 | | volume | 是 | [HwcRdsVolume] object | **参数解释：** Volume信息。 **取值范围：** 不涉及 | | tags | 否 | Array of [Tag] objects | **参数解释：** 标签列表，没有标签默认为空数组。 **取值范围：** 不涉及 | | enterprise_project_id | 否 | String | **参数解释：** 企业项目标签ID。 **取值范围：** 不涉及 | | project_id | 是 | String | **参数解释：** 项目ID **取值范围：** 不涉及 | | switch_strategy | 是 | String | **参数解释：** 数据库切换策略。取值为"reliability"或"availability"，分别对应于可靠性优先和可用性优先。 **取值范围：** 不涉及 | | read_only_by_user | 是 | Boolean | **参数解释：** 用户设置的实例只读状态。仅支持RDS for MySQL引擎。 **取值范围：** true，表示该实例被设置为只读状态。 false，表示该实例未被设置为只读状态。 | | backup_strategy | 是 | [HwcRdsBackupStrategy] object | **参数解释：** 备份策略。 **取值范围：** 不涉及 | | maintenance_window | 是 | String | **参数解释：** 可维护时间窗，为UTC时间。 **取值范围：** 不涉及 | | nodes | 是 | Array of [HwcRdsNode] objects | **参数解释：** 主备实例信息 **取值范围：** 不涉及 | | related_instance | 是 | Array of [HwcRdsRelatedInstance] objects | **参数解释：** 所关联的数据库实例列表。 **取值范围：** 不涉及 | | disk_encryption_id | 否 | String | **参数解释：** 磁盘加密密钥ID。 **取值范围：** 不涉及 | | time_zone | 是 | String | **参数解释：** 时区。 **取值范围：** 不涉及 | | backup_used_space | 否 | Double | **参数解释：** 备份空间使用量，单位GB。 该字段仅用于查询指定RDS for SQL Server单个实例信息时返回。 **取值范围：** 不涉及 | | storage_used_space | 是 | Double | **参数解释：** 磁盘空间使用量，单位GB。 该字段仅用于查询指定RDS for SQL Server单个实例信息时返回。 **取值范围：** 不涉及 | | associated_with_ddm | 是 | Boolean | **参数解释：** 是否已被DDM实例关联。 true: 已被DDM实例关联 false: 未被DDM实例关联 **取值范围：** - true - false | | max_iops | 是 | Long | **参数解释：** 实例磁盘的最大IOPS值。 当前该字段仅对于SQL Server引擎实例返回。 **取值范围：** 不涉及 | | expiration_time | 是 | String | **参数解释：** 实例的到期时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 该字段仅当实例具有明确的到期时间时返回。 **取值范围：** 不涉及 | 表25HwcRdsHa | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | replication_mode | 是 | String | **参数解释：** 备机同步参数。 **取值范围：** 取值：非空。 RDS for MySQL为"async"或"semisync"。 RDS for PostgreSQL为"async"或"sync"。 RDS for Microsoft SQL Server为"sync"。 说明： "async"为异步模式。 "semisync"为半同步模式。 "sync"为同步模式。 | 表26HwcRdsDatastore | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 数据库引擎，不区分大小写： **取值范围：** MySQL PostgreSQL SQLServer | | version | 是 | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及 | | complete_version | 否 | String | **参数解释：** 数据库完整版本号。仅在数据库引擎是"PostgreSQL"时返回。 **取值范围：** 不涉及 | 表27HwcRdsVolume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 磁盘类型。 **取值范围：** 不涉及 | | size | 是 | Integer | **参数解释：** 磁盘大小，单位为GB。 **取值范围：** 不涉及 | 表28Tag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释：** 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | values | 是 | Array of strings | **参数解释：** 值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。 value可为空数组但不可缺省。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表29HwcRdsBackupStrategy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 否 | String | **参数解释：** 备份时间段。自动备份将在该时间段内触发。 当前时间指UTC时间。 **取值范围：** 不涉及 | | keep_days | 否 | Integer | **参数解释：** 已生成的备份文件可以保存的天数。 **取值范围：** 取值范围：0～732。为0时，表示未设置自动备份策略或备份策略已关闭。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。 | 表30HwcRdsNode | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 节点ID。 **取值范围：** 不涉及 | | name | 是 | String | **参数解释：** 节点名称。 **取值范围：** 不涉及 | | role | 是 | String | **参数解释：** 节点类型，取值为"master"、"slave"或"readreplica"，分别对应于主节点、备节点和只读节点。 **取值范围：** 不涉及 | | status | 是 | String | **参数解释：** 节点状态。 **取值范围：** 不涉及 | | availability_zone | 是 | String | **参数解释：** 可用区。 **取值范围：** 不涉及 | 表31HwcRdsRelatedInstance | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 关联实例id。 **取值范围：** 不涉及 | | type | 是 | String | **参数解释：** 关联实例类型。 "replica_of"对应于"主实例"。 "replica"对应于"只读实例"。 **取值范围：** 不涉及 | 表32HwcDomain | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_name | 是 | String | **参数解释：** 域名名称 **取值范围：** 不涉及 | | expire_date | 是 | String | **参数解释：** 域名到期时间，eg:2023-01-10 **取值范围：** 不涉及 | | status | 是 | String | **参数解释：** 域名服务状态 **取值范围：** 不涉及 | | audit_status | 是 | String | **参数解释：** 域名实名认证状态。 **取值范围：** NONAUDIT:未实名认证 SUCCEED:已实名认证 FAILED:实名认证失败 AUDITING:实名认证审核中 | | audit_unpass_reason | 是 | String | **参数解释：** 域名实名认证失败原因 **取值范围：** 不涉及 | | transfer_status | 否 | String | **参数解释：** 过户状态 **取值范围：** 不涉及 | | reg_type | 是 | String | **参数解释：** 注册类型 **取值范围：** PERSONAL:个人 COMPANY:企业 | | privacy_protection | 是 | String | **参数解释：** 是否开启隐私保护 **取值范围：** 不涉及 | | name_server | 是 | Array of strings | **参数解释：** 域名服务器列表 **取值范围：** 不涉及 | | credential_type | 是 | String | **参数解释：** 证件类型 **取值范围：** 不涉及 | | credential_id | 是 | String | **参数解释：** 证件号码 **取值范围：** 不涉及 | | registrar | 是 | String | **参数解释：** 域名所属注册商 **取值范围：** 不涉及 | | contact | 是 | Array of [HwcDomainContact] objects | **参数解释：** 联系人信息 **取值范围：** 不涉及 | 表33HwcDomainContact | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | email | 是 | String | **参数解释：** 邮箱地址 **取值范围：** 不涉及 | | register | 是 | String | **参数解释：** 域名所有者 **取值范围：** 不涉及 | | contact_name | 是 | String | **参数解释：** 联系人 **取值范围：** 不涉及 | | phone_num | 是 | String | **参数解释：** 联系电话 **取值范围：** 不涉及 | | province | 是 | String | **参数解释：** 省份 **取值范围：** 不涉及 | | city | 是 | String | **参数解释：** 城市 **取值范围：** 不涉及 | | address | 是 | String | **参数解释：** 通讯地址 **取值范围：** 不涉及 | | zip_code | 是 | String | **参数解释：** 邮编 **取值范围：** 不涉及 | 表34Website | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | value | 是 | String | **参数解释：** 网站URL。 **取值范围：** 长度为0\~256个字符。 | | main_domain | 是 | String | **参数解释：** 主域名。 **取值范围：** 长度为0\~256个字符。 | | protected_status | 是 | String | **参数解释：** WAF开启状态。 **取值范围：** - OPEN:WAF已开启 - CLOSE:WAF已关闭 | | is_public | 是 | Boolean | **参数解释：** 是否为外网地址。 **取值范围：** - true:外网 - false:内网 | | remark | 否 | String | **参数解释：** 网站备注。 **取值范围：** 长度为0\~512个字符。 | | name_server | 是 | Array of strings | **参数解释：** 网站服务器列表。 **取值范围：** 0\~512个元素 | | extend_properties | 否 | [WebsiteExtendProperties] object | **参数解释：** 其他扩展属性。 **取值范围：** 不涉及 | 表35WebsiteExtendProperties | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mac_addr | 否 | String | **参数解释：** mac地址 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表36OcaIp | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | value | 是 | String | **参数解释：** IP地址值。 **取值范围：** 长度为0\~64个字符。 | | version | 是 | String | **参数解释：** IP地址版本。 **取值范围：** - ipv4:IPv4地址 - ipv6:IPv6地址 | | network | 是 | [OcaIpNetwork] object | **参数解释：** 网络信息。 **取值范围：** 不涉及 | | remark | 否 | String | **参数解释：** 资产备注。 **取值范围：** 长度为0\~512个字符。 | | name | 否 | String | **参数解释：** 资产名称，默认为资产值。 **取值范围：** 长度为0\~128个字符。 | | relative_value | 否 | String | **参数解释：** 相对值，如资产为IPv4，则为对应的IPv6地址。 **取值范围：** 长度为0\~128个字符。 | | server_room | 是 | String | **参数解释：** 机房名称。 **取值范围：** 长度为0\~128个字符。 | | server_rack | 是 | String | **参数解释：** 机柜名称。 **取值范围：** 长度为0\~128个字符。 | | data_center | 是 | [OcaIpDataCenter] object | **参数解释：** 数据中心信息。 **取值范围：** 不涉及 | | mac_addr | 否 | String | **参数解释：** MAC地址。 **取值范围：** 长度为0\~128个字符。 | | important | 否 | String | **参数解释：** 重要等级。 **取值范围：** - 0:不重要 - 1:重要 | | extend_properties | 否 | [OcaIpExtendProperties] object | **参数解释：** 其他三方扩展属性。 **取值范围：** 不涉及 | 表37OcaIpNetwork | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | is_public | 是 | Boolean | **参数解释：** 是否为外网地址。 **取值范围：** - true:外网 - false:内网 | | partition | 否 | String | **参数解释：** 网络分区。OM：运维管理区 PSZ：生产区 DMZ：隔离区 **取值范围：** - OM - PSZ - DMZ | | plane | 否 | String | **参数解释：** 网络平面（线下有自己的代号）。 **取值范围：** 长度为0\~128个字符。 | | vxlan_id | 否 | String | **参数解释：** 虚拟网络ID。 **取值范围：** 长度为32\~36个字符。 | 表38OcaIpDataCenter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | latitude | 否 | Float | **参数解释：** 纬度。 **取值范围：** 0\~100（不含0和100） | | longitude | 否 | Float | **参数解释：** 经度。 **取值范围：** 0\~100（不含0和100） | | city_code | 是 | String | **参数解释：** 城市编码。 **取值范围：** 长度为0\~128个字符。 | | country_code | 是 | String | **参数解释：** 国家编码。 **取值范围：** 长度为0\~128个字符。 | 表39OcaIpExtendProperties | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | device | 否 | [OcaIpDevice] object | **参数解释：** 设备信息。 **取值范围：** 不涉及 | | system | 否 | [OcaIpSystem] object | **参数解释：** 系统信息。 **取值范围：** 不涉及 | | services | 否 | Array of [OcaIpService] objects | **参数解释：** 应用信息列表。 **取值范围：** 0\~128个元素 | 表40OcaIpDevice | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释：** 设备类型。 **取值范围：** 长度为0\~128个字符。 | | model | 否 | String | **参数解释：** 设备型号。 **取值范围：** 长度为0\~128个字符。 | | vendor | 否 | [OcaIpVendor] object | **参数解释：** 设备供应商信息。 **取值范围：** 不涉及 | 表41OcaIpSystem | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | family | 否 | String | **参数解释：** 系统类型。 **取值范围：** 长度为0\~128个字符。 | | name | 否 | String | **参数解释：** 系统名称。 **取值范围：** 长度为0\~128个字符。 | | version | 否 | String | **参数解释：** 系统版本。 **取值范围：** 长度为0\~128个字符。 | | vendor | 否 | [OcaIpVendor] object | **参数解释：** 系统供应商信息。 **取值范围：** 不涉及 | 表42OcaIpService | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | port | 否 | Integer | **参数解释：** 应用对应端口。 **取值范围：** 0\~65535 | | protocol | 否 | String | **参数解释：** 应用协议。 **取值范围：** 长度为0\~128个字符。 | | name | 否 | String | **参数解释：** 应用名称。 **取值范围：** 长度为0\~256个字符。 | | version | 否 | String | **参数解释：** 应用版本。 **取值范围：** 长度为0\~128个字符。 | | vendor | 否 | [OcaIpVendor] object | **参数解释：** 应用供应商信息。 **取值范围：** 不涉及 | 表43OcaIpVendor | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 供应商名称。 **取值范围：** 长度为0\~128个字符。 | | is_xc | 否 | Boolean | **参数解释：** 供应商是否为国产。 **取值范围：** - true:国产供应商 - false:非国产供应商 | #### 响应参数 **状态码：200** 表44响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | 错误码 | | message | String | 错误信息 | | data | [ChangeResourceRequestBody] object | 资产详情 | 表45ChangeResourceRequestBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_object | [ResourceDetail] object | **参数解释：** 资产详情 **取值范围：** 不涉及 | 表46ResourceDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 资产id **取值范围：** 不涉及 | | name | String | **参数解释：** 资产名称 **取值范围：** 不涉及 | | provider | String | **参数解释：** 资产来源，云服务名称(云上)，线下机房（IDC） **取值范围：** 不涉及 | | type | String | **参数解释：** 资产类型, 比如ECS/VPC/EVS/IP/URL等 **取值范围：** 不涉及 | | checksum | String | **参数解释：** 资产详情校验码 **取值范围：** 不涉及 | | created | String | **参数解释：** 资产创建时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2023-01-01T00:00:00Z **取值范围：** 不涉及 | | provisioning_state | String | **参数解释：** 资产操作状态 **取值范围：** 不涉及 | | environment | [ResourceEnvironment] object | **参数解释：** 资产所属环境 **取值范围：** 不涉及 | | department | [Department] object | **参数解释：** 资产所属部门 **取值范围：** 不涉及 | | governance_user | [GovernanceUser] object | **参数解释：** 资产治理责任人 **取值范围：** 不涉及 | | level | Integer | **参数解释：** 0: 测试 1: 一般 2: 关键资产 **取值范围：** 不涉及 | | properties | [Properties] object | **参数解释：** 资产详细属性。 **取值范围：** 不涉及 | 表47ResourceEnvironment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vendor_type | String | **参数解释：** 环境供应商 **取值范围：** 不涉及 | | domain_id | String | **参数解释：** 资产归属的账号ID **取值范围：** 不涉及 | | region_id | String | **参数解释：** 资产归属的区域，全局服务默认为global **取值范围：** 不涉及 | | project_id | String | **参数解释：** 资产归属的项目ID，全局服务默认为null **取值范围：** 不涉及 | | ep_id | String | **参数解释：** 资产归属的企业项目ID **取值范围：** 不涉及 | | ep_name | String | **参数解释：** 资产归属的企业项目名称 **取值范围：** 不涉及 | | vendor_name | String | **参数解释：** 包含资产探针或资产提供商 **取值范围：** 不涉及 | | idc_name | String | **参数解释：** 线下机房名称 **取值范围：** 不涉及 | | idc_id | String | **参数解释：** 线下机房id **取值范围：** 不涉及 | 表48Department | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 所属部门名称id，若不填写为default **取值范围：** 不涉及 | | name | String | **参数解释：** 资产所属部门名称 **取值范围：** 不涉及 | 表49GovernanceUser | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 资产治理责任人类型 **取值范围：** 不涉及 | | name | String | **参数解释：** 资产治理责任人名称，为空则忽略，不存在则创建 **取值范围：** 不涉及 | 表50Properties | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hwc_ecs | [HwcEcs] object | **参数解释：** 云弹性云服务器详情 **取值范围：** 不涉及 | | hwc_eip | [HwcEip] object | **参数解释：** 云弹性公网IP **取值范围：** 不涉及 | | hwc_vpc | [HwcVpc] object | **参数解释：** 云虚拟私有云 **取值范围：** 不涉及 | | hwc_subnet | [HwcSubnet] object | **参数解释：** 云子网 **取值范围：** 不涉及 | | hwc_rds | [HwcRds] object | **参数解释：** 云关系型数据库 **取值范围：** 不涉及 | | hwc_domain | [HwcDomain] object | **参数解释：** 云域名 **取值范围：** 不涉及 | | website | [Website] object | **参数解释：** 网站 **取值范围：** 不涉及 | | oca_ip | [OcaIp] object | **参数解释：** 云外资产IP **取值范围：** 不涉及 | 表51HwcEcs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 弹性云服务器ID，格式为UUID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 弹性云服务器名称。 **取值范围：** 不涉及 | | protected_status | String | **参数解释：** 主机安全开启状态：OPEN \| CLOSE **取值范围：** 不涉及 | | description | String | **参数解释：** 弹性云服务器的描述信息。 **取值范围：** 不涉及 | | status | String | **参数解释：** 弹性云服务器状态。 **取值范围：** ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED | | locked | Boolean | **参数解释：** 弹性云服务器是否为锁定状态。 **取值范围：** true:锁定 false:未锁定 | | enterprise_project_id | String | **参数解释：** 弹性云服务器所属的企业项目ID。 **取值范围：** 不涉及 | | user_id | String | **参数解释：** 创建弹性云服务器的用户ID，格式为UUID。 **取值范围：** 不涉及 | | project_id | String | **参数解释：** 弹性云服务器所属项目id，格式为UUID。 **取值范围：** 不涉及 | | host_id | String | **参数解释：** 弹性云服务器所在主机的主机ID。 **取值范围：** 不涉及 | | host_name | String | **参数解释：** 弹性云服务器所在主机的主机名称。 **取值范围：** 不涉及 | | host_status | String | **参数解释：** 云服务器所在主机状态。 **取值范围：** UP:服务正常 UNKNOWN:状态未知 DOWN:服务异常 MAINTENANCE:维护状态 空字符串：弹性云服务器无主机信息 | | addresses | Array of [HwcEcsAddress] objects | **参数解释：** 弹性云服务器的网络属性。 **取值范围：** 不涉及 | | security_groups | Array of [HwcEcsSecurityGroup] objects | **参数解释：** 弹性云服务器所属安全组列表。 **取值范围：** 不涉及 | | availability_zone | String | **参数解释：** 弹性云服务器所在可用区名称。 **取值范围：** 不涉及 | | flavor | [HwcEcsFlavor] object | **参数解释：** 弹性云服务器规格信息。 **取值范围：** 不涉及 | | volumes_attached | Array of [HwcEcsVolume] objects | **参数解释：** 挂载到弹性云服务器上的磁盘。 **取值范围：** 不涉及 | | metadata | [HwcEcsMetadata] object | **参数解释：** 弹性云服务器元数据。 **取值范围：** 不涉及 | | updated | String | **参数解释：** 弹性云服务器最近一次更新时间，例如开机、关机、重启等操作。 时间格式例如：2019-05-22T03:30:52Z **取值范围：** 不涉及 | | created | String | **参数解释：** 弹性云服务器创建时间。 时间格式例如：2019-05-22T03:19:19Z **取值范围：** 不涉及 | | key_name | String | **参数解释：** 弹性云服务器使用的密钥对名称。 **取值范围：** 不涉及 | | scheduler_hints | [HwcEcsSchedulerHint] object | **参数解释：** 弹性云服务器调度信息。 **取值范围：** 不涉及 | | hypervisor | [HwcEcsHypervisor] object | **参数解释：** 虚拟化信息。 **取值范围：** 不涉及 | 表52HwcEcsAddress | 参数 | 参数类型 | 描述 | |:---|:---|:---| | version | String | **参数解释：** IP地址版本。 **取值范围：** "4":代表IPv4。 "6":代表IPv6。 | | addr | String | **参数解释：** IP地址。 **取值范围：** 不涉及 | | type | String | **参数解释：** IP地址类型。 **取值范围：** fixed:代表私有IP地址。 floating:代表浮动IP地址 | | mac_addr | String | **参数解释：** MAC地址。 **取值范围：** 不涉及 | | port_id | String | **参数解释：** IP地址对应的端口ID。 **取值范围：** 不涉及 | | vpc_id | String | **参数解释：** 所属虚拟私有云的ID。 **取值范围：** 不涉及 | 表53HwcEcsSecurityGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 安全组ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 安全组名称或者UUID。 **取值范围：** 不涉及 | 表54HwcEcsFlavor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 云服务器规格ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 云服务器规格名称。 **取值范围：** 不涉及 | | disk | String | **参数解释：** 该云服务器规格对应要求系统盘大小，0为不限制。 **取值范围：** 不涉及 | | vcpus | String | **参数解释：** 该云服务器规格对应的CPU核数。 **取值范围：** 不涉及 | | ram | String | **参数解释：** 该云服务器规格对应的内存大小，单位为MB。 **取值范围：** 不涉及 | 表55HwcEcsVolume | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 磁盘ID，格式为UUID。 **取值范围：** 不涉及 | | delete_on_termination | String | **参数解释：** 删除云服务器时是否一并删除该磁盘。 **取值范围：** true:是 false:否 | | boot_index | String | **参数解释：** 云硬盘启动顺序。 **取值范围：** 0为系统盘。 非0为数据盘。 | | device | String | **参数解释：** 云硬盘挂载盘符，即磁盘挂载点。 **取值范围：** 不涉及 | 表56HwcEcsMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image_id | String | **参数解释：** 云服务器操作系统对应的镜像ID。 **取值范围：** 不涉及 | | image_type | String | **参数解释：** 镜像类型，目前支持： 公共镜像（gold） 私有镜像（private） 共享镜像（shared） **取值范围：** 不涉及 | | image_name | String | **参数解释：** 云服务器操作系统对应的镜像名称。 **取值范围：** 不涉及 | | os_bit | String | **参数解释：** 操作系统位数，一般取值为"32"或者"64"。 **取值范围：** 不涉及 | | os_type | String | **参数解释：** 操作系统类型，取值为：Linux、Windows。 **取值范围：** 不涉及 | | vpc_id | String | **参数解释：** 云服务器所属的虚拟私有云ID。 **取值范围：** 不涉及 | | resource_spec_code | String | **参数解释：** 云服务器对应的资源规格。 **取值范围：** 不涉及 | | resource_type | String | **参数解释：** 云服务器对应的资源类型。 **取值范围：** 取值为"1"，代表资源类型为云服务器。 | | agency_name | String | **参数解释：** 委托的名称。 委托是由租户管理员在统一身份认证服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务器的临时凭证。 **取值范围：** 不涉及 | 表57HwcEcsSchedulerHint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | group | Array of strings | **参数解释：** 云服务器组ID，UUID格式。 云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。 **取值范围：** 不涉及 | | tenancy | Array of strings | **参数解释：** 在指定的专属主机或者共享主机上创建弹性云服务器。 参数值为shared或者dedicated。 **取值范围：** 不涉及 | | dedicated_host_id | Array of strings | **参数解释：** 专属主机的ID。 说明： 专属主机的ID仅在tenancy为dedicated时生效。 **取值范围：** 不涉及 | 表58HwcEcsHypervisor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hypervisor_type | String | **参数解释：** 虚拟化类型。 **取值范围：** 不涉及 | | csd_hypervisor | String | **参数解释：** 预留属性。 **取值范围：** 不涉及 | 表59HwcEip | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 弹性公网IP唯一标识 **取值范围：** 不涉及 | | alias | String | **参数解释：** 弹性公网IP名称 **取值范围：** 不涉及 | | protected_status | String | **参数解释：** DDoS或CFW开启状态：OPEN \| CLOSE **取值范围：** 不涉及 | | project_id | String | **参数解释：** 项目ID **取值范围：** 不涉及 | | enterprise_project_id | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及 | | ip_version | Integer | **参数解释：** IP版本信息 **取值范围：** 4:公网IP地址为public_ip_address地址 6:公网IP地址为public_ipv6_address地址 | | public_ip_address | String | **参数解释：** 弹性公网IP或者IPv6端口的地址 **取值范围：** 不涉及 | | public_ipv6_address | String | **参数解释：** IPv4时无此字段，IPv6时为申请到的弹性公网IP **取值范围：** 不涉及 | | publicip_pool_name | String | **参数解释：** 弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户申请的专属池。 **取值范围：** 不涉及 | | publicip_pool_id | String | **参数解释：** 公网IP所属网络的ID，publicip_pool_name对应的网络ID **取值范围：** 不涉及 | | status | String | **参数解释：** 弹性公网IP的状态 **取值范围：** FREEZED:冻结 BIND_ERROR:绑定失败 BINDING:绑定中 PENDING_DELETE:释放中 PENDING_CREATE:创建中 NOTIFYING:创建中 NOTIFY_DELETE:释放中 PENDING_UPDATE:更新中 DOWN:未绑定 ACTIVE:绑定 ELB:绑定ELB VPN:绑定VPN ERROR:失败 | | description | String | **参数解释：** 弹性公网IP描述信息 **取值范围：** 不涉及 | | tags | Array of strings | **参数解释：** 功能说明：用户标签。（默认不显示） **取值范围：** 不涉及 | | type | String | **参数解释：** 弹性公网IP类型 **取值范围：** 枚举值： EIP DUALSTACK DUALSTACK_SUBNET | | vnic | [HwcEipVnic] object | **参数解释：** 公网IP绑定实例有PORT时，PORT的相关信息 **取值范围：** 不涉及 | | bandwidth | [HwcEipBandwidth] object | **参数解释：** 公网IP绑定带宽信息 **取值范围：** 不涉及 | | lock_status | String | **参数解释：** 记录公网IP当前的冻结状态 约束：metadata类型，标识欠费冻结、公安冻结 **取值范围：** police locked | | associate_instance_type | String | **参数解释：** 公网IP绑定的实例类型 **取值范围：** PORT NATGW ELB ELBV1 VPN null | | associate_instance_id | String | **参数解释：** 公网IP绑定的实例ID **取值范围：** 不涉及 | | allow_share_bandwidth_types | Array of strings | **参数解释：** 表示此publicip可以加入的共享带宽类型列表，如果为空列表，则表示该 publicip不能加入任何共享带宽 约束：publicip只能加入到有该带宽类型的共享带宽中 **取值范围：** 不涉及 | | created_at | String | **参数解释：** 资产创建UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ **取值范围：** 不涉及 | | updated_at | String | **参数解释：** 资产更新UTC时间 格式：yyyy-MM-ddTHH:mm:ssZ **取值范围：** 不涉及 | | public_border_group | String | **参数解释：** 表示中心站点资产或者边缘站点资产 约束：publicip只能绑定该字段相同的资产 **取值范围：** center、边缘站点名称 | 表60HwcEipVnic | 参数 | 参数类型 | 描述 | |:---|:---|:---| | private_ip_address | String | **参数解释：** 私网IP地址 **取值范围：** 不涉及 | | device_id | String | **参数解释：** 端口所属设备ID **取值范围：** 不涉及 | | device_owner | String | **参数解释：** 设备所属 **取值范围：** 合法设备所属 network:dhcp network:VIP_PORT network:router_interface_distributed network:router_centralized_snat 约束：不支持设置和更新,由系统自动维护 | | vpc_id | String | **参数解释：** 虚拟私有云ID **取值范围：** 不涉及 | | port_id | String | **参数解释：** 端口ID **取值范围：** 不涉及 | | port_profile | String | **参数解释：** 端口profile信息 **取值范围：** 不涉及 | | mac | String | **参数解释：** 端口MAC地址 **取值范围：** 不涉及 | | vtep | String | **参数解释：** VTEP IP **取值范围：** 不涉及 | | vni | String | **参数解释：** VXLAN ID **取值范围：** 不涉及 | | instance_id | String | **参数解释：** 端口所属实例ID,例如RDS实例ID **取值范围：** 不涉及 | | instance_type | String | **参数解释：** 端口所属实例类型,例如"RDS" **取值范围：** 不涉及 | 表61HwcEipBandwidth | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 带宽ID **取值范围：** 不涉及 | | size | Integer | **参数解释：** 带宽大小 **取值范围：** 默认5Mbit/s\~2000Mbit/s | | share_type | String | **参数解释：** 带宽类型，标识是否是共享带宽 **取值范围：** PER:独享带宽 WHOLE:共享带宽 约束：其中IPv6暂不支持WHOLE类型带宽。 | | name | String | **参数解释：** 带宽名称 **取值范围：** 不涉及 | 表62HwcVpc | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** VPC对应的唯一标识。 **取值范围：** 长度为32\~36个字符。 | | name | String | **参数解释：** VPC对应的名称。 **取值范围：** 长度为0\~128个字符。 | | description | String | **参数解释：** VPC的描述信息。 **取值范围：** 长度为0\~255个字符。 | | protected_status | String | **参数解释：** CFW开启或安全组规则配置状态。 **取值范围：** - OPEN:已开启 - CLOSE:已关闭 | | cidr | String | **参数解释：** VPC下可用子网的范围，必须是ipv4 cidr格式，例如192.168.0.0/16。 **取值范围：** - 10.0.0.0/8\~10.255.255.240/28 - 172.16.0.0/12\~172.31.255.240/28 - 192.168.0.0/16\~192.168.255.240/28 | | extend_cidrs | Array of strings | **参数解释：** VPC的扩展网段，String类型的数组。 **取值范围：** 不涉及 | | status | String | **参数解释：** VPC对应的状态。 **取值范围：** - PENDING:创建中 - ACTIVE:创建成功 | | project_id | String | **参数解释：** VPC所属的项目ID。 **取值范围：** 长度为32\~36个字符。 | | enterprise_project_id | String | **参数解释：** VPC所属的企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | created_at | String | **参数解释：** VPC创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | String | **参数解释：** VPC更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | cloud_resources | Array of [HwcVpcCloudResource] objects | **参数解释：** VPC关联资产类型和数量，HwcVpcCloudResource对象类型的数组。目前只返回VPC关联的routetable和virsubnet，virsubnet数量为ipv4和ipv6子网总数。 **取值范围：** 不涉及 | | tags | Array of [Tag] objects | **参数解释：** VPC的标签信息，Tag对象类型的数组。详情参见Tag对象。 **取值范围：** 不涉及 | 表63HwcVpcCloudResource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_type | String | **参数解释：** 资产类型。 **取值范围：** 长度为0\~32个字符。 | | resource_count | Integer | **参数解释：** 资产数量。 **取值范围：** 0\~65535 | 表64HwcSubnet | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 子网对应的唯一标识。 **取值范围：** 长度为32\~36个字符。 | | name | String | **参数解释：** 子网名称。 **取值范围：** 长度为0\~64个字符。 | | description | String | **参数解释：** 子网的描述信息。 **取值范围：** 长度为0\~255个字符。 | | project_id | String | **参数解释：** 子网所属的项目ID。 **取值范围：** 长度为32\~36个字符。 | | created_at | String | **参数解释：** 子网创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | String | **参数解释：** 子网更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | enterprise_project_id | String | **参数解释：** 子网所属的企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | security_group_rules | Array of [HwcSubnetSecurityGroupRule] objects | **参数解释：** 安全组规则，HwcSubnetSecurityGroupRule对象类型的数组。 **取值范围：** 不涉及 | 表65HwcSubnetSecurityGroupRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 安全组规则对应的唯一标识。 **取值范围：** 带"-"的标准UUID格式。 | | description | String | **参数解释：** 安全组规则的描述信息。 **取值范围：** 长度为0\~255个字符。 | | security_group_id | String | **参数解释：** 安全组规则所属的安全组ID。 **取值范围：** 长度为0\~36个字符。 | | direction | String | **参数解释：** 安全组规则的出入控制方向。 **取值范围：** - ingress:入方向 - egress:出方向 | | protocol | String | **参数解释：** 协议类型。为空表示支持所有协议。协议为icmpv6时，网络类型应该为IPv6；协议为icmp时，网络类型应该为IPv4。 **取值范围：** icmp、tcp、udp、icmpv6或IP协议号。 | | ethertype | String | **参数解释：** IP地址协议类型。不填默认值为IPv4。 **取值范围：** - IPv4 - IPv6 | | multiport | String | **参数解释：** 端口取值范围。 **取值范围：** 支持单端口(80)、连续端口(1-30)以及不连续端口(22,3389,80)。 | | action | String | **参数解释：** 安全组规则生效策略。默认值为deny。 **取值范围：** - allow:允许 - deny:拒绝 | | priority | Integer | **参数解释：** 优先级，1代表最高优先级。 **取值范围：** 1\~100 | | remote_group_id | String | **参数解释：** 远端安全组ID，表示该安全组内的流量允许或拒绝。与remote_ip_prefix、remote_address_group_id功能互斥。 **取值范围：** 租户下存在的安全组ID。 | | remote_ip_prefix | String | **参数解释：** 远端IP地址。当direction是egress时，为虚拟机访问端的地址；当direction是ingress时，为访问虚拟机的地址。与remote_group_id、remote_address_group_id互斥。 **取值范围：** IP地址，或者cidr格式。 | | remote_address_group_id | String | **参数解释：** 远端地址组ID。与remote_ip_prefix、remote_group_id功能互斥。 **取值范围：** 租户下存在的地址组ID。 | | created_at | String | **参数解释：** 安全组规则创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | updated_at | String | **参数解释：** 安全组规则更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss。 **取值范围：** 长度为0\~32个字符。 | | project_id | String | **参数解释：** 安全组规则所属项目ID。 **取值范围：** 长度为32\~36个字符。 | 表66HwcRds | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 创建的实例名称。 **取值范围：** 不涉及 | | protected_status | String | **参数解释：** DBSS开启状态：OPEN \| CLOSE **取值范围：** 不涉及 | | status | String | **参数解释：** 实例状态。 **取值范围：** 值为"BUILD"，表示实例正在创建。 值为"ACTIVE"，表示实例正常。 值为"FAILED"，表示实例异常。 值为"FROZEN"，表示实例冻结。 值为"MODIFYING"，表示实例正在扩容。 值为"REBOOTING"，表示实例正在重启。 值为"RESTORING"，表示实例正在恢复。 值为"MODIFYING INSTANCE TYPE"，表示实例正在转主备。 值为"SWITCHOVER"，表示实例正在主备切换。 值为"MIGRATING"，表示实例正在迁移。 值为"BACKING UP"，表示实例正在进行备份。 值为"MODIFYING DATABASE PORT"，表示实例正在修改数据库端口。 值为"STORAGE FULL"，表示实例磁盘空间满。 | | alias | String | **参数解释：** 实例的备注信息。 **取值范围：** 不涉及 | | private_ips | Array of strings | **参数解释：** 实例内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。 **取值范围：** 不涉及 | | private_dns_names | Array of strings | **参数解释：** 实例内网域名列表。实例创建成功后，需要手动申请内网域名，否则查询内网域名为空。 **取值范围：** 不涉及 | | public_ips | Array of strings | **参数解释：** 实例外网IP地址列表。 **取值范围：** 不涉及 | | port | Integer | **参数解释：** 数据库端口号。 RDS for MySQL数据库端口设置范围为1024～65535（其中12017和33071被RDS系统占用不可设置）。 RDS for PostgreSQL数据库端口修改范围为2100～9500。 RDS for SQL Server实例的端口设置范围为1433和2100\~9500（其中5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版，5050、5353和5986不可设置）。 当不传该参数时，默认端口如下： RDS for MySQL默认3306。 RDS for PostgreSQL默认5432。 RDS for SQL Server默认1433。 **取值范围：** 不涉及 | | enable_ssl | Boolean | **参数解释：** 实例开启SSL标志。 **取值范围：** 取值为"true":表示实例已开启SSL。 取值为"false":表示实例未开启SSL。 | | type | String | **参数解释：** 实例类型，取值为"Single"，"Ha"或"Replica", "Enterprise"，分别对应于单机实例、主备实例、只读实例、分布式实例（企业版）。 **取值范围：** 不涉及 | | ha | [HwcRdsHa] object | **参数解释：** HA信息，获取HA实例时返回。 **取值范围：** 不涉及 | | region | String | **参数解释：** 实例所在区域。 **取值范围：** 不涉及 | | datastore | [HwcRdsDatastore] object | **参数解释：** 数据库信息。 **取值范围：** 不涉及 | | created | String | **参数解释：** 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 **取值范围：** 不涉及\|- | | updated | String | **参数解释：** 更新时间，格式与"created"字段对应格式完全相同。 说明：创建时返回值为空，数据库实例创建成功后该值不为空。 **取值范围：** 不涉及 | | db_user_name | String | **参数解释：** 默认用户名。 **取值范围：** 不涉及 | | vpc_id | String | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及 | | subnet_id | String | **参数解释：** 子网的网络ID信息。 **取值范围：** 不涉及 | | security_group_id | String | **参数解释：** 安全组ID。 **取值范围：** 不涉及 | | flavor_ref | String | **参数解释：** 规格码。 **取值范围：** 不涉及 | | cpu | String | **参数解释：** CPU核数，单位为核（U）。例如，1表示1个vCPU。 **取值范围：** 不涉及 | | mem | String | **参数解释：** 内存大小（单位：GB）。 **取值范围：** 不涉及 | | volume | [HwcRdsVolume] object | **参数解释：** Volume信息。 **取值范围：** 不涉及 | | tags | Array of [Tag] objects | **参数解释：** 标签列表，没有标签默认为空数组。 **取值范围：** 不涉及 | | enterprise_project_id | String | **参数解释：** 企业项目标签ID。 **取值范围：** 不涉及 | | project_id | String | **参数解释：** 项目ID **取值范围：** 不涉及 | | switch_strategy | String | **参数解释：** 数据库切换策略。取值为"reliability"或"availability"，分别对应于可靠性优先和可用性优先。 **取值范围：** 不涉及 | | read_only_by_user | Boolean | **参数解释：** 用户设置的实例只读状态。仅支持RDS for MySQL引擎。 **取值范围：** true，表示该实例被设置为只读状态。 false，表示该实例未被设置为只读状态。 | | backup_strategy | [HwcRdsBackupStrategy] object | **参数解释：** 备份策略。 **取值范围：** 不涉及 | | maintenance_window | String | **参数解释：** 可维护时间窗，为UTC时间。 **取值范围：** 不涉及 | | nodes | Array of [HwcRdsNode] objects | **参数解释：** 主备实例信息 **取值范围：** 不涉及 | | related_instance | Array of [HwcRdsRelatedInstance] objects | **参数解释：** 所关联的数据库实例列表。 **取值范围：** 不涉及 | | disk_encryption_id | String | **参数解释：** 磁盘加密密钥ID。 **取值范围：** 不涉及 | | time_zone | String | **参数解释：** 时区。 **取值范围：** 不涉及 | | backup_used_space | Double | **参数解释：** 备份空间使用量，单位GB。 该字段仅用于查询指定RDS for SQL Server单个实例信息时返回。 **取值范围：** 不涉及 | | storage_used_space | Double | **参数解释：** 磁盘空间使用量，单位GB。 该字段仅用于查询指定RDS for SQL Server单个实例信息时返回。 **取值范围：** 不涉及 | | associated_with_ddm | Boolean | **参数解释：** 是否已被DDM实例关联。 true: 已被DDM实例关联 false: 未被DDM实例关联 **取值范围：** - true - false | | max_iops | Long | **参数解释：** 实例磁盘的最大IOPS值。 当前该字段仅对于SQL Server引擎实例返回。 **取值范围：** 不涉及 | | expiration_time | String | **参数解释：** 实例的到期时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 该字段仅当实例具有明确的到期时间时返回。 **取值范围：** 不涉及 | 表67HwcRdsHa | 参数 | 参数类型 | 描述 | |:---|:---|:---| | replication_mode | String | **参数解释：** 备机同步参数。 **取值范围：** 取值：非空。 RDS for MySQL为"async"或"semisync"。 RDS for PostgreSQL为"async"或"sync"。 RDS for Microsoft SQL Server为"sync"。 说明： "async"为异步模式。 "semisync"为半同步模式。 "sync"为同步模式。 | 表68HwcRdsDatastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据库引擎，不区分大小写： **取值范围：** MySQL PostgreSQL SQLServer | | version | String | **参数解释：** 数据库版本。 **取值范围：** 不涉及 | | complete_version | String | **参数解释：** 数据库完整版本号。仅在数据库引擎是"PostgreSQL"时返回。 **取值范围：** 不涉及 | 表69HwcRdsVolume | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 磁盘类型。 **取值范围：** 不涉及 | | size | Integer | **参数解释：** 磁盘大小，单位为GB。 **取值范围：** 不涉及 | 表70Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格。 **取值范围：** 不涉及 | | values | Array of strings | **参数解释：** 值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。 value可为空数组但不可缺省。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。 **取值范围：** 不涉及 | 表71HwcRdsBackupStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | start_time | String | **参数解释：** 备份时间段。自动备份将在该时间段内触发。 当前时间指UTC时间。 **取值范围：** 不涉及 | | keep_days | Integer | **参数解释：** 已生成的备份文件可以保存的天数。 **取值范围：** 取值范围：0～732。为0时，表示未设置自动备份策略或备份策略已关闭。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。 | 表72HwcRdsNode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 节点ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 节点名称。 **取值范围：** 不涉及 | | role | String | **参数解释：** 节点类型，取值为"master"、"slave"或"readreplica"，分别对应于主节点、备节点和只读节点。 **取值范围：** 不涉及 | | status | String | **参数解释：** 节点状态。 **取值范围：** 不涉及 | | availability_zone | String | **参数解释：** 可用区。 **取值范围：** 不涉及 | 表73HwcRdsRelatedInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 关联实例id。 **取值范围：** 不涉及 | | type | String | **参数解释：** 关联实例类型。 "replica_of"对应于"主实例"。 "replica"对应于"只读实例"。 **取值范围：** 不涉及 | 表74HwcDomain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_name | String | **参数解释：** 域名名称 **取值范围：** 不涉及 | | expire_date | String | **参数解释：** 域名到期时间，eg:2023-01-10 **取值范围：** 不涉及 | | status | String | **参数解释：** 域名服务状态 **取值范围：** 不涉及 | | audit_status | String | **参数解释：** 域名实名认证状态。 **取值范围：** NONAUDIT:未实名认证 SUCCEED:已实名认证 FAILED:实名认证失败 AUDITING:实名认证审核中 | | audit_unpass_reason | String | **参数解释：** 域名实名认证失败原因 **取值范围：** 不涉及 | | transfer_status | String | **参数解释：** 过户状态 **取值范围：** 不涉及 | | reg_type | String | **参数解释：** 注册类型 **取值范围：** PERSONAL:个人 COMPANY:企业 | | privacy_protection | String | **参数解释：** 是否开启隐私保护 **取值范围：** 不涉及 | | name_server | Array of strings | **参数解释：** 域名服务器列表 **取值范围：** 不涉及 | | credential_type | String | **参数解释：** 证件类型 **取值范围：** 不涉及 | | credential_id | String | **参数解释：** 证件号码 **取值范围：** 不涉及 | | registrar | String | **参数解释：** 域名所属注册商 **取值范围：** 不涉及 | | contact | Array of [HwcDomainContact] objects | **参数解释：** 联系人信息 **取值范围：** 不涉及 | 表75HwcDomainContact | 参数 | 参数类型 | 描述 | |:---|:---|:---| | email | String | **参数解释：** 邮箱地址 **取值范围：** 不涉及 | | register | String | **参数解释：** 域名所有者 **取值范围：** 不涉及 | | contact_name | String | **参数解释：** 联系人 **取值范围：** 不涉及 | | phone_num | String | **参数解释：** 联系电话 **取值范围：** 不涉及 | | province | String | **参数解释：** 省份 **取值范围：** 不涉及 | | city | String | **参数解释：** 城市 **取值范围：** 不涉及 | | address | String | **参数解释：** 通讯地址 **取值范围：** 不涉及 | | zip_code | String | **参数解释：** 邮编 **取值范围：** 不涉及 | 表76Website | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | String | **参数解释：** 网站URL。 **取值范围：** 长度为0\~256个字符。 | | main_domain | String | **参数解释：** 主域名。 **取值范围：** 长度为0\~256个字符。 | | protected_status | String | **参数解释：** WAF开启状态。 **取值范围：** - OPEN:WAF已开启 - CLOSE:WAF已关闭 | | is_public | Boolean | **参数解释：** 是否为外网地址。 **取值范围：** - true:外网 - false:内网 | | remark | String | **参数解释：** 网站备注。 **取值范围：** 长度为0\~512个字符。 | | name_server | Array of strings | **参数解释：** 网站服务器列表。 **取值范围：** 0\~512个元素 | | extend_properties | [WebsiteExtendProperties] object | **参数解释：** 其他扩展属性。 **取值范围：** 不涉及 | 表77WebsiteExtendProperties | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mac_addr | String | **参数解释：** mac地址 **取值范围：** 不涉及 | 表78OcaIp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | String | **参数解释：** IP地址值。 **取值范围：** 长度为0\~64个字符。 | | version | String | **参数解释：** IP地址版本。 **取值范围：** - ipv4:IPv4地址 - ipv6:IPv6地址 | | network | [OcaIpNetwork] object | **参数解释：** 网络信息。 **取值范围：** 不涉及 | | remark | String | **参数解释：** 资产备注。 **取值范围：** 长度为0\~512个字符。 | | name | String | **参数解释：** 资产名称，默认为资产值。 **取值范围：** 长度为0\~128个字符。 | | relative_value | String | **参数解释：** 相对值，如资产为IPv4，则为对应的IPv6地址。 **取值范围：** 长度为0\~128个字符。 | | server_room | String | **参数解释：** 机房名称。 **取值范围：** 长度为0\~128个字符。 | | server_rack | String | **参数解释：** 机柜名称。 **取值范围：** 长度为0\~128个字符。 | | data_center | [OcaIpDataCenter] object | **参数解释：** 数据中心信息。 **取值范围：** 不涉及 | | mac_addr | String | **参数解释：** MAC地址。 **取值范围：** 长度为0\~128个字符。 | | important | String | **参数解释：** 重要等级。 **取值范围：** - 0:不重要 - 1:重要 | | extend_properties | [OcaIpExtendProperties] object | **参数解释：** 其他三方扩展属性。 **取值范围：** 不涉及 | 表79OcaIpNetwork | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_public | Boolean | **参数解释：** 是否为外网地址。 **取值范围：** - true:外网 - false:内网 | | partition | String | **参数解释：** 网络分区。OM：运维管理区 PSZ：生产区 DMZ：隔离区 **取值范围：** - OM - PSZ - DMZ | | plane | String | **参数解释：** 网络平面（线下有自己的代号）。 **取值范围：** 长度为0\~128个字符。 | | vxlan_id | String | **参数解释：** 虚拟网络ID。 **取值范围：** 长度为32\~36个字符。 | 表80OcaIpDataCenter | 参数 | 参数类型 | 描述 | |:---|:---|:---| | latitude | Float | **参数解释：** 纬度。 **取值范围：** 0\~100（不含0和100） | | longitude | Float | **参数解释：** 经度。 **取值范围：** 0\~100（不含0和100） | | city_code | String | **参数解释：** 城市编码。 **取值范围：** 长度为0\~128个字符。 | | country_code | String | **参数解释：** 国家编码。 **取值范围：** 长度为0\~128个字符。 | 表81OcaIpExtendProperties | 参数 | 参数类型 | 描述 | |:---|:---|:---| | device | [OcaIpDevice] object | **参数解释：** 设备信息。 **取值范围：** 不涉及 | | system | [OcaIpSystem] object | **参数解释：** 系统信息。 **取值范围：** 不涉及 | | services | Array of [OcaIpService] objects | **参数解释：** 应用信息列表。 **取值范围：** 0\~128个元素 | 表82OcaIpDevice | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 设备类型。 **取值范围：** 长度为0\~128个字符。 | | model | String | **参数解释：** 设备型号。 **取值范围：** 长度为0\~128个字符。 | | vendor | [OcaIpVendor] object | **参数解释：** 设备供应商信息。 **取值范围：** 不涉及 | 表83OcaIpSystem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | family | String | **参数解释：** 系统类型。 **取值范围：** 长度为0\~128个字符。 | | name | String | **参数解释：** 系统名称。 **取值范围：** 长度为0\~128个字符。 | | version | String | **参数解释：** 系统版本。 **取值范围：** 长度为0\~128个字符。 | | vendor | [OcaIpVendor] object | **参数解释：** 系统供应商信息。 **取值范围：** 不涉及 | 表84OcaIpService | 参数 | 参数类型 | 描述 | |:---|:---|:---| | port | Integer | **参数解释：** 应用对应端口。 **取值范围：** 0\~65535 | | protocol | String | **参数解释：** 应用协议。 **取值范围：** 长度为0\~128个字符。 | | name | String | **参数解释：** 应用名称。 **取值范围：** 长度为0\~256个字符。 | | version | String | **参数解释：** 应用版本。 **取值范围：** 长度为0\~128个字符。 | | vendor | [OcaIpVendor] object | **参数解释：** 应用供应商信息。 **取值范围：** 不涉及 | 表85OcaIpVendor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 供应商名称。 **取值范围：** 长度为0\~128个字符。 | | is_xc | Boolean | **参数解释：** 供应商是否为国产。 **取值范围：** - true:国产供应商 - false:非国产供应商 | #### 请求示例 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/resources { "batch_ids" : [ "OCAo*****23", "OCAo*****45" ], "data_object" : { "name" : "test**01", "provider" : "oca", "type" : "device", "level" : 1, "governance_user" : { "name" : "li**om" } } } ``` #### 响应示例 **状态码：200** ``` { "code" : "00000000", "message" : "", "data" : { "data_object" : { "id" : "OCAo*****23", "name" : "test**01", "provider" : "oca", "type" : "device", "checksum" : "a1b2*****90", "created" : "2025-10-14T14:39:07Z", "provisioning_state" : "Succeeded", "environment" : { "vendor_type" : "OCA", "domain_id" : "ac74*****f4", "region_id" : "region_a", "project_id" : "1564*****a6", "ep_id" : "0000*****00", "ep_name" : "default", "vendor_name" : "on**v2", "idc_name" : "Be**-A", "idc_id" : "id**01" }, "governance_user" : { "name" : "li**om" }, "level" : 1, "properties" : { } } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 批量更新资产返回体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。