更新API
功能介绍
更新API。
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/service/apis/{api_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
api_id |
是 |
String |
API 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。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
catalog_id |
否 |
String |
目录ID。 |
name |
否 |
String |
API名称。 |
description |
否 |
String |
API描述。 |
log_flag |
否 |
Boolean |
是否启用访问日志。 |
api_type |
否 |
String |
API类型。 枚举值:
|
auth_type |
否 |
String |
认证类型。 枚举值:
|
retention_period |
否 |
Integer |
最低保留期限,单位小时。 |
manager |
否 |
String |
API审核人。 |
path |
否 |
String |
API路径。 |
protocol |
否 |
String |
API请求协议类型。 枚举值:
|
request_type |
否 |
String |
请求类型。 枚举值:
|
tags |
否 |
Array of strings |
标签。 |
visibility |
否 |
String |
API可见性。 枚举值:
|
publish_type |
否 |
String |
发布类型(已弃用)。 枚举值:
|
data_mask_switch |
否 |
Boolean |
数据脱敏开关。 |
data_mask_paras |
否 |
Array of DataMaskParas objects |
数据脱敏配置。 |
body |
否 |
String |
请求体内容描述,仅注册类API使用。 |
datasource_config_list |
否 |
Array of DatasourceConfig objects |
多数据源配置信息,仅Groovy类API使用。 |
groovy_content |
否 |
String |
Groovy文本,仅Groovy类API使用。 |
request_paras |
否 |
Array of RequestPara objects |
API请求参数列表。 |
datasource_config |
否 |
DatasourceConfig object |
API数据源配置。 |
backend_config |
否 |
BackendConfig object |
API后端配置。仅注册类API使用 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
column_name |
否 |
String |
敏感字段。 |
algorithm_name |
否 |
String |
算法名称。 |
algorithm_type |
否 |
String |
算法类型。 |
en_name |
否 |
String |
算法名称。 |
algorithm_parameters |
否 |
String |
参数。 |
failure_policy |
否 |
String |
失败策略。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
数据源的类型。 枚举值:
|
connection_name |
否 |
String |
数据连接名称。 |
connection_id |
否 |
String |
数据连接ID。 |
database |
否 |
String |
数据库名。 |
datatable |
否 |
String |
数据表名称。 |
table_id |
否 |
String |
数据表ID。 |
queue |
否 |
String |
DLI的队列名称。 |
access_mode |
否 |
String |
获取数据的模式。 枚举值:
|
access_type |
否 |
String |
取数方式(已弃用)。 枚举值:
|
pagination |
否 |
String |
分页方式。 枚举值:
|
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。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数名。 |
position |
否 |
String |
参数的位置。 枚举值:
|
type |
否 |
String |
常量参数类型。 枚举值:
|
description |
否 |
String |
参数的描述。 |
necessary |
否 |
Boolean |
参数是否必填。 |
example_value |
否 |
String |
示例值。 |
default_value |
否 |
String |
默认值。 |
support_null |
否 |
Boolean |
支持NULL值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数名称。 |
mapping |
否 |
String |
映射字段。 |
condition |
否 |
String |
操作符。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数名。 |
field |
否 |
String |
绑定的表字段。 |
type |
否 |
String |
常量参数类型。 枚举值:
|
description |
否 |
String |
参数描述。 |
example_value |
否 |
String |
参数示例值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
排序参数名称。 |
field |
否 |
String |
对应的参数字段。 |
optional |
否 |
Boolean |
是否可选。 |
sort |
否 |
String |
排序方式。 枚举值:
|
order |
否 |
Integer |
排序参数顺序。 |
description |
否 |
String |
排序参数描述信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
请求类型。
|
protocol |
否 |
String |
API请求协议类型。
|
host |
否 |
String |
后端HOST。 |
timeout |
否 |
Integer |
后端超时时间。 |
path |
否 |
String |
后端请求PATH。 |
backend_paras |
否 |
Array of BackendRequestPara objects |
API后端参数。 |
constant_paras |
否 |
Array of BackendConstant objects |
后端常量参数。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
API请求参数名称。 |
position |
否 |
String |
参数的位置。 枚举值:
|
backend_para_name |
否 |
String |
对应的后端参数。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
常量参数名。 |
type |
否 |
String |
常量参数类型。 枚举值:
|
position |
否 |
String |
参数的位置。 枚举值:
|
description |
否 |
String |
常量参数描述。 |
value |
否 |
String |
常量参数值。 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
更新Id为10e3a4b67f59a9efe64e6bb31859221f的API信息。
/v1/0833a5737480d53b2f250010d01a7b88/service/apis/10e3a4b67f59a9efe64e6bb31859221f { "catalog_id" : "0", "name" : "creat_test0010001", "description" : "dws", "log_flag" : false, "auth_type" : "APP", "retention_period" : 0, "publish_type" : "PUBLISH_TYPE_PRIVATE", "manager" : "yangpeng", "path" : "/creat_test001/{p}", "api_type" : "API_SPECIFIC_TYPE_SCRIPT", "protocol" : "PROTOCOL_TYPE_HTTPS", "request_type" : "REQUEST_TYPE_GET", "request_paras" : [ { "name" : "p", "position" : "REQUEST_PARAMETER_POSITION_PATH", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "test", "necessary" : true, "example_value" : null, "support_null" : true, "default_value" : null } ], "datasource_config" : { "type" : "CLICKHOUSE", "connection_name" : "clickhouse_ywx1119238_safe", "connection_id" : "3d0d5941f2cb4ef08abecc01e33eabec", "database" : "system", "queue" : "dayu", "access_type" : "CONNECTION_TYPE_SCRIPT", "access_mode" : "SQL", "sql" : "c2VsZWN0IDEgYXMgbnVtOw==", "backend_paras" : [ ], "order_paras" : [ ], "pagination" : "DEFAULT" }, "visibility" : "WORKSPACE" }
响应示例
无
SDK代码示例
SDK代码示例如下。
更新Id为10e3a4b67f59a9efe64e6bb31859221f的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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
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 UpdateApiSolution { 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(); UpdateApiRequest request = new UpdateApiRequest(); request.withApiId("{api_id}"); Api body = new Api(); DatasourceConfig datasourceConfigbody = new DatasourceConfig(); datasourceConfigbody.withType(DatasourceConfig.TypeEnum.fromValue("CLICKHOUSE")) .withConnectionName("clickhouse_ywx1119238_safe") .withConnectionId("3d0d5941f2cb4ef08abecc01e33eabec") .withDatabase("system") .withQueue("dayu") .withAccessType(DatasourceConfig.AccessTypeEnum.fromValue("CONNECTION_TYPE_SCRIPT")) .withAccessMode(DatasourceConfig.AccessModeEnum.fromValue("SQL")) .withPagination(DatasourceConfig.PaginationEnum.fromValue("DEFAULT")) .withSql("c2VsZWN0IDEgYXMgbnVtOw=="); List<RequestPara> listbodyRequestParas = new ArrayList<>(); listbodyRequestParas.add( new RequestPara() .withName("p") .withPosition(RequestPara.PositionEnum.fromValue("REQUEST_PARAMETER_POSITION_PATH")) .withType(RequestPara.TypeEnum.fromValue("REQUEST_PARAMETER_TYPE_NUMBER")) .withDescription("test") .withNecessary(true) ); body.withDatasourceConfig(datasourceConfigbody); body.withRequestParas(listbodyRequestParas); body.withVisibility(Api.VisibilityEnum.fromValue("WORKSPACE")); body.withRequestType(Api.RequestTypeEnum.fromValue("REQUEST_TYPE_GET")); body.withProtocol(Api.ProtocolEnum.fromValue("PROTOCOL_TYPE_HTTPS")); body.withPath("/creat_test001/{p}"); body.withManager("yangpeng"); body.withPublishType(Api.PublishTypeEnum.fromValue("PUBLISH_TYPE_PRIVATE")); body.withAuthType(Api.AuthTypeEnum.fromValue("APP")); body.withApiType(Api.ApiTypeEnum.fromValue("API_SPECIFIC_TYPE_SCRIPT")); body.withLogFlag(false); body.withDescription("dws"); body.withName("creat_test0010001"); body.withCatalogId("0"); request.withBody(body); try { UpdateApiResponse response = client.updateApi(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()); } } } |
更新Id为10e3a4b67f59a9efe64e6bb31859221f的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 57 58 59 60 61 62 63 64 65 66 67 68 |
# 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 = UpdateApiRequest() request.api_id = "{api_id}" datasourceConfigbody = DatasourceConfig( type="CLICKHOUSE", connection_name="clickhouse_ywx1119238_safe", connection_id="3d0d5941f2cb4ef08abecc01e33eabec", database="system", queue="dayu", access_type="CONNECTION_TYPE_SCRIPT", access_mode="SQL", pagination="DEFAULT", sql="c2VsZWN0IDEgYXMgbnVtOw==" ) listRequestParasbody = [ RequestPara( name="p", position="REQUEST_PARAMETER_POSITION_PATH", type="REQUEST_PARAMETER_TYPE_NUMBER", description="test", necessary=True ) ] request.body = Api( datasource_config=datasourceConfigbody, request_paras=listRequestParasbody, visibility="WORKSPACE", request_type="REQUEST_TYPE_GET", protocol="PROTOCOL_TYPE_HTTPS", path="/creat_test001/{p}", manager="yangpeng", publish_type="PUBLISH_TYPE_PRIVATE", auth_type="APP", api_type="API_SPECIFIC_TYPE_SCRIPT", log_flag=False, description="dws", name="creat_test0010001", catalog_id="0" ) response = client.update_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) |
更新Id为10e3a4b67f59a9efe64e6bb31859221f的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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
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.UpdateApiRequest{} request.ApiId = "{api_id}" typeDatasourceConfig:= model.GetDatasourceConfigTypeEnum().CLICKHOUSE connectionNameDatasourceConfig:= "clickhouse_ywx1119238_safe" connectionIdDatasourceConfig:= "3d0d5941f2cb4ef08abecc01e33eabec" databaseDatasourceConfig:= "system" queueDatasourceConfig:= "dayu" accessTypeDatasourceConfig:= model.GetDatasourceConfigAccessTypeEnum().CONNECTION_TYPE_SCRIPT accessModeDatasourceConfig:= model.GetDatasourceConfigAccessModeEnum().SQL paginationDatasourceConfig:= model.GetDatasourceConfigPaginationEnum().DEFAULT sqlDatasourceConfig:= "c2VsZWN0IDEgYXMgbnVtOw==" datasourceConfigbody := &model.DatasourceConfig{ Type: &typeDatasourceConfig, ConnectionName: &connectionNameDatasourceConfig, ConnectionId: &connectionIdDatasourceConfig, Database: &databaseDatasourceConfig, Queue: &queueDatasourceConfig, AccessType: &accessTypeDatasourceConfig, AccessMode: &accessModeDatasourceConfig, Pagination: &paginationDatasourceConfig, Sql: &sqlDatasourceConfig, } nameRequestParas:= "p" positionRequestParas:= model.GetRequestParaPositionEnum().REQUEST_PARAMETER_POSITION_PATH typeRequestParas:= model.GetRequestParaTypeEnum().REQUEST_PARAMETER_TYPE_NUMBER descriptionRequestParas:= "test" necessaryRequestParas:= true var listRequestParasbody = []model.RequestPara{ { Name: &nameRequestParas, Position: &positionRequestParas, Type: &typeRequestParas, Description: &descriptionRequestParas, Necessary: &necessaryRequestParas, }, } visibilityApi:= model.GetApiVisibilityEnum().WORKSPACE requestTypeApi:= model.GetApiRequestTypeEnum().REQUEST_TYPE_GET protocolApi:= model.GetApiProtocolEnum().PROTOCOL_TYPE_HTTPS pathApi:= "/creat_test001/{p}" managerApi:= "yangpeng" publishTypeApi:= model.GetApiPublishTypeEnum().PUBLISH_TYPE_PRIVATE authTypeApi:= model.GetApiAuthTypeEnum().APP apiTypeApi:= model.GetApiApiTypeEnum().API_SPECIFIC_TYPE_SCRIPT logFlagApi:= false descriptionApi:= "dws" nameApi:= "creat_test0010001" catalogIdApi:= "0" request.Body = &model.Api{ DatasourceConfig: datasourceConfigbody, RequestParas: &listRequestParasbody, Visibility: &visibilityApi, RequestType: &requestTypeApi, Protocol: &protocolApi, Path: &pathApi, Manager: &managerApi, PublishType: &publishTypeApi, AuthType: &authTypeApi, ApiType: &apiTypeApi, LogFlag: &logFlagApi, Description: &descriptionApi, Name: &nameApi, CatalogId: &catalogIdApi, } response, err := client.UpdateApi(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
204 |
Success。 |
400 |
BadRequest。 |