Debugging an API
Function
Debug the API.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/test
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
api_id |
Yes |
String |
API ID |
instance_id |
Yes |
String |
Cluster ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
Dlm-Type |
No |
String |
Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE. |
Content-Type |
Yes |
String |
Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
body |
No |
String |
Request body |
paras |
No |
ApiTestParas object |
Indicates the parameter. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
url |
String |
Request URL. |
result |
String |
Indicates the debugging result. |
timeout |
Long |
Indicates the debugging duration. |
success |
Boolean |
Indicates whether the debugging is successful. |
request_header |
ApiTestRequestHeader object |
Request header |
response_header |
ApiTestResponseHeader object |
Response header. |
Parameter |
Type |
Description |
---|---|---|
path |
String |
Request path |
user_agent |
String |
Proxy (fixed value). |
x_apig_mode |
String |
Request mode (fixed value). |
x_app_identity |
Integer |
Identification number (fixed value). |
Parameter |
Type |
Description |
---|---|---|
result_status |
String |
Whether the request is successful. |
content_length |
Integer |
Content size. |
connection |
String |
Connection status. |
cache_control |
String |
Cache control (fixed value). |
content_type |
String |
Content type (fixed value). |
date |
String |
Date. |
x_request_id |
String |
Request ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Debug an API.
/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances/51159105c7838353d2834181d978af50/test { "body" : "b", "paras" : { "page_size" : "10", "page_num" : "1" } }
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
Debug an 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()); } } } |
Debug an 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) |
Debug an 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Success |
400 |
Bad request |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot