文档首页/ DDoS防护 AAD/ API参考/ DDoS高防API/ DDoS高防-实例列表/ 查询实例详情 - ShowInstanceByInstanceId
更新时间:2025-12-02 GMT+08:00
分享

查询实例详情 - ShowInstanceByInstanceId

功能介绍

查询实例详情

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见AAD权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/aad/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

实例id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

token

Content-Type

String

Content-Type

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

instance_name

String

实例名称

enterprise_project_id

String

企业项目id

version

String

版本

expire_time

Integer

过期时间

create_time

Integer

创建时间

current_time

Integer

当前时间

product_spec_data

ProductSpecData object

产品规格数据

instance_config

InstanceConfig object

实例配置

elastic_service_bw_update_enable

Boolean

弹性业务带宽是否可更新

表4 ProductSpecData

参数

参数类型

描述

product_uuid

String

产品规格UUID

isp_spec

String

套餐线路

data_center

String

机房

spec_type

Integer

产品规格类型

basic_bandwidth

Integer

保底带宽值

elastic_bandwidth

Integer

弹性带宽值

service_bandwidth

Integer

业务带宽值

port_num

Integer

端口数

bind_domain_num

Integer

域名数

elastic_service_bandwidth

Integer

弹性业务带宽值

elastic_service_bandwidth_type

Integer

弹性业务带宽类型,0-关闭,3-月95

main_resource_type

String

主资源类型

main_resource_spec_code

String

主资源规格编码

main_resource_product_id

String

主资源产品id

表5 InstanceConfig

参数

参数类型

描述

tags

Array of strings

实例级别标签

freeze_type

Array of integers

冻结类型,1-公安冻结,3-欠费冻结

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

错误描述

请求示例

响应示例

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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.aad.v2.region.AadRegion;
import com.huaweicloud.sdk.aad.v2.*;
import com.huaweicloud.sdk.aad.v2.model.*;


public class ShowInstanceByInstanceIdSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        AadClient client = AadClient.newBuilder()
                .withCredential(auth)
                .withRegion(AadRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowInstanceByInstanceIdRequest request = new ShowInstanceByInstanceIdRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowInstanceByInstanceIdResponse response = client.showInstanceByInstanceId(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkaad.v2.region.aad_region import AadRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaad.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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = ShowInstanceByInstanceIdRequest()
        request.instance_id = "{instance_id}"
        response = client.show_instance_by_instance_id(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aad.NewAadClient(
        aad.AadClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowInstanceByInstanceIdRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowInstanceByInstanceId(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

Error response

相关文档