# 查询API信息 - ShowApi #### 功能介绍 查询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/{api_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | api_id | 是 | String | API ID。 | #### 请求参数 表2请求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。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | API的ID。 | | name | String | API名称。 | | group_id | String | API所属分组的ID（共享版）。 | | description | String | API描述。 | | protocol | String | API请求协议类型。 枚举值： - PROTOCOL_TYPE_HTTP：HTTP协议请求 - PROTOCOL_TYPE_HTTPS：HTTPS协议请求 | | publish_type | String | 发布类型(已弃用)。 枚举值： - PUBLISH_TYPE_PUBLIC：公开 - PUBLISH_TYPE_PRIVATE：私有 | | log_flag | Boolean | 是否开启日志记录。 | | path | String | API的访问路径。 | | host | String | 共享版域名。 | | hosts | [InstanceHostDTO] object | 专享版域名。 | | request_type | String | 请求类型。 枚举值： - REQUEST_TYPE_POST：POST请求 - REQUEST_TYPE_GET：GET请求 | | create_user | String | API创建者。 | | create_time | Long | 创建时间。 | | update_time | Long | 更新时间。 | | manager | 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：下线待审核状态 | | type | String | API类型。 枚举值： - API_SPECIFIC_TYPE_CONFIGURATION: 配置类API - API_SPECIFIC_TYPE_SCRIPT: 脚本类API - API_SPECIFIC_TYPE_REGISTER：注册类API | | debug_status | String | API调试状态（共享版）。 枚举值： - API_DEBUG_WAITING：等待调试 - API_DEBUG_FAILED：调试失败 - API_DEBUG_SUCCESS：调试成功 | | publish_messages | Array of [ApiPublishDTO] objects | 发布信息列表（专享版）。 | | request_paras | Array of [RequestPara] objects | API请求参数。 | | datasource_config | [DatasourceConfig] object | 数据源配置。 | | backend_config | [BackendConfig] object | 后端配置。 | 表4InstanceHostDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | 集群ID编号。 | | instance_name | String | 集群名。 | | intranet_host | String | 内网地址。 | | external_host | String | 外网地址。 | | domains | Array of strings | 网关域名。 | 表5ApiPublishDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：调试成功 | 表6RequestPara | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名。 | | position | String | 参数的位置。 枚举值： - REQUEST_PARAMETER_POSITION_PATH：请求PATH内参数 - REQUEST_PARAMETER_POSITION_HEADER：请求HEADER内参数 - REQUEST_PARAMETER_POSITION_QUERY：请求QUERY参数 - REQUEST_PARAMETER_POSITION_BODY：请求BODY参数 - REQUEST_PARAMETER_POSITION_STATIC：静态参数 | | type | String | 常量参数类型。 枚举值： - REQUEST_PARAMETER_TYPE_NUMBER：数值类型 - REQUEST_PARAMETER_TYPE_STRING：字符串类型 | | description | String | 参数的描述。 | | necessary | Boolean | 参数是否必填。 | | example_value | String | 示例值。 | | default_value | String | 默认值。 | | support_null | Boolean | 支持NULL值。 | | verification_type | String | 校验类型。 枚举值： - REQUEST_PARAMETER_VERIFICATION_NUMERIC_RANGE：数值范围 - REQUEST_PARAMETER_VERIFICATION_LENGTH_RANGE：长度范围 - REQUEST_PARAMETER_VERIFICATION_ENUM：枚举 - REQUEST_PARAMETER_VERIFICATION_REGULAR_EXPRESSION：正则表达式 | | verification_expression | String | 校验规则。 | 表7DatasourceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 数据源的类型。 枚举值： - MYSQL：MYSQL数据源 - DLI：DLI数据源 - DWS：DWS数据源 - HIVE：HIVE数据源 - HBASE：HBASE数据源 | | connection_name | String | 数据连接名称。 | | connection_id | String | 数据连接ID。 | | database | String | 数据库名。 | | datatable | String | 数据表名称。 | | table_id | String | 数据表ID。 | | queue | String | DLI的队列名称。 | | access_mode | String | 获取数据的模式。 枚举值： - SQL：SQL取数方式 - ROW_KEY：ROW_KEY取数方式 仅适用于HBASE - PREFIX_FILTER：PREFIX_FILTER取数方式仅适用于HBASE | | access_type | String | 取数方式(已弃用)。 枚举值： - SCRIPT：脚本方式 - CONFIGURATION：配置方式 | | pagination | String | 分页方式。 枚举值： - DEFAULT：默认分页 - CUSTOM：自定义分页 | | sql | String | 脚本模式下的SQL语句。 | | backend_paras | Array of [ApiRequestPara] objects | API后端参数。 | | response_paras | Array of [ApiResponsePara] objects | 配置类API返回参数。 | | order_paras | Array of [DatasourceOrderPara] objects | 排序参数。 | | total_size_sql | String | 总条数计算脚本SQL。 | 表8ApiRequestPara | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名称。 | | mapping | String | 映射字段。 | | condition | String | 操作符。 枚举值： - CONDITION_TYPE_EQ：等于 - CONDITION_TYPE_NE：不等于 - CONDITION_TYPE_GT：大于 - CONDITION_TYPE_GE：大于等于 - CONDITION_TYPE_LT：小于 - CONDITION_TYPE_LE：小于等于 - CONDITION_TYPE_LIKE：模糊查询如:%like% - CONDITION_TYPE_LIKE_L：模糊查询如:%like - CONDITION_TYPE_LIKE_R：模糊查询如:like% | 表9ApiResponsePara | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 参数名。 | | field | String | 绑定的表字段。 | | type | String | 常量参数类型。 枚举值： - REQUEST_PARAMETER_TYPE_NUMBER：数值类型 - REQUEST_PARAMETER_TYPE_STRING：字符串类型 | | description | String | 参数描述。 | | example_value | String | 参数示例值。 | 表10DatasourceOrderPara | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 排序参数名称。 | | field | String | 对应的参数字段。 | | optional | Boolean | 是否可选。 | | sort | String | 排序方式。 枚举值： - ASC: 升序 - DESC: 降序 - CUSTOM: 自定义 | | order | Integer | 排序参数顺序。 | | description | String | 排序参数描述信息。 | 表11BackendConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 请求类型。 - REQUEST_TYPE_POST：POST请求 - REQUEST_TYPE_GET：GET请求 | | protocol | String | API请求协议类型。 - PROTOCOL_TYPE_HTTP：HTTP协议请求 - PROTOCOL_TYPE_HTTPS：HTTPS协议请求 | | host | String | 后端HOST。 | | timeout | Integer | 后端超时时间。 | | path | String | 后端请求PATH。 | | backend_paras | Array of [BackendRequestPara] objects | API后端参数。 | | constant_paras | Array of [BackendConstant] objects | 后端常量参数。 | 表12BackendRequestPara | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | API请求参数名称。 | | position | String | 参数的位置。 枚举值： - REQUEST_PARAMETER_POSITION_PATH：请求PATH内参数 - REQUEST_PARAMETER_POSITION_HEADER：请求HEADER内参数 - REQUEST_PARAMETER_POSITION_QUERY：请求QUERY参数 | | backend_para_name | String | 对应的后端参数。 | 表13BackendConstant | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 常量参数名。 | | type | String | 常量参数类型。 枚举值： - REQUEST_PARAMETER_TYPE_NUMBER：数值类型 - REQUEST_PARAMETER_TYPE_STRING：字符串类型 | | position | String | 参数的位置。 枚举值： - REQUEST_PARAMETER_POSITION_PATH：请求PATH内参数 - REQUEST_PARAMETER_POSITION_HEADER：请求HEADER内参数 - REQUEST_PARAMETER_POSITION_QUERY：请求QUERY参数 | | description | String | 常量参数描述。 | | value | String | 常量参数值。 | **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查询Id为10e3a4b67f59a9efe64e6bb31859221f的API信息。 ``` /v1/0833a5737480d53b2f250010d01a7b88/service/apis/10e3a4b67f59a9efe64e6bb31859221f ``` #### 响应示例 **状态码：200** Success。 ``` { "id" : "6b9e682fd6d0ef7c0f674701adb20762", "name" : "testApi", "group_id" : "677942eeca42b85d82fcef909d8345f4", "description" : "", "protocol" : "PROTOCOL_TYPE_HTTP", "publish_type" : "PUBLISH_TYPE_PUBLIC", "log_flag" : true, "path" : "/testApi/{a}", "host" : null, "hosts" : null, "request_type" : "REQUEST_TYPE_POST", "create_time" : 1579162215000, "update_time" : 1579162691000, "manager" : "admin", "status" : "API_STATUS_CREATED", "type" : "API_SPECIFIC_TYPE_CONFIGURATION", "debug_status" : "API_DEBUG_WAITING", "request_paras" : [ { "name" : "a", "position" : "REQUEST_PARAMETER_POSITION_PATH", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" }, { "name" : "b", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" }, { "name" : "c", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" } ], "datasource_config" : null, "backend_config" : { "type" : "REQUEST_TYPE_GET", "protocol" : "PROTOCOL_TYPE_HTTP", "timeout" : "100", "host" : "www.baidu.com", "path" : "/testApi/{d}/{g}", "backend_paras" : [ { "name" : "a", "position" : "REQUEST_PARAMETER_POSITION_PATH", "backend_para_name" : "d" }, { "name" : "b", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "backend_para_name" : "e" }, { "name" : "c", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "backend_para_name" : "f" } ], "constant_paras" : [ { "name" : "g", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_PATH", "description" : "", "value" : "1" }, { "name" : "h", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "description" : "", "value" : "1" }, { "name" : "j", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "description" : "", "value" : "1" } ] } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowApiSolution { 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(); ShowApiRequest request = new ShowApiRequest(); request.withApiId("{api_id}"); try { ShowApiResponse response = client.showApi(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] ``` # 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 = ShowApiRequest() request.api_id = "{api_id}" response = client.show_api(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] ``` 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.ShowApiRequest{} request.ApiId = "{api_id}" response, err := client.ShowApi(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=ShowApi)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success。 | | 400 | BadRequest。 |