Help Center/ Distributed Message Service for Kafka/ API Reference/ Out-of-Date APIs/ API V2/ Creating an Order to Disable Dumping Connectors for an Instance
Updated on 2024-03-18 GMT+08:00

Creating an Order to Disable Dumping Connectors for an Instance

Function

This API is used to create an order to disable dumping connectors for an instance.

This API is out-of-date and may not be maintained in the future. Please use the API described in Disabling Smart Connect (Pay-per-Use Instance).

Call Method

For details, see How to Call an API.

URI

POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connector-order

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Minimum length: 1

Maximum length: 100

instance_id

Yes

String

Instance ID.

Minimum length: 1

Maximum length: 100

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

ID of the instance whose connector you want to disable, which is the same as that in the request path.

url

No

String

Page displayed after the order for disabling connector is submitted.

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

order_id

String

Order ID generated by CBC.

Example Request

POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/delete-connector-order

{
  "instance_id" : "20c6b355-5d95-45ef-b476-e38bcccce0d7",
  "url" : "https://console.xxx.xxx.com/dms/?engine=all&region=xxx&locale=xxx#/queue/manager/newKafkaList"
}

Example Response

Status code: 200

An order created to disable dumping connectors for an instance

{
  "order_id" : "CS2304180947HLABU"
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class CreateDeleteConnectorOrderSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateDeleteConnectorOrderRequest request = new CreateDeleteConnectorOrderRequest();
        ConnectorOrderRequestBody body = new ConnectorOrderRequestBody();
        body.withUrl("https://console.xxx.xxx.com/dms/?engine=all&region=xxx&locale=xxx#/queue/manager/newKafkaList");
        body.withInstanceId("20c6b355-5d95-45ef-b476-e38bcccce0d7");
        request.withBody(body);
        try {
            CreateDeleteConnectorOrderResponse response = client.createDeleteConnectorOrder(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());
        }
    }
}
 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateDeleteConnectorOrderRequest()
        request.body = ConnectorOrderRequestBody(
            url="https://console.xxx.xxx.com/dms/?engine=all&region=xxx&locale=xxx#/queue/manager/newKafkaList",
            instance_id="20c6b355-5d95-45ef-b476-e38bcccce0d7"
        )
        response = client.create_delete_connector_order(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateDeleteConnectorOrderRequest{}
	urlConnectorOrderRequestBody:= "https://console.xxx.xxx.com/dms/?engine=all&region=xxx&locale=xxx#/queue/manager/newKafkaList"
	request.Body = &model.ConnectorOrderRequestBody{
		Url: &urlConnectorOrderRequestBody,
		InstanceId: "20c6b355-5d95-45ef-b476-e38bcccce0d7",
	}
	response, err := client.CreateDeleteConnectorOrder(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

Status Code

Status Code

Description

200

An order to disable dumping connectors for an instance is created.

Error Codes

See Error Codes.