文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据服务API/ API管理接口/ 查看API不同操作对应的实例信息(专享版)
更新时间:2024-11-22 GMT+08:00

查看API不同操作对应的实例信息(专享版)

功能介绍

查看API不同操作对应的实例信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

api_id

String

API编号。

表2 Query参数

参数

是否必选

参数类型

描述

action

String

API操作。

枚举值:

  • PUBLISH:发布API

  • UNPUBLISH:取消发布API

  • STOP:停用API

  • RECOVER:恢复API

  • WHITELIST:白名单操作

  • AUTHORIZE:授权操作

show_all

Boolean

全部展示(包括不可执行当前操作的实例)。

check_status

Boolean

校验api状态。

check_debug

Boolean

校验API调试状态。

app_id

String

APP编号(用于判断授权操作app可选的实例)。

limit

Integer

查询条数限制。

offset

Integer

查询起始坐标, 即跳过前X条数据。仅支持0或LIMIT的整数倍,不满足则向下取整。

请求参数

表3 请求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。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of InstanceForApiActionDTO objects

api操作对应的实例列表。

表5 InstanceForApiActionDTO

参数

参数类型

描述

instance_id

String

集群ID编号。

instance_type

String

集群类型。

枚举值:

  • DLM:数据服务集群

  • APIG:APIG类型集群

  • APIGW:APIGW类型集群

  • ROMA_APIC:ROMA类型集群

name

String

集群名称。

action

String

API操作。

枚举值:

  • PUBLISH:发布API

  • UNPUBLISH:取消发布API

  • STOP:停用API

  • RECOVER:恢复API

  • WHITELIST:白名单操作

  • AUTHORIZE:授权操作

result

Boolean

校验结果。

cause

String

校验失败的原因。

枚举值:

  • API_STATUS_ERROR:API状态错误

  • API_DEBUG_ERROR:API调试状态错误

  • TYPE_MISMATCH:APP与实例类型不匹配

api_status

String

API状态。

枚举值:

  • API_STATUS_CREATED:API创建状态

  • API_STATUS_PUBLISH_WAIT_REVIEW:发布审核状态

  • API_STATUS_PUBLISH_REJECT:驳回状态

  • API_STATUS_PUBLISHED:已发布状态

  • API_STATUS_WAITING_STOP:停用审核状态

  • API_STATUS_STOPPED:已停用状态

  • API_STATUS_RECOVER_WAIT_REVIEW:恢复审核状态

  • API_STATUS_WAITING_OFFLINE:下线审核状态

  • API_STATUS_OFFLINE:已下线

api_debug

String

API调试状态。

枚举值:

  • API_DEBUG_WAITING:等待调试

  • API_DEBUG_FAILED:调试失败

  • API_DEBUG_SUCCESS:调试成功

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查看API不同操作对应的实例信息(专享版)。

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

响应示例

状态码: 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代码示例

SDK代码示例如下。

 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)
    }
}

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

状态码

状态码

描述

200

Success。

400

BadRequest。