Help Center/Host Security Service/API Reference/API Description/Asset Management/Querying the Website Information of a Server
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Website Information of a Server

Function

This API is used to query the website information of a server.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/asset/{host_id}/web-site

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

host_id

Yes

String

Definition

Server ID.

Constraints

N/A

Range

The value can contain 1 to 64 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

category

Yes

String

Definition

Asset Type

Constraints

N/A

Range

  • host: server asset

  • container: container asset

Default Value

host

domain

No

String

Definition

Domain name.

Constraints

N/A

Range

Length: 1 to 256 characters

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number.

Range

Minimum value: 0; maximum value: 2147483647

data_list

Array of WebSiteInfo objects

Definition

Website list

Range

Minimum value: 0; maximum value: 10000

Table 5 WebSiteInfo

Parameter

Type

Description

domain

String

Definition

Domain name

Range

Length: 1 to 256 characters

app_name

String

Definition

Software name

Range

Length: 1 to 256 characters

path

String

Definition

Web directory path

Range

Length: 1 to 512 characters

port

Integer

Definition

External port of the website

Range

Minimum value: 0; maximum value: 2147483647

bind_addr

String

Definition

IP address bound to the website

Range

Length: 1 to 512 characters

url_path

String

Definition

Website URL

Range

Length: 1 to 128 characters

uid

Integer

Definition

UID of the website process.

Range

Minimum value: 0; maximum value: 2147483647

gid

Integer

Definition

GID of the web site process.

Range

Minimum value: 0; maximum value: 2147483647

mode

String

Definition

Website file permission

Range

Length: 1 to 32 characters

pid

Integer

Definition

Website process PID

Range

Minimum value: 0; maximum value: 2147483647

proc_path

String

Definition

Website process path

Range

Length: 1 to 1024 characters

is_https

Boolean

Definition

Whether the website uses HTTPS.

Range

  • true: yes.

  • false: no.

cert_issuer

String

Definition

SSL certificate issuer of the website

Range

Length: 0 to 256 characters

cert_user

String

Definition

User of the SSL certificate of the website

Range

Length: 0 to 256 characters

cert_issue_time

String

Definition

Time when the SSL certificate of the website is issued

Range

Length: 0 to 32 characters

cert_expired_time

String

Definition

Expiration date of the SSL certificate of the website.

Range

Length: 0 to 32 characters

record_time

Long

Definition

Web framework scan time

Range

Minimum value: 0; maximum value: 2^63-1

container_id

String

Definition

Container ID

Range

Length: 1 to 128 characters

container_name

String

Definition

Container name

Range

Length: 1 to 256 characters

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "tomcat",
    "bind_addr" : "0.0.0.0",
    "domain" : "localhost",
    "gid" : 0,
    "is_https" : false,
    "mode" : "drwxr-x---",
    "path" : "/usr/local/tomcat/tomcat-9.0.95-1/webapps",
    "pid" : 4155229,
    "port" : 8080,
    "proc_path" : "/opt/jdk1.8.0_421/bin/java",
    "record_time" : 1758241341934,
    "uid" : 0
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Asset Management