调试API
功能介绍
调试API。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/test
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
api_id |
是 |
String |
API编号。 |
instance_id |
是 |
String |
集群ID编号。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
Dlm-Type |
否 |
String |
数据服务的版本类型,指定SHARED共享版或EXCLUSIVE专享版。 |
Content-Type |
是 |
String |
消息体的类型(格式),有Body体的情况下必选,没有Body体无需填写。如果请求消息体中含有中文字符,则需要通过charset=utf8指定中文字符集,例如取值为:application/json;charset=utf8。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
body |
否 |
String |
请求体。 |
paras |
否 |
ApiTestParas object |
参数。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求编号。 |
url |
String |
请求url。 |
result |
String |
调试结果。 |
timeout |
Long |
调试耗时。 |
success |
Boolean |
是否调试成功。 |
request_header |
ApiTestRequestHeader object |
请求头。 |
response_header |
ApiTestResponseHeader object |
响应头。 |
参数 |
参数类型 |
描述 |
---|---|---|
path |
String |
请求路径。 |
user_agent |
String |
代理(固定值)。 |
x_apig_mode |
String |
请求方式(固定值)。 |
x_app_identity |
Integer |
识别编号(固定值)。 |
参数 |
参数类型 |
描述 |
---|---|---|
result_status |
String |
是否成功。 |
content_length |
Integer |
内容大小。 |
connection |
String |
连接状态。 |
cache_control |
String |
缓存控制(固定值)。 |
content_type |
String |
内容类型 (固定值)。 |
date |
String |
日期。 |
x_request_id |
String |
请求ID。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
调试API。
/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances/51159105c7838353d2834181d978af50/test { "body" : "b", "paras" : { "page_size" : "10", "page_num" : "1" } }
响应示例
状态码: 200
Success。
{ "request_header" : { "path" : "GET /testApi/1 HTTP", "user_agent" : "DLMDebugClient/1.0", "x_apig_mode" : "DEBUG", "x_app_identity" : 1 }, "request_id" : "704742365000242752", "response_header" : { "cache_control" : "private", "connection" : "keep-alive", "content_length" : 2, "content_type" : "application/json;charset=UTF-8", "date" : "Tue Apr 28 17:14:37 GMT+08:00 2020", "result_status" : "HTTP 200 Success", "x_request_id" : "704742365000242752" }, "result" : "[]", "success" : true, "timeout" : 3826, "url" : "/testApi/1" }
SDK代码示例
SDK代码示例如下。
调试API。
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 50 51 52 53 54 55 56 |
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 DebugApiSolution { 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("<YOUR REGION>")) .build(); DebugApiRequest request = new DebugApiRequest(); request.withApiId("{api_id}"); request.withInstanceId("{instance_id}"); ApiTestDTO body = new ApiTestDTO(); ApiTestParas parasbody = new ApiTestParas(); parasbody.withPageSize("10") .withPageNum("1"); body.withParas(parasbody); body.withBody("b"); request.withBody(body); try { DebugApiResponse response = client.debugApi(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()); } } } |
调试API。
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 |
# 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("<YOUR REGION>")) \ .build() try: request = DebugApiRequest() request.api_id = "{api_id}" request.instance_id = "{instance_id}" parasbody = ApiTestParas( page_size="10", page_num="1" ) request.body = ApiTestDTO( paras=parasbody, body="b" ) response = client.debug_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) |
调试API。
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 50 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.DebugApiRequest{} request.ApiId = "{api_id}" request.InstanceId = "{instance_id}" pageSizeParas:= "10" pageNumParas:= "1" parasbody := &model.ApiTestParas{ PageSize: &pageSizeParas, PageNum: &pageNumParas, } bodyApiTestDto:= "b" request.Body = &model.ApiTestDto{ Paras: parasbody, Body: &bodyApiTestDto, } response, err := client.DebugApi(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success。 |
400 |
BadRequest。 |