# 查询API列表 - ListApis #### 功能介绍 查询API列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/service/apis 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 查询起始坐标, 即跳过前X条数据。仅支持0或limit的整数倍，不满足则向下取整。 | | limit | 否 | Integer | 查询条数限制。 | | name | 否 | String | 根据API名称模糊查询。 | | description | 否 | String | 根据API描述信息模糊查询。 | | create_user | 否 | String | 根据API创建用户模糊查询。 | | start_time | 否 | String | 根据API创建时间过滤，开始时间，格式遵循RFC3339,精确到秒，UTC时区，如2024-02-24T16:00:00.000Z。 | | end_time | 否 | String | 根据API创建时间过滤，结束时间，格式遵循RFC3339,精确到秒，UTC时区，如2024-04-05T15:59:59.998Z。 | | tags | 否 | Array of strings | 标签。 | | api_type | 否 | String | API类型。 枚举值： - API_SPECIFIC_TYPE_CONFIGURATION: 配置类API - API_SPECIFIC_TYPE_SCRIPT: 脚本类API - API_SPECIFIC_TYPE_MYBATIS: MyBatis类API - API_SPECIFIC_TYPE_GROOVY: Groovy类API - API_SPECIFIC_TYPE_REGISTER：注册类API - API_SPECIFIC_TYPE_ORCHESTRATE：编排类API | | publish_status | 否 | String | API发布状态。 枚举值： - PUBLISHED：已发布 - NOT_PUBLISHED：未发布 | | table_name | 否 | String | 根据API用到的数据库表名模糊查询。 | | authorization_status | 否 | String | 授权状态。 枚举值： - NO_AUTHORIZATION_REQUIRED: 无需授权 - UNAUTHORIZED: 未授权 - AUTHORIZED: 已授权 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，使用[Token认证](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)时必选。通过调用IAM服务的"获取用户Token"接口获取响应消息头中X-Subject-Token的值。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | Dlm-Type | 否 | String | 数据服务的版本类型，指定SHARED共享版或EXCLUSIVE专享版。 | | Content-Type | 是 | String | 消息体的类型（格式），有Body体的情况下必选，没有Body体无需填写。如果请求消息体中含有中文字符，则需要通过charset=utf8指定中文字符集，例如取值为：application/json;charset=utf8。 | | x-return-publish-messages | 否 | String | 是否返回专享版API的发布信息。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | API总数量。 | | records | Array of [ApiOverview] objects | API列表。 | 表5ApiOverview | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | API ID。 | | name | String | API名称。 | | group_id | String | API分组ID（共享版）。 | | description | String | API描述。 | | status | String | API的状态（共享版）。 枚举值： - API_STATUS_CREATED：API创建状态 - API_STATUS_PUBLISH_WAIT_REVIEW：发布审核状态 - API_STATUS_PUBLISH_REJECT：驳回状态 - API_STATUS_PUBLISHED：已发布状态 - API_STATUS_WAITING_STOP：停用审核状态 - API_STATUS_STOPPED：已停用状态 - API_STATUS_RECOVER_WAIT_REVIEW：恢复审核状态 - API_STATUS_WAITING_OFFLINE：下线审核状态 - API_STATUS_OFFLINE：已下线 - API_STATUS_OFFLINE_WAIT_REVIEW：下线待审核状态 | | debug_status | String | API调试状态（共享版）。 枚举值： - API_DEBUG_WAITING：等待调试 - API_DEBUG_FAILED：调试失败 - API_DEBUG_SUCCESS：调试成功 | | publish_messages | Array of [ApiPublishDTO] objects | 发布信息列表（专享版）。 | | type | String | API类型。 枚举值： - API_SPECIFIC_TYPE_CONFIGURATION: 配置类API - API_SPECIFIC_TYPE_SCRIPT: 脚本类API - API_SPECIFIC_TYPE_REGISTER：注册类API | | manager | String | API审核人。 | | create_user | String | API创建者。 | | create_time | Long | API创建时间。 | | authorization_status | String | 授权状态。 枚举值： - NO_AUTHORIZATION_REQUIRED: 无需授权 - UNAUTHORIZED: 未授权 - AUTHORIZED: 已授权 | 表6ApiPublishDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 发布编号。 | | api_id | String | API编号。 | | instance_id | String | 集群ID编号。 | | instance_name | String | 集群名称。 | | api_status | String | API的状态。 枚举值： - API_STATUS_CREATED：API创建状态 - API_STATUS_PUBLISH_WAIT_REVIEW：发布审核状态 - API_STATUS_PUBLISH_REJECT：驳回状态 - API_STATUS_PUBLISHED：已发布状态 - API_STATUS_WAITING_STOP：停用审核状态 - API_STATUS_STOPPED：已停用状态 - API_STATUS_RECOVER_WAIT_REVIEW：恢复审核状态 - API_STATUS_WAITING_OFFLINE：下线审核状态 - API_STATUS_OFFLINE：已下线 | | api_debug | String | API调试状态。 枚举值： - API_DEBUG_WAITING：等待调试 - API_DEBUG_FAILED：调试失败 - API_DEBUG_SUCCESS：调试成功 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查询ADMIN创建的已发布的脚本类API信息。 ``` /v1/0833a5737480d53b2f250010d01a7b88/service/apis?api_type=API_SPECIFIC_TYPE_SCRIPT&publish_status=PUBLISHED&create_user=admin&description=测试 { "api_type" : "API_SPECIFIC_TYPE_SCRIPT", "publish_status" : "PUBLISHED", "create_user" : "admin", "description" : "测试" } ``` #### 响应示例 **状态码：200** Success。 ``` { "total" : 1, "records" : [ { "id" : "27f451f07a2de703e79298e1d5d6ffbe", "name" : "test", "create_time" : 1742956118000, "create_user" : "test_name", "manager" : "test_name", "type" : "API_SPECIFIC_TYPE_CONFIGURATION", "description" : "", "group_id" : null, "status" : "API_STATUS_PUBLISHED", "debug_status" : null, "publish_messages" : null, "authorization_status" : "NO_AUTHORIZATION_REQUIRED" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询ADMIN创建的已发布的脚本类API信息。 ``` 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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListApisSolution { 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); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("")) .build(); ListApisRequest request = new ListApisRequest(); try { ListApisResponse response = client.listApis(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()); } } } ``` - [Python] 查询ADMIN创建的已发布的脚本类API信息。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 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 = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("")) \ .build() try: request = ListApisRequest() response = client.list_apis(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 查询ADMIN创建的已发布的脚本类API信息。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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 := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ListApisRequest{} response, err := client.ListApis(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ListApis)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success。 | | 400 | BadRequest。 |