Viewing AI Component Details

Function

This API is used to query details about an AI component.

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/ai-component/detail

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
category	Yes	String	Definition Asset Type Constraints N/A Range host: server asset container: container asset Default Value host
catalogue	Yes	String	Definition AI component type. Constraints N/A Range app: application tool: tool Default Value N/A
server_name	No	String	Definition If category is set to host, the value indicates the server name. If category is set to container, the value indicates the node name. If category is set to serverless, the value indicates the instance name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
server_ip	No	String	Definition If category is set to host, the value indicates the server IP address. If category is set to container, the value indicates the node IP address. If category is set to serverless, the value indicates the instance IP address. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
ai_application	No	String	Definition AI application name. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
host_id	No	String	Definition Server ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
ai_tool	No	String	Definition AI tool name Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
type	No	String	Definition AI application type Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A
version	No	String	Definition AI version. Constraints N/A Range The value can contain 0 to 32 characters. Default Value N/A
installation_path	No	String	Definition Installation path. Constraints N/A Range The value can contain 0 to 512 characters. Default Value N/A
first_scan_time	No	Long	Definition First scan time, in milliseconds. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
latest_scan_time	No	Long	Definition Latest scan time, in ms Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A
container_name	No	String	Definition Container name Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
container_id	No	String	Definition Container ID Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
image_name	No	String	Definition Image name. Constraints N/A Range The value can contain 0 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 of AI component details.
data_list	Array of AIDetailInfoResponseInfo objects	Definition AI component list

**Table 5** AIDetailInfoResponseInfo
Parameter	Type	Description
server_name	String	Definition If category is set to host, the value indicates the server name. If category is set to container, the value indicates the node name. If category is set to serverless, the value indicates the instance name. Range The value can contain 1 to 256 characters.
server_ip	String	Definition If category is set to host, the value indicates the server IP address. If category is set to container, the value indicates the node IP address. If category is set to serverless, the value indicates the instance IP address. Range The value can contain 1 to 128 characters.
ai_application	String	Definition AI application name. Range The value can contain 1 to 256 characters.
ai_tool	String	Definition AI tool name Range The value can contain 1 to 256 characters.
type	String	Definition AI application type Range The value can contain 1 to 256 characters.
version	String	Definition Version Range The value can contain 1 to 64 characters.
startup_path	String	Definition Specifies the application startup path. Range The value can contain 1 to 512 characters.
startup_time	Long	Definition Application startup time Range Timestamp (millisecond)
install_path	String	Definition Installation path. Range The value can contain 1 to 512 characters.
cmdline	String	Definition Application startup command line Range The value can contain 1 to 512 characters.
first_scan_time	Long	Definition First scan time. Range Timestamp (millisecond)
latest_scan_time	Long	Definition Time of the last scan. Range Timestamp (millisecond)
container_name	String	Definition Container name Range The value can contain 1 to 256 characters.
container_id	String	Definition Container ID Range The value can contain 1 to 128 characters.
host_id	String	Definition Server ID, which is used to view server details. Range The value can contain 1 to 128 characters.
pid	Integer	Definition PID Range The value range is 0 to 2,147,483,647.
ppid	Integer	Definition PID of the parent process of the application process Range The value range is 0 to 2,147,483,647.
user	String	Definition User who runs the application Range The value can contain 1 to 128 characters.
net_info	Array of AIProcessNetInfo objects	Definition Network information listened by the application process.

**Table 6** AIProcessNetInfo
Parameter	Type	Description
listen_ip	String	Definition IP address listened by the application process. Range The value range is 0 to 2,147,483,647.
listen_protocol	String	Definition Network protocol listened by the application process. Range tcp: TCP protocol udp: UDP protocol
listen_port	Long	Definition Port listened by the application process. Range The value range is 0 to 2,147,483,647.
listen_status	String	Definition Listening status of the application process. Range established: The connection has been established. closed: The connection has been closed. listening: The connection is being listened. other: The connection is in the intermediate state.

Example Requests

By default, query the first 10 AI components whose category is host and directory is tool.

GET https://{endpoint}/v5/{project_id}/asset/ai-component/detail?limit=10&offset=0&category=host&catalogue=app&name=pytorch

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "server_name" : "ecs_test"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: asset

Previous topic: asset

Next topic: Querying AI Component Statistics

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot