全量导出包含API的EXCEL压缩文件
功能介绍
全量导出包含API的EXCEL压缩文件。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/service/export/zip
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号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。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
API名称,该参数为模糊匹配。 |
create_user |
否 |
String |
API创建人名称。 |
description |
否 |
String |
API描述。 |
tags |
否 |
Array of strings |
API标签列表。 |
table_name |
否 |
String |
API所使用到的数据库表名。 |
publish_status_type |
否 |
String |
API发布状态。 枚举值:
|
api_specific_type_str |
否 |
String |
API取数方式。 枚举值:
|
start_time |
否 |
String |
API创建开始时间。 |
end_time |
否 |
String |
API创建结束时间。 |
authorization_status_type |
否 |
String |
授权状态。 枚举值:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
- |
File |
导出包含API的EXCEL文件,会导出多个EXCEL文件,每个EXCEL文件最多200个API,多个EXCEL文件会打包到ZIP文件返回。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
全量导出包含API的EXCEL压缩文件。
/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" ] }
响应示例
状态码: 200
全量导出成功。
"xxx.zip"
SDK代码示例
SDK代码示例如下。
全量导出包含API的EXCEL压缩文件。
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()); } } } |
全量导出包含API的EXCEL压缩文件。
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) |
全量导出包含API的EXCEL压缩文件。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
全量导出成功。 |
400 |
BadRequest。 |