更新时间:2024-11-22 GMT+08:00

发布API

功能介绍

发布API。API只有发布后,才能够被调用。API发布时,可以将API发送至指定网关。

  • 共享版,必须发送至API网关共享版。

  • 专享版,可以依据自身需要,选择将API发送至API网关专享版、ROMA-APIC、或不发布网关。

发布请求的发起者若非审核人,需要API的审核人完成申请的审核。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/publish

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

api_id

String

API编号。

instance_id

String

集群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参数

参数

是否必选

参数类型

描述

apig_type

String

网关类型。

枚举值:

  • APIG:APIG类型网关

  • APIGW:APIGW类型网关

  • ROMA_APIC:ROMA类型网关

apig_instance_id

String

网关实例id。

group_id_in_apig

String

网关分组id。

roma_app_id

String

roma网关集成应用id。

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

发布ID为760715eb1bfce0c575abab3be3bd41e6的API到集群。

/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances/21398ikjdsjd9087122d4e/publish

{
  "apig_type" : "APIG",
  "apig_instance_id" : "APIG",
  "group_id_in_apig" : "c4ba07ad2ae14015921c36aa4136e14c"
}

响应示例

SDK代码示例

SDK代码示例如下。

发布ID为760715eb1bfce0c575abab3be3bd41e6的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
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 PublishApiToInstanceSolution {

    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();
        PublishApiToInstanceRequest request = new PublishApiToInstanceRequest();
        request.withApiId("{api_id}");
        request.withInstanceId("{instance_id}");
        GatewayDTO body = new GatewayDTO();
        body.withGroupIdInApig("c4ba07ad2ae14015921c36aa4136e14c");
        body.withApigInstanceId("APIG");
        body.withApigType(GatewayDTO.ApigTypeEnum.fromValue("APIG"));
        request.withBody(body);
        try {
            PublishApiToInstanceResponse response = client.publishApiToInstance(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为760715eb1bfce0c575abab3be3bd41e6的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
# 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 = PublishApiToInstanceRequest()
        request.api_id = "{api_id}"
        request.instance_id = "{instance_id}"
        request.body = GatewayDTO(
            group_id_in_apig="c4ba07ad2ae14015921c36aa4136e14c",
            apig_instance_id="APIG",
            apig_type="APIG"
        )
        response = client.publish_api_to_instance(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为760715eb1bfce0c575abab3be3bd41e6的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
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.PublishApiToInstanceRequest{}
	request.ApiId = "{api_id}"
	request.InstanceId = "{instance_id}"
	groupIdInApigGatewayDto:= "c4ba07ad2ae14015921c36aa4136e14c"
	apigInstanceIdGatewayDto:= "APIG"
	apigTypeGatewayDto:= model.GetGatewayDtoApigTypeEnum().APIG
	request.Body = &model.GatewayDto{
		GroupIdInApig: &groupIdInApigGatewayDto,
		ApigInstanceId: &apigInstanceIdGatewayDto,
		ApigType: &apigTypeGatewayDto,
	}
	response, err := client.PublishApiToInstance(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

操作API成功。

400

BadRequest。