Help Center/ DataArts Studio/ API Reference/ DataArts DataService APIs/ API Management/ Querying Instances for API Operations in DLM Exclusive
Updated on 2024-11-06 GMT+08:00

Querying Instances for API Operations in DLM Exclusive

Function

This API is used to query instances for API operations (Exclusive Edition).

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/service/apis/{api_id}/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

api_id

Yes

String

API ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

API operation

Enumerated values include:

  • PUBLISH: publishing an API

  • UNPUBLISH: unpublishing an API

  • STOP: stopping an API

  • RECOVER: recovering an API

  • WHITELIST: whitelist-related operations

  • **AUTHORIZE: authorization

show_all

No

Boolean

All instances (including instances on which the current operation cannot be performed) are displayed.

check_status

No

Boolean

Verify the API status.

check_debug

No

Boolean

API debugging status check

app_id

No

String

App ID, which is used to determine the optional instance of the authorized app

limit

No

Integer

Maximum number of records that can be queried

offset

No

Integer

Query offset, that is, X data records are skipped. The value must be 0 or an integer multiple of limit. If the value does not meet the requirements, it will be rounded down.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

Dlm-Type

No

String

Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.

Content-Type

Yes

String

Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instances

Array of InstanceForApiActionDTO objects

Indicates the instance list corresponding to the API operation.

Table 5 InstanceForApiActionDTO

Parameter

Type

Description

instance_id

String

Cluster ID

instance_type

String

Cluster type

Enumerated values:

  • DLM: DataArts DataService cluster

  • APIG: APIG cluster

  • APIGW: APIGW cluster

  • ROMA_APIC: ROMA cluster

name

String

Cluster name

action

String

API operation

Enumerated values:

  • PUBLISH: publishing an API

  • UNPUBLISH: unpublishing an API

  • STOP: stopping an API

  • RECOVER: recovering an API

  • WHITELIST: whitelist-related operations

  • **AUTHORIZE: authorization

result

Boolean

Indicates the verification result.

cause

String

Cause of the verification failure

Enumerated values:

  • API_STATUS_ERROR: API status error

  • API_DEBUG_ERROR: API debugging status error

  • TYPE_MISMATCH: The app type and instance type do not match.

api_status

String

API status (DataArts DataService Shared)

Enumerated values:

  • API_STATUS_CREATED: created

  • API_STATUS_PUBLISH_WAIT_REVIEW: waiting for review

  • API_STATUS_PUBLISH_REJECT: rejected

  • API_STATUS_PUBLISHED: published

  • API_STATUS_WAITING_STOP: waiting to be stopped

  • API_STATUS_STOPPED: stopped

  • API_STATUS_RECOVER_WAIT_REVIEW: waiting to be recovered

  • API_STATUS_WAITING_OFFLINE: waiting to be suspended

  • API_STATUS_OFFLINE: suspended

api_debug

String

API debugging status (DataArts DataService Shared)

Enumerated values:

  • API_DEBUG_WAITING: waiting to be debugged

  • API_DEBUG_FAILED: debugging failed

  • API_DEBUG_SUCCESS: debugging successful

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Query instances for API operations in DataArts DataService Exclusive.

/v1/0833a5737480d53b2f250010d01a7b88/service/apis/760715eb1bfce0c575abab3be3bd41e6/instances

Example Responses

Status code: 200

Success

{
  "instances" : [ {
    "instance_id" : "c2e27497562ed193583378e052248003",
    "instance_type" : "DLM",
    "name" : "cluster_test_001",
    "action" : "PUBLISH",
    "result" : false,
    "cause" : "API_STATUS_ERROR",
    "api_status" : "API_STATUS_CREATED",
    "api_debug" : "API_DEBUG_WAITING"
  } ]
}

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
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 ListInstanceListSolution {

    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();
        ListInstanceListRequest request = new ListInstanceListRequest();
        request.withApiId("{api_id}");
        try {
            ListInstanceListResponse response = client.listInstanceList(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
# 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 = ListInstanceListRequest()
        request.api_id = "{api_id}"
        response = client.list_instance_list(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
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.ListInstanceListRequest{}
	request.ApiId = "{api_id}"
	response, err := client.ListInstanceList(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Success

400

Bad request