搜索资产列表

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Language

是

String

参数解释：

语言，参考值：zh-cn、en-us

约束限制：

不涉及

取值范围：

zh-cn：中文环境

en-us：英文环境

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

内容类型

• application/json;charset=UTF-8 普通API请求的类型

约束限制：

不涉及

取值范围：

• application/json;charset=UTF-8

默认取值：

不涉及

limit

否

Integer

分页大小

offset

否

Integer

偏移量

sort_by

否

String

排序字段：create_time | update_time

order

否

String

排序方式：DESC | ASC

from_date

否

String

搜索开始时间，例如：2023-02-20T00:00:00.000Z

to_date

否

String

搜索结束时间，例如：2023-02-27T23:59:59.999Z

condition

否

condition object

搜索条件表达式

conditions

否

Array of conditions objects

表达式列表

logics

否

Array of strings

表达式名称列表

name

否

String

表达式名称

data

否

Array of strings

表达式内容列表

code

String

错误码

message

String

错误信息

total

Integer

资产总数

limit

Integer

分页大小

offset

Integer

偏移量

success

Boolean

是否成功

data

Array of ResourceDetail objects

资产列表

id

String

资产id

name

String

资产名称

provider

String

资产来源，云服务名称(云上)，线下机房（IDC）

type

String

资产类型, 比如ECS/VPC/EVS/IP/URL等

checksum

String

资产详情校验码。

created

String

资产创建时间。

provisioning_state

String

资产操作状态。

environment

ResourceEnvironment object

资产所属环境

department

Department object

资产所属部门

governance_user

GovernanceUser object

资产治理责任人

level

Integer

0: 测试 1： 一般 2： 关键资产

properties

Properties object

资产详细属性。

vendor_type

String

环境供应商

domain_id

String

HWC special，资产归属

region_id

String

HWC special，全局服务"global"，资产归属

project_id

String

HWC special， 全局服务默认null， 资产归属

ep_id

String

HWC special，资产归属的企业项目id。

ep_name

String

HWC special，资产归属的企业项目名称。

vendor_name

String

OCA special，包含资产探针或资产提供商

idc_name

String

OCA special，线下机房名称

idc_id

String

OCA special，线下机房id

id

String

资产所属部门名称id，若不填写为default

name

String

资产所属部门名称

type

String

资产治理责任人类型

name

String

资产治理责任人名称，为空则忽略，不存在则创建

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

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

虚拟化信息。

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。

id

String

安全组ID。

name

String

安全组名称或者UUID。

id

String

云服务器规格ID。

name

String

云服务器规格名称。

disk

String

该云服务器规格对应要求系统盘大小，0为不限制。

vcpus

String

该云服务器规格对应的CPU核数。

ram

String

该云服务器规格对应的内存大小，单位为MB。

id

String

磁盘ID，格式为UUID。

delete_on_termination

String

删除云服务器时是否一并删除该磁盘。

true：是

false：否

boot_index

String

云硬盘启动顺序。

0为系统盘。

非0为数据盘。

device

String

云硬盘挂载盘符，即磁盘挂载点。

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）上创建的，可以为弹性云服务器提供访问云服务器的临时凭证。

group

Array of strings

云服务器组ID，UUID格式。

云服务器组的ID可以从控制台或者参考查询云服务器组列表获取。

tenancy

Array of strings

在指定的专属主机或者共享主机上创建弹性云服务器。

参数值为shared或者dedicated。

dedicated_host_id

Array of strings

专属主机的ID。

说明：

专属主机的ID仅在tenancy为dedicated时生效。

hypervisor_type

String

虚拟化类型。

csd_hypervisor

String

预留属性。

id

String

弹性公网IP唯一标识

alias

String

弹性公网IP名称

protected_status

String

DDoss或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

表示中心站点资产或者边缘站点资产

取值范围： center、边缘站点名称

约束：publicip只能绑定该字段相同的资产

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”

id

String

带宽ID

size

Integer

带宽大小

取值范围：默认5Mbit/s~2000Mbit/s

share_type

String

带宽类型，标识是否是共享带宽

取值范围：

PER：独享带宽

WHOLE：共享带宽

约束：其中IPv6暂不支持WHOLE类型带宽。

name

String

带宽名称

id

String

VPC对应的唯一标识

name

String

VPC对应的名称

description

String

VPC的描述信息

protected_status

String

CFW开启或安全组规则配置状态：OPEN | CLOSE

cidr

String

VPC下可用子网的范围

取值范围：

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

不指定cidr时，默认值为“”

约束：必须是ipv4 cidr格式，例如:192.168.0.0/16

extend_cidrs

Array of strings

VPC的扩展网段

约束：目前只支持ipv4

status

String

VPC对应的状态

取值范围：

PENDING：创建中

ACTIVE：创建成功

project_id

String

VPC所属的项目ID

enterprise_project_id

String

VPC所属的企业项目ID。

取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。

created_at

String

VPC创建时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

updated_at

String

VPC更新时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

cloud_resources

Array of HwcVpcCloudResource objects

VPC关联资产类型和数量

取值范围：目前只返回VPC关联的routetable和virsubnet。virsubnet数量为ipv4和ipv6子网总数。

tags

Array of Tag objects

VPC的标签信息，详情参见Tag对象

取值范围：0-10个标签键值对

resource_type

String

资产类型

resource_count

Integer

资产数量

id

String

安全组对应的唯一标识

name

String

安全组名称

description

String

安全组的描述信息

project_id

String

安全组所属的项目ID

created_at

String

安全组创建时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

updated_at

String

安全组更新时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

enterprise_project_id

String

安全组所属的企业项目ID。

取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。

security_group_rules

Array of HwcSubnetSecurityGroupRule objects

安全组规则

id

String

安全组规则对应的唯一标识

取值范围：带“-”的标准UUID格式

description

String

安全组规则的描述信息

security_group_id

String

安全组规则所属的安全组ID

direction

String

安全组规则的出入控制方向

取值范围：

ingress 表示入方向

egress 表示出方向

protocol

String

协议类型

取值范围：icmp、tcp、udp、icmpv6或IP协议号

约束：为空表示支持所有协议。协议为icmpv6时，网络类型应该为IPv6；协议为icmp时，网络类型应该为IPv4

ethertype

String

IP地址协议类型

取值范围：IPv4，IPv6

约束：不填默认值为IPv4

multiport

String

端口取值范围

取值范围：支持和单端口(80)，连续端口(1-30)以及不连续端口(22,3389,80)

action

String

安全组规则生效策略

取值范围：

allow表示允许

deny表示拒绝

约束：默认值为deny

priority

Integer

优先级

取值范围：1~100，1代表最高优先级

remote_group_id

String

远端安全组ID，表示该安全组内的流量允许或拒绝

取值范围：租户下存在的安全组ID

约束：与remote_ip_prefix，remote_address_group_id功能互斥

remote_ip_prefix

String

远端IP地址，

当direction是egress时，为虚拟机访问端的地址

当direction是ingress时，为访问虚拟机的地址

取值范围：IP地址，或者cidr格式

约束：与remote_group_id、remote_address_group_id互斥

remote_address_group_id

String

远端地址组ID

取值范围：租户下存在的地址组ID

约束：与remote_ip_prefix，remote_group_id功能互斥

created_at

String

安全组规则创建时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

updated_at

String

安全组规则更新时间

取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss

project_id

String

安全组规则所属项目ID

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大小。例如，1表示1U。

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实例关联。

max_iops

Long

实例磁盘的最大IOPS值。

当前该字段仅对于SQL Server引擎实例返回。

expiration_time

String

实例的到期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

仅包周期场景返回。

replication_mode

String

备机同步参数。

取值：非空。

RDS for MySQL为“async”或“semisync”。

RDS for PostgreSQL为“async”或“sync”。

RDS for Microsoft SQL Server为“sync”。

说明：

“async”为异步模式。

“semisync”为半同步模式。

“sync”为同步模式。

type

String

数据库引擎，不区分大小写：

MySQL

PostgreSQL

SQLServer

version

String

数据库版本。

complete_version

String

数据库完整版本号。仅在数据库引擎是“PostgreSQL”时返回。

type

String

磁盘类型。

size

Integer

磁盘大小。

key

String

键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格。

values

Array of strings

值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。

value可为空数组但不可缺省。

如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。

start_time

String

备份时间段。自动备份将在该时间段内触发。

当前时间指UTC时间。

keep_days

Integer

已生成的备份文件可以保存的天数。

取值范围：0～732。为0时，表示未设置自动备份策略或备份策略已关闭。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。

id

String

节点ID。

name

String

节点名称。

role

String

节点类型，取值为“master”、“slave”或“readreplica”，分别对应于主节点、备节点和只读节点。

status

String

节点状态。

availability_zone

String

可用区。

id

String

关联实例id。

type

String

关联实例类型。

“replica_of”对应于“主实例”。

“replica”对应于“只读实例”。

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

联系人信息

email

String

邮箱地址

register

String

域名所有者

contact_name

String

联系人

phone_num

String

联系电话

province

String

省份

city

String

城市

address

String

通讯地址

zip_code

String

邮编

value

String

网站url

main_domain

String

主域名

protected_status

String

WAF开启状态：OPEN | CLOSE

is_public

Boolean

外网或内网

true：外网

false: 内网

remark

String

网站备注

name_server

Array of strings

网站服务器列表

extend_propertites

WebsiteExtendProperties object

其它属性

mac_addr

String

mac地址

value

String

资产值

version

String

资产类型：

ipv4、ipv6

network

OcaIpNetwork object

网络信息

remark

String

资产备注

name

String

资产名称，默认为资产值

relative_value

String

相对值，如资产为ipv4，则为对应的ipv6

server_room

String

机房

server_rack

String

机柜

data_center

OcaIpDataCenter object

数据中心

mac_addr

String

mac地址

important

String

重要等级0 ：不重要 1：重要

extend_propertites

OcaIpExtendProperties object

其它三方属性

is_public

Boolean

外网或内网

true：外网

false: 内网

partition

String

网络分区：OM/PSZ/DMZ

plane

String

网络平面（线下有自己的代号）

vxlan_id

String

虚拟网络ID

latitude

Float

纬度

longitude

Float

经度

city_code

String

城市编码

country_code

String

国家编码

device

OcaIpDevice object

设备信息

system

OcaIpSystem object

系统信息

services

Array of OcaIpService objects

应用信息

type

String

设备类型

model

String

设备型号

vendor

OcaIpVendor object

设备供应商

family

String

系统类型

name

String

系统名称

version

String

系统版本

vendor

OcaIpVendor object

系统供应商

port

Integer

应用对应端口

protocol

String

协议

name

String

应用名称

version

String

应用版本

vendor

OcaIpVendor object

应用供应商

name

String

供应名称

is_xc

Boolean

供应商是否是国产

200

搜索资产列表返回body体