计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
态势感知 SA
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

更新API

功能介绍

更新API。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/service/apis/{api_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

api_id

String

API ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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。

表3 请求Body参数

参数

是否必选

参数类型

描述

catalog_id

String

目录ID。

name

String

API名称。

description

String

API描述。

log_flag

Boolean

是否启用访问日志。

api_type

String

API类型。

枚举值:

  • API_SPECIFIC_TYPE_CONFIGURATION: 配置类API

  • API_SPECIFIC_TYPE_SCRIPT: 脚本类API

  • API_SPECIFIC_TYPE_MYBATIS: MyBatis类API

  • API_SPECIFIC_TYPE_GROOVY: Groovy类API

  • API_SPECIFIC_TYPE_REGISTER:注册类API

  • API_SPECIFIC_TYPE_ORCHESTRATE:编排类API

  • API_TYPE_CREATE:创建类API(已弃用)

  • API_TYPE_REGISTER:注册类API(已弃用)

auth_type

String

认证类型。

枚举值:

  • APP: app secret认证

  • IAM: IAM token认证

  • NONE: 无认证

retention_period

Integer

最低保留期限,单位小时。

manager

String

API审核人。

path

String

API路径。

protocol

String

API请求协议类型。

枚举值:

  • PROTOCOL_TYPE_HTTP:HTTP协议请求

  • PROTOCOL_TYPE_HTTPS:HTTPS协议请求

request_type

String

请求类型。

枚举值:

  • REQUEST_TYPE_POST:POST请求

  • REQUEST_TYPE_GET:GET请求

tags

Array of strings

标签。

visibility

String

API可见性。

枚举值:

  • WORKSPACE: 工作空间可见

  • PROJECT: 项目可见

  • DOMAIN: 租户可见

publish_type

String

发布类型(已弃用)。

枚举值:

  • PUBLISH_TYPE_PUBLIC:公开

  • PUBLISH_TYPE_PRIVATE:私有

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使用

表4 DataMaskParas

参数

是否必选

参数类型

描述

column_name

String

敏感字段。

algorithm_name

String

算法名称。

algorithm_type

String

算法类型。

en_name

String

算法名称。

algorithm_parameters

String

参数。

failure_policy

String

失败策略。

枚举值:

  • SKIP:跳过, 即不做处理

  • INTERRUPT_AND_EXCEPTION:中断并抛出异常

  • SET_NULL:置空

  • DEFAULT_VALUE:默认值

表5 DatasourceConfig

参数

是否必选

参数类型

描述

type

String

数据源的类型。

枚举值:

  • MYSQL:MYSQL数据源

  • DLI:DLI数据源

  • DWS:DWS数据源

  • HIVE:HIVE数据源

  • HBASE:HBASE数据源

connection_name

String

数据连接名称。

connection_id

String

数据连接ID。

database

String

数据库名。

datatable

String

数据表名称。

table_id

String

数据表ID。

queue

String

DLI的队列名称。

access_mode

String

获取数据的模式。

枚举值:

  • SQL:SQL取数方式

  • ROW_KEY:ROW_KEY取数方式 仅适用于HBASE

  • PREFIX_FILTER:PREFIX_FILTER取数方式仅适用于HBASE

access_type

String

取数方式(已弃用)。

枚举值:

  • SCRIPT:脚本方式

  • CONFIGURAITON:配置方式

pagination

String

分页方式。

枚举值:

  • DEFAULT:默认分页

  • CUSTOM:自定义分页

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。

表6 RequestPara

参数

是否必选

参数类型

描述

name

String

参数名。

position

String

参数的位置。

枚举值:

  • REQUEST_PARAMETER_POSITION_PATH:请求PATH内参数

  • REQUEST_PARAMETER_POSITION_HEADER:请求HEADER内参数

  • REQUEST_PARAMETER_POSITION_QUERY:请求QUERY参数

type

String

常量参数类型。

枚举值:

  • REQUEST_PARAMETER_TYPE_NUMBER:数值类型

  • REQUEST_PARAMETER_TYPE_STRING:字符串类型

description

String

参数的描述。

necessary

Boolean

参数是否必填。

example_value

String

示例值。

default_value

String

默认值。

support_null

Boolean

支持NULL值。

表7 ApiRequestPara

参数

是否必选

参数类型

描述

name

String

参数名称。

mapping

String

映射字段。

condition

String

操作符。

枚举值:

  • CONDITION_TYPE_EQ:等于

  • CONDITION_TYPE_NE:不等于

  • CONDITION_TYPE_GT:大于

  • CONDITION_TYPE_GE:大于等于

  • CONDITION_TYPE_LT:小于

  • CONDITION_TYPE_LE:小于等于

  • CONDITION_TYPE_LIKE:模糊查询如:%like%

  • CONDITION_TYPE_LIKE_L:模糊查询如:%like

  • CONDITION_TYPE_LIKE_R:模糊查询如:like%

表8 ApiResponsePara

参数

是否必选

参数类型

描述

name

String

参数名。

field

String

绑定的表字段。

type

String

常量参数类型。

枚举值:

  • REQUEST_PARAMETER_TYPE_NUMBER:数值类型

  • REQUEST_PARAMETER_TYPE_STRING:字符串类型

description

String

参数描述。

example_value

String

参数示例值。

表9 DatasourceOrderPara

参数

是否必选

参数类型

描述

name

String

排序参数名称。

field

String

对应的参数字段。

optional

Boolean

是否可选。

sort

String

排序方式。

枚举值:

  • ASC: 升序

  • DESC: 降序

  • CUSTOM: 自定义

order

Integer

排序参数顺序。

description

String

排序参数描述信息。

表10 BackendConfig

参数

是否必选

参数类型

描述

type

String

请求类型。

  • REQUEST_TYPE_POST:POST请求

  • REQUEST_TYPE_GET:GET请求

protocol

String

API请求协议类型。

  • PROTOCOL_TYPE_HTTP:HTTP协议请求

  • PROTOCOL_TYPE_HTTPS:HTTPS协议请求

host

String

后端HOST。

timeout

Integer

后端超时时间。

path

String

后端请求PATH。

backend_paras

Array of BackendRequestPara objects

API后端参数。

constant_paras

Array of BackendConstant objects

后端常量参数。

表11 BackendRequestPara

参数

是否必选

参数类型

描述

name

String

API请求参数名称。

position

String

参数的位置。

枚举值:

  • REQUEST_PARAMETER_POSITION_PATH:请求PATH内参数

  • REQUEST_PARAMETER_POSITION_HEADER:请求HEADER内参数

  • REQUEST_PARAMETER_POSITION_QUERY:请求QUERY参数

backend_para_name

String

对应的后端参数。

表12 BackendConstant

参数

是否必选

参数类型

描述

name

String

常量参数名。

type

String

常量参数类型。

枚举值:

  • REQUEST_PARAMETER_TYPE_NUMBER:数值类型

  • REQUEST_PARAMETER_TYPE_STRING:字符串类型

position

String

参数的位置。

枚举值:

  • REQUEST_PARAMETER_POSITION_PATH:请求PATH内参数

  • REQUEST_PARAMETER_POSITION_HEADER:请求HEADER内参数

  • REQUEST_PARAMETER_POSITION_QUERY:请求QUERY参数

description

String

常量参数描述。

value

String

常量参数值。

响应参数

状态码: 400

表13 响应Body参数

参数

参数类型

描述

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" : "user",
  "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("user");
        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="user",
            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:= "user"
	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代码示例。

更新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("user");
        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="user",
            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:= "user"
	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。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容