Obtaining Resource Details

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

id

Yes

String

Unique ID of the resource.

X-Language

Yes

String

Definition

Language. Reference value: zh-cn or en-us.

Constraints

N/A

Range

zh-cn: Chinese environment

en-us: English environment

Default Value

N/A

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

• application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

• application/json;charset=UTF-8

Default Value

N/A

code

String

Error code.

message

String

Error message.

data

ResourceDetail object

Resource details.

id

String

Resource ID.

name

String

Resource name.

provider

String

Resource source. The cloud service name (cloud services) or specific on-premises data center (IDC) name is provided.

type

String

Resource type, such as ECS, VPC, EVS, IP address, and URL.

checksum

String

Resource checksum.

created

String

Resource creation time.

provisioning_state

String

Resource operation status.

environment

ResourceEnvironment object

Environment of the resource.

department

Department object

Department of the resource.

governance_user

GovernanceUser object

Resource governance owner.

level

Integer

0: test; 1: general; 2: key resource

properties

Properties object

Resource attribute details.

vendor_type

String

Environment provider.

domain_id

String

This field is used for resources on Huawei Cloud only. It specifies the resource owner.

region_id

String

This parameter is only used for resources on Huawei Cloud. It specifies the resource ownership. For global services, the value is "global".

project_id

String

This parameter is only used for resources on Huawei Cloud. It specifies the resource ownership. For global services, the default value is null.

ep_id

String

This parameter is only used for resources on Huawei Cloud. It specifies the ID of the enterprise project to which the resource belongs.

ep_name

String

This parameter is only used for resources on Huawei Cloud. It specifies the name of the enterprise project to which the resource belongs.

vendor_name

String

This field is used for OCA only. It specifies the asset probes or asset provider.

idc_name

String

This field is used for OCA only. It specifies the on-premises data center name.

idc_id

String

This field is used for OCA only. It specifies the on-premises data center ID.

id

String

ID of the department the resource belongs to. If this parameter is not specified, the default value is used.

name

String

Department of the resource.

type

String

Resource governance owner type.

name

String

Name of the resource governance owner. If this parameter is left blank, ignore it. If this parameter does not exist, create it.

hwc_ecs

HwcEcs object

Huawei Cloud ECS details.

hwc_eip

HwcEip object

Huawei Cloud EIP.

hwc_vpc

HwcVpc object

Huawei Cloud VPC.

hwc_subnet

HwcSubnet object

Huawei Cloud subnet.

hwc_rds

HwcRds object

Huawei Cloud RDS.

hwc_domain

HwcDomain object

Huawei Cloud domain name.

website

Website object

Website.

oca_ip

OcaIp object

IP address of a resource outside the cloud.

id

String

ECS ID, in UUID format.

name

String

ECS name.

protected_status

String

HSS status. The value can be OPEN or CLOSE.

description

String

ECS description.

status

String

ECS status.

Range:

ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, VERIFY_RESIZE, and DELETED.

locked

Boolean

Whether the ECS is locked.

• true: locked

• false: not locked

enterprise_project_id

String

ID of the enterprise project that the ECS belongs to.

user_id

String

ID of the account used to create the ECS, in UUID format.

project_id

String

ID of the project that the ECS belongs to, in UUID format.

host_id

String

ID of the host where the ECS is deployed.

host_name

String

Name of the host where the ECS is deployed.

host_status

String

Status of the host accommodating the ECS.

UP: The service is normal.

UNKNOWN: The status is unknown.

DOWN: The service is abnormal.

MAINTENANCE: The service is in maintenance state.

Null: The ECS does not have host information.

addresses

Array of HwcEcsAddress objects

Network attribute of the ECS.

security_groups

Array of HwcEcsSecurityGroup objects

Security groups to which the ECS belongs.

availability_zone

String

Name of the AZ where the ECS is deployed.

flavor

HwcEcsFlavor object

ECS flavor.

volumes_attached

Array of HwcEcsVolume objects

Disk attached to the ECS.

metadata

HwcEcsMetadata object

ECS metadata.

updated

String

The last time the ECS was updated, for example, time when it was started, stopped, or restarted.

Example time format: 2019-05-22T03:30:52Z

created

String

The time when the ECS was created.

Example time format: 2019-05-22T03:19:19Z

key_name

String

Name of the key pair used for the ECS.

scheduler_hints

HwcEcsSchedulerHint object

ECS scheduling information.

hypervisor

HwcEcsHypervisor object

Virtualization information.

version

String

IP address version.

• 4: IPv4 addresses

• 6: IPv6 addresses

addr

String

IP address.

type

String

IP address type.

• fixed: private IP addresses

• floating: floating IP addresses

mac_addr

String

MAC address.

port_id

String

ID of the port corresponding to the IP address.

vpc_id

String

ID of the VPC that the ECS belongs to.

id

String

Security group ID.

name

String

Security group name or UUID.

id

String

ECS flavor ID.

name

String

ECS flavor name.

disk

String

System disk size in the ECS flavor. The value 0 indicates that the disk size is not limited.

vcpus

String

Number of vCPUs in the ECS flavor.

ram

String

Memory size (MB) in the ECS flavor.

id

String

Disk ID, in UUID format.

delete_on_termination

String

Whether to delete the disk when deleting the ECS.

true: Yes

false: No

boot_index

String

EVS disk boot sequence.

0 indicates the system disk.

Non-zero values indicate data disks.

device

String

Drive letter where the EVS disk is attacked to.

image_id

String

Image ID of the ECS.

image_type

String

Image class. The following classes are supported:

• gold: public images

• private: private images

• shared: shared images

image_name

String

Image name corresponding to the cloud server OS.

os_bit

String

OS architecture, 32-bit or 64-bit.

os_type

String

OS type. The value can be Linux or Windows.

vpc_id

String

ID of the VPC where the cloud server is located.

resource_spec_code

String

Resource specifications of the cloud server.

resource_type

String

Resource type of the cloud server.

1: The resource type is ECS.

agency_name

String

Name of the agency.

An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for the ECS service to access cloud servers.

group

Array of strings

ECS group ID, in UUID format.

You can obtain the BMS group ID from the console or by calling the API for querying ECS groups.

tenancy

Array of strings

It means users can create ECSs on a dedicated or shared host.

The value of this parameter can be shared or dedicated.

dedicated_host_id

Array of strings

Dedicated host ID.

Note:

A DeH ID takes effect only when tenancy is set to dedicated.

hypervisor_type

String

Virtualization type.

csd_hypervisor

String

Reserved attribute.

id

String

ID of the EIP. It uniquely identifies the EIP.

alias

String

EIP name.

protected_status

String

Anti-DDoS or CFW enabling status. The value can be OPEN or CLOSE.

project_id

String

Project ID.

enterprise_project_id

String

Enterprise project ID.

ip_version

Integer

IP address version.

Range:

4: Ipv4 addresses.

6: IPv6 addresses.

public_ip_address

String

EIP or IPv6 port address.

public_ipv6_address

String

This field is unavailable when IPv4 is used. The value is the obtained EIP when IPv6 is used.

publicip_pool_name

String

Network type of an EIP, including the public EIP pool (for example, 5_bgp or 5_sbgp) and dedicated EIP pool.

publicip_pool_id

String

The ID of the network the public IP address belongs to. The value is the network ID returned by publicip_pool_name.

status

String

EIP status.

Range:

FREEZED: frozen

BIND_ERROR: failed to be bound.

BINDING: Binding

PENDING_DELETE: being released

PENDING_CREATE: being created

NOTIFYING: assigning

NOTIFY_DELETE: releasing

PENDING_UPDATE: Updating

DOWN: It has not been bound

ACTIVE: It has been bound.

ELB: It has been bound to an ELB load balancer.

VPN: It has been bound to a VPN.

ERROR: failed

description

String

EIP Information.

tags

Array of strings

Function description: user tag. (Not displayed by default)

type

String

EIP type.

Range:

EIP

DUALSTACK

DUALSTACK_SUBNET

vnic

HwcEipVnic object

Port information if the instance has an EIP bound.

bandwidth

HwcEipBandwidth object

Bandwidth bound to an EIP.

lock_status

String

Frozen status of an EIP.

Metadata type is required. The EIP can be frozen due to arrears or public security issues.

Range:

police

locked

associate_instance_type

String

Type of the instance the EIP is bound to.

Range:

PORT

NATGW

ELB

ELBV1

VPN

null

associate_instance_id

String

ID of the instance the EIP is bound to.

allow_share_bandwidth_types

Array of strings

Types of the shared bandwidth that an EIP can be added to. If this parameter is left blank, the EIP cannot be added to any shared bandwidth.

EIPs can be added only to the shared bandwidth of these types.

created_at

String

UTC time when the resource was created.

Format: yyyy-MM-ddTHH:mm:ssZ

updated_at

String

UTC time when the resource was updated.

Format: yyyy-MM-ddTHH:mm:ssZ

public_border_group

String

Whether the resource is in a central region or an edge site.

The value can be center or an edge site name.

Constraints: Only EIPs that are in the same region or site as this resource can be associated.

private_ip_address

String

Private IP address.

device_id

String

ID of the device that the port belongs to.

device_owner

String

Device where the vulnerability was found.

Value range: Valid devices.

network:dhcp

network:VIP_PORT

network:router_interface_distributed

network:router_centralized_snat

The system automatically sets this parameter.

vpc_id

String

VPC ID.

port_id

String

Port ID.

port_profile

String

Port profile.

mac

String

MAC address of the port.

vtep

String

VTEP IP

vni

String

VXLAN ID

instance_id

String

The ID of the instance that the port belongs to, for example, RDS instance ID.

instance_type

String

The type of instance the port belongs, for example, RDS.

id

String

Bandwidth ID.

size

Integer

Bandwidth size.

Value range: 5 Mbit/s to 2,000 Mbit/s by default.

share_type

String

Bandwidth type. The bandwidth can be shared or dedicated.

Range:

PER: dedicated bandwidth

WHOLE: shared bandwidth

IPv6 addresses do not support bandwidth whose type is WHOLE.

name

String

Bandwidth name.

id

String

Unique ID of the VPC.

name

String

VPC name.

description

String

VPC description.

protected_status

String

Whether CFW is enabled or the security group rule is configured. Value: OPEN or CLOSE.

cidr

String

Available subnets in the VPC.

Range:

10.0.0.0/8 to 10.255.255.240/28

172.16.0.0/12 to 172.31.255.240/28

192.168.0.0/16 to 192.168.255.240/28

If cidr is not specified, the default value is "".

Constraints: The value must be an IPv4 address in CIDR format, for example, 192.168.0.0/16.

extend_cidrs

Array of strings

Extended CIDR block of the VPC.

Constraints: Currently, only IPv4 CIDR blocks are supported.

status

String

VPC status.

Range:

• PENDING: creating

• ACTIVE: created

project_id

String

ID of the project to which the VPC belongs.

enterprise_project_id

String

ID of the enterprise project that the VPC belongs to.

Value range: 0 to 36 characters in UUID format, with hyphens (-) included. 0 indicates the default enterprise project.

created_at

String

Time when the VPC was created.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Time when the VPC was updated.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

cloud_resources

Array of HwcVpcCloudResource objects

Types and quantity of resources associated with the VPC.

Currently, only route tables and subnets of the VPC are returned. The number of virsubnet is the total number of IPv4 and IPv6 subnets.

tags

Array of Tag objects

VPC tags. For details, see the Tag object.

Value range: 0 to 10 tag key-value pairs.

resource_type

String

Resource type.

resource_count

Integer

Number of resources.

id

String

Unique ID of the security group.

name

String

Security group name.

description

String

Description of the security group.

project_id

String

ID of the project that the security group belongs to.

created_at

String

Time the security group was created.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Time the security group was updated.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

enterprise_project_id

String

ID of the enterprise project that the security group belongs to.

Value range: 0 to 36 characters in UUID format, with hyphens (-) included. 0 indicates the default enterprise project.

security_group_rules

Array of HwcSubnetSecurityGroupRule objects

Security group rules.

id

String

Unique ID of the security group rule.

Value range: standard UUID with hyphens (-).

description

String

Description of the security group rule.

security_group_id

String

The ID of the security group that contains the security rules.

direction

String

Security group rule direction.

Range:

• ingress: inbound direction

-egress: outbound direction

protocol

String

Protocol type.

Value range: icmp, tcp, udp, icmpv6, or an IP protocol number.

Constraint: If this parameter is left blank, all protocols are supported. If the protocol is icmpv6, the IP version must be IPv6. If the protocol is icmp, the IP version must be IPv4.

ethertype

String

IP address protocol type.

Value range: IPv4 and IPv6

Constraints : If this parameter is not specified, the value IPv4 will be used by default.

multiport

String

Port range.

Value range: The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22, 3389, 80).

action

String

Policy for a security group rule to take effect.

Range:

allow: The traffic is allowed.

deny: The traffic is denied.

Constraints : The default value is deny.

priority

Integer

Priority.

Value range:1 to 100. 1: the highest priority.

remote_group_id

String

ID of the remote security group.

Value range: ID of an existing security group.

Constraints: This parameter is mutually exclusive with remote_ip_prefix and remote_address_group_id.

remote_ip_prefix

String

Remote IP address.

When direction is set to egress, the value is the IP address of the resources VM accesses.

When direction is ingress, the value is the IP address of the device that accesses the VM.

Value range: IP address or CIDR block.

Constraints: This parameter is mutually exclusive with remote_group_id and remote_address_group_id.

remote_address_group_id

String

Remote address group ID.

Value range: ID of an existing IP address group.

Constraints: This parameter is mutually exclusive with remote_ip_prefix and remote_group_id.

created_at

String

Time when the security group rule was created.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Time when the security group rule was updated.

Value range: UTC time in the format of yyyy-MM-ddTHH:mm:ss.

project_id

String

ID of the project that the security group rule belongs to.

id

String

Instance ID.

name

String

Instance name.

protected_status

String

DBSS status. The value can be OPEN or CLOSE.

status

String

Instance status.

Value range:

BUILD: The instance is being created.

ACTIVE: The instance is running properly.

FAILED: The instance is abnormal.

FROZEN: The instance is frozen.

MODIFYING: The instance is being scaled up.

REBOOTING: The instance is being rebooted.

RESTORING: The instance is being restored.

MODIFYING INSTANCE TYPE: The instance is being changed to primary/standby.

SWITCHOVER: The instance is being switched over.

MIGRATING: The instance is being migrated.

BACKING UP: The instance is being backed up.

MODIFYING DATABASE PORT: The database port is being changed.

STORAGE FULL: The instance disk space is full.

alias

String

Remarks of the instance.

private_ips

Array of strings

Private IP addresses. An empty string is displayed if no ECSs have been created.

private_dns_names

Array of strings

Private domain names of the instance. After an instance is created, you need to manually apply for a private zone, or the private zone is left blank.

public_ips

Array of strings

Public IP addresses.

port

Integer

Database port number.

An RDS for MySQL instance can use ports 1024 to 65535, excluding 12017 and 33071, which are reserved for RDS system use.

An RDS for PostgreSQL database can use ports 2100 to 9500.

An RDS for SQL Server DB instance port is 1433 or any value from 2100 to 9500, excluding 5355 and 5985. For Microsoft SQL Server 2017 Enterprise, Standard, and Web editions, the database port cannot be 5050, 5353, or 5986.

If this parameter is not specified, the default port is as follows:

RDS for MySQL: 3306

RDS for PostgreSQL: 5432

RDS for SQL Server: 1433

enable_ssl

Boolean

Whether SSL is enabled.

true: SSL is enabled.

false: SSL is disabled.

type

String

Instance type. Single: a single DB instance. Ha: primary/standby DB instance. Replica: read-only replica. ** Enterprise**: distributed instance (enterprise edition).

ha

HwcRdsHa object

HA information. This parameter is returned only for HA instances.

region

String

Region where the instance is deployed.

datastore

HwcRdsDatastore object

Database information.

created

String

Creation time. The format is yyyy-mm-ddThh:mm:ssZ.

T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, "+0100" is displayed.

Note: This parameter is left blank when the instance is being created, but after the instance is created, this is a required field.

updated

String

Update time. The format is the same as that of the created field.

Note: This parameter is left blank when the instance is being created, but after the instance is created, this is a required field.

db_user_name

String

Default username.

vpc_id

String

VPC ID.

subnet_id

String

Subnet ID.

security_group_id

String

Security group ID.

flavor_ref

String

Specification code.

cpu

String

CPU size. For example, 1 indicates 1U.

mem

String

Memory size, in GB.

volume

HwcRdsVolume object

Volume information.

tags

Array of Tag objects

Tag list. If there is no tag in the list, an empty array is returned.

enterprise_project_id

String

Enterprise project ID.

project_id

String

Project ID.

switch_strategy

String

Database switchover policy. The value can be reliability or availability, indicating the reliability first and availability first, respectively.

read_only_by_user

Boolean

Whether the instance is set to read-only. This parameter is available only to RDS for MySQL.

true: The instance is set to read-only.

false: The instance is not set to read-only.

backup_strategy

HwcRdsBackupStrategy object

Backup policy.

maintenance_window

String

Maintenance window in the UTC format.

nodes

Array of HwcRdsNode objects

Primary/standby instance information.

related_instance

Array of HwcRdsRelatedInstance objects

All associated DB instances.

disk_encryption_id

String

Disk encryption key ID.

time_zone

String

Time zone.

backup_used_space

Double

Used backup space, in GB.

This field is returned only when you query information about a single RDS for SQL Server DB instance.

storage_used_space

Double

Used disk space, in GB.

This field is returned only when you query information about a single RDS for SQL Server DB instance.

associated_with_ddm

Boolean

Whether this instance is associated with a DDM instance.

max_iops

Long

Maximum IOPS of the instance disk.

This field is returned only for SQL Server DB instances.

expiration_time

String

Instance expiration time. The format is yyyy-mm-ddThh:mm:ssZ.

This field is returned only in yearly/monthly scenarios.

replication_mode

String

Replication mode for the standby instance.

The value cannot be left blank.

For RDS for MySQL, the value is async or semisync.

For RDS PostgreSQL instances, the value is async or sync.

For RDS for Microsoft SQL Server instances, the value is "sync".

Note:

async: the asynchronous replication mode.

semisync: the semi-synchronous replication mode.

sync: the synchronous replication.

type

String

DB engine. Its value is case-insensitive and can be:

MySQL

PostgreSQL

SQLServer

version

String

Database version.

complete_version

String

Complete database version number. This parameter is returned only when the database engine is PostgreSQL.

type

String

Disk type.

size

Integer

Disk size.

key

String

Key. The value can contain a maximum of 128 Unicode characters. The key cannot be empty. The system does not verify the character set of key when searching for resources. key cannot be empty, an empty string, or spaces. Before using key, delete single-byte character (SBC) spaces before and after the value.

values

Array of strings

List of tag values. Each value can contain a maximum of 255 Unicode characters. Before verifying and using values, delete SBC spaces before and after the value.

The value can be an empty array but cannot be left blank.

If values is left blank, it indicates any_value (querying any value). All values of a tag key are in the OR relationship.

start_time

String

Backup time window. Automated backups will be triggered during the backup time window.

The current time is the UTC time.

keep_days

Integer

Backup retention days.

Value range: 0 to 732. If the value is 0, the automated backup policy has not been configured or has been disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2,562 days.

id

String

Node ID.

name

String

Node name.

role

String

Node type. The value can be master, slave, or readreplica, indicating the primary node, standby node, and read replica node, respectively.

status

String

Node status.

availability_zone

String

AZ.

id

String

ID of the associated instance.

type

String

Type of the associated instance.

replica_of: the primary instance.

• replica: read replicas.

domain_name

String

Domain name.

expire_date

String

Domain name expiration time, for example, 2023-01-10.

status

String

DNS status.

audit_status

String

Domain name ownership validation status.

Range:

NONAUDIT: Ownership is not validated.

SUCCEED: Ownership is validated.

FAILED: Ownership validation failed.

AUDITING: The ownership validation request is being reviewed.

audit_unpass_reason

String

Causes of domain name ownership validation failure.

transfer_status

String

Ownership status.

reg_type

String

Registration type.

Range:

PERSONAL: individual

COMPANY: enterprise

privacy_protection

String

Whether to enable privacy protection.

name_server

Array of strings

DNS server list.

credential_type

String

Certificate type.

credential_id

String

Certificate No.

registrar

String

Domain name registrar.

contact

Array of HwcDomainContact objects

Contact information.

email

String

Email address.

register

String

Domain name owner.

contact_name

String

Contact person.

phone_num

String

Contact phone number.

province

String

Province.

city

String

City.

address

String

Address.

zip_code

String

Postal code.

value

String

Website URL.

main_domain

String

Primary domain name.

protected_status

String

WAF enabling status. The value can be OPEN or CLOSE.

is_public

Boolean

Public or private zone.

true: public zone.

false: private zone.

remark

String

Website remarks.

name_server

Array of strings

Website server list.

extend_propertites

WebsiteExtendProperties object

Other attributes.

mac_addr

String

MAC address.

value

String

Resource value.

version

String

Resource type:

IPv4 or IPv6.

network

OcaIpNetwork object

Network information.

remark

String

Resource remarks.

name

String

Resource name. The default value is the resource value.

relative_value

String

Opposite value. For example, if the IP address is an IPv4 address, the value is ipv6.

server_room

String

Equipment rooms.

server_rack

String

Cabinet.

data_center

OcaIpDataCenter object

Data center.

mac_addr

String

MAC address.

important

String

Importance level. 0: Unimportant. 1: Important.

extend_propertites

OcaIpExtendProperties object

Other third-party attributes.

is_public

Boolean

Public or private zone.

true: public zone.

false: private zone.

partition

String

Network zone. The value can be OM, PSZ, or DMZ.

plane

String

Network plane (special code for on-premises scenarios).

vxlan_id

String

Virtual network ID.

latitude

Float

Latitude.

longitude

Float

Longitude.

city_code

String

City code.

country_code

String

Country/Region code.

device

OcaIpDevice object

Device information.

system

OcaIpSystem object

System information.

services

Array of OcaIpService objects

Application information.

type

String

Device type.

model

String

Device model.

vendor

OcaIpVendor object

Device vendor.

family

String

System type.

name

String

System name.

version

String

System version.

vendor

OcaIpVendor object

System vendor.

port

Integer

Port of the application.

protocol

String

Protocol.

name

String

Application name.

version

String

Application version.

vendor

OcaIpVendor object

Application vendor.

name

String

Supplier name.

is_xc

Boolean

Whether the supplier is an in-house vendor.

200

Returned resource details.