Exporting a .zip File Containing All APIs
Function
This API is used to export a .zip file that contains all APIs.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/service/export/zip
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. |
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 |
---|---|---|---|
name |
No |
String |
API name. This parameter supports fuzzy match. |
create_user |
No |
String |
Name of the API creator. |
description |
No |
String |
API description, |
tags |
No |
Array of strings |
API tag list |
table_name |
No |
String |
Name of the database table used by the API. |
publish_status_type |
No |
String |
API publishing status Enumerated values include:
|
api_specific_type_str |
No |
String |
API data obtaining mode Enumerated values:
|
start_time |
No |
String |
Time when the API starts to be created. |
end_time |
No |
String |
Time when the API creation ends. |
authorization_status_type |
No |
String |
Authorization status. Enumerated values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
- |
File |
A .zip file that contains multiple Excel files is exported. Each Excel file contains a maximum of 200 APIs. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Export a .zip file that contains all APIs.
/v1/0833a5737480d53b2f250010d01a7b88/service/export/zip { "name" : "name", "create_user" : "dev", "api_specific_type_str" : "API_SPECIFIC_TYPE_CONFIGURATION", "start_time" : "2024-02-29T16:00:00.000Z", "end_time" : "2024-07-02T15:59:59.998Z", "tags" : [ "111", "22", "33" ] }
Example Responses
Status code: 200
The .zip file that contains all APIs is exported.
"xxx.zip"
SDK Sample Code
The SDK sample code is as follows.
Export a .zip file that contains all APIs.
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 57 58 59 60 61 |
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.*; import java.util.List; import java.util.ArrayList; public class ExportDataServiceZipSolution { 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(); ExportDataServiceZipRequest request = new ExportDataServiceZipRequest(); ApiParam body = new ApiParam(); List<String> listbodyTags = new ArrayList<>(); listbodyTags.add("111"); listbodyTags.add("22"); listbodyTags.add("33"); body.withEndTime("2024-07-02T15:59:59.998Z"); body.withStartTime("2024-02-29T16:00:00.000Z"); body.withApiSpecificTypeStr(ApiParam.ApiSpecificTypeStrEnum.fromValue("API_SPECIFIC_TYPE_CONFIGURATION")); body.withTags(listbodyTags); body.withCreateUser("dev"); body.withName("name"); request.withBody(body); try { ExportDataServiceZipResponse response = client.exportDataServiceZip(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()); } } } |
Export a .zip file that contains all APIs.
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 |
# 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 = ExportDataServiceZipRequest() listTagsbody = [ "111", "22", "33" ] request.body = ApiParam( end_time="2024-07-02T15:59:59.998Z", start_time="2024-02-29T16:00:00.000Z", api_specific_type_str="API_SPECIFIC_TYPE_CONFIGURATION", tags=listTagsbody, create_user="dev", name="name" ) response = client.export_data_service_zip(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Export a .zip file that contains all APIs.
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 |
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.ExportDataServiceZipRequest{} var listTagsbody = []string{ "111", "22", "33", } endTimeApiParam:= "2024-07-02T15:59:59.998Z" startTimeApiParam:= "2024-02-29T16:00:00.000Z" apiSpecificTypeStrApiParam:= model.GetApiParamApiSpecificTypeStrEnum().API_SPECIFIC_TYPE_CONFIGURATION createUserApiParam:= "dev" nameApiParam:= "name" request.Body = &model.ApiParam{ EndTime: &endTimeApiParam, StartTime: &startTimeApiParam, ApiSpecificTypeStr: &apiSpecificTypeStrApiParam, Tags: &listTagsbody, CreateUser: &createUserApiParam, Name: &nameApiParam, } response, err := client.ExportDataServiceZip(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 |
The .zip file that contains all APIs is exported. |
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