AI组件详细信息 - ListAiComponentDetail
功能介绍
查询AI组件详细信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/asset/ai-component/detail
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
| category | 是 | String | 参数解释: 资产类别 约束限制: 不涉及 取值范围: 默认取值: host |
| catalogue | 是 | String | 参数解释: AI组件类别 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| server_name | 否 | String | 参数解释: category==host时 表示服务器名称 category==container时 表示节点名称 category==serverless时 表示实例名称 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
| server_ip | 否 | String | 参数解释: category==host时 表示服务器IP地址 category==container时 表示节点IP地址 category==serverless时 表示实例IP地址 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
| ai_application | 否 | String | 参数解释: AI应用名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
| host_id | 否 | String | 参数解释: 服务器ID 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
| ai_tool | 否 | String | 参数解释: AI工具名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
| type | 否 | String | 参数解释: AI应用类型 约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
| version | 否 | String | 参数解释: AI版本 约束限制: 不涉及 取值范围: 字符长度0-32位 默认取值: 不涉及 |
| installation_path | 否 | String | 参数解释: 安装路径 约束限制: 不涉及 取值范围: 字符长度0-512位 默认取值: 不涉及 |
| first_scan_time | 否 | Long | 参数解释: 首次扫描时间,时间单位毫秒(ms) 约束限制: 不涉及 取值范围: 取值0-9223372036854775807 默认取值: 不涉及 |
| latest_scan_time | 否 | Long | 参数解释: 最近扫描时间,时间单位毫秒(ms) 约束限制: 不涉及 取值范围: 取值0-9223372036854775807 默认取值: 不涉及 |
| container_name | 否 | String | 参数解释: 容器名称 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
| container_id | 否 | String | 参数解释: 容器ID 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
| image_name | 否 | String | 参数解释: 镜像名称 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Integer | 参数解释: AI组件详情列表总数 |
| data_list | Array of AIDetailInfoResponseInfo objects | 参数解释: AI组件列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| server_name | String | 参数解释: category==host时 表示服务器名称 category==container时 表示节点名称 category==serverless时 表示实例名称 取值范围: 字符长度1-256位 |
| server_ip | String | 参数解释: category==host时 表示服务器IP地址 category==container时 表示节点IP地址 category==serverless时 表示实例IP地址 取值范围: 字符长度1-128位 |
| ai_application | String | 参数解释: AI应用名称 取值范围: 字符长度1-256位 |
| ai_tool | String | 参数解释: AI工具名称 取值范围: 字符长度1-256位 |
| type | String | 参数解释: AI应用类型 取值范围: 字符长度1-256位 |
| version | String | 参数解释: 版本号 取值范围: 字符长度1-64位 |
| startup_path | String | 参数解释: 应用启动路径 取值范围: 字符长度1-512位 |
| startup_time | Long | 参数解释: 应用启动时间 取值范围: 时间戳,毫秒级 |
| install_path | String | 参数解释: 安装路径 取值范围: 字符长度1-512位 |
| cmdline | String | 参数解释: 应用启动命令行 取值范围: 字符长度1-512位 |
| first_scan_time | Long | 参数解释: 首次扫描时间 取值范围: 时间戳,毫秒级 |
| latest_scan_time | Long | 参数解释: 最近一次扫描时间 取值范围: 时间戳,毫秒级 |
| container_name | String | 参数解释: 容器名称 取值范围: 字符长度1-256位 |
| container_id | String | 参数解释: 容器ID 取值范围: 字符长度1-128位 |
| host_id | String | 参数解释: 服务器ID,查看服务器详情使用 取值范围: 字符长度1-128位 |
| pid | Integer | 参数解释: 应用进程PID 取值范围: 取值0-2147483647 |
| ppid | Integer | 参数解释: 应用进程的父进程PID 取值范围: 取值0-2147483647 |
| user | String | 参数解释: 应用运行用户 取值范围: 字符长度1-128位 |
| net_info | Array of AIProcessNetInfo objects | 参数解释: 应用进程监听网络信息 |
请求示例
默认查询前10条类别为主机,目录为工具的AI组件统计信息列表
GET https://{endpoint}/v5/{project_id}/asset/ai-component/detail?limit=10&offset=0&category=host&catalogue=app&name=pytorch 响应示例
状态码:200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"server_name" : "ecs_test"
} ]
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListAiComponentDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListAiComponentDetailRequest request = new ListAiComponentDetailRequest(); try { ListAiComponentDetailResponse response = client.listAiComponentDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAiComponentDetailRequest() response = client.list_ai_component_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListAiComponentDetailRequest{} response, err := client.ListAiComponentDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。