查询实例列表 - ListPackage
功能介绍
查询实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见CNAD权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cnad:package:list
List
package *
-
-
-
URI
GET /v1/cnad/packages
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
是 |
String |
Content-Type |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
总数 |
|
items |
Array of PackageResponse objects |
数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
package_id |
String |
实例id |
|
package_name |
String |
实例名 |
|
region_id |
String |
资源所属region |
|
protection_type |
Integer |
防护类型 |
|
instance_type |
String |
实例类型。cnad_pro:全力防基础版;cnad_ip:标准版;cnad_full_high:全力防高级版;cnad_v2:原生防护2.0;cnad_vic:按需版 |
|
resourceId |
String |
资源id |
|
countDownCode |
String |
倒计时相关信息 |
|
countDownInfos |
String |
倒计时相关信息 |
|
countDownTips |
String |
倒计时相关信息 |
|
orderId |
String |
订单id |
|
subscriptionId |
String |
续费用的id |
|
ip_num |
Integer |
ip数 |
|
ip_num_now |
Integer |
当前IP数 |
|
protection_num_now |
Integer |
当前防护次数 |
|
protection_num |
Integer |
防护次数,9999为无限次 |
|
basic_bandwidth |
Integer |
保底带宽 |
|
elastic_bandwidth |
Integer |
弹性带宽 |
|
service_bandwidth |
Integer |
业务带宽 |
|
clean_bandwidth |
Integer |
回源带宽 |
|
policy_num |
Integer |
策略模板数 |
|
is_old |
Boolean |
是否旧实例(旧实例不支持升级规格),默认不传为否 |
|
new_flag |
Boolean |
产品标识,新购的均为true |
|
create_time |
Long |
创建时间 |
请求示例
无
响应示例
状态码:200
OK
{
"items" : [ {
"package_id" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
"package_name" : "name",
"region_id" : "cn-north4",
"protection_type" : 0,
"instance_type" : "cnad_pro",
"resourceId" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
"countDownCode" : "hws_countdown_period_using",
"countDownInfos" : {
"status" : 2,
"nextOperationPolicy" : 0,
"nextOperationRemainingDay" : 10
},
"countDownTips" : {
"effTime" : "2022-10-09T10:00:17Z",
"expTime" : "2022-12-09T15:59:59Z"
},
"orderId" : "CS2211020327RKFEA",
"subscriptionId" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
"ip_num" : 100,
"ip_num_now" : 100,
"protection_num_now" : 1,
"protection_num" : 9999,
"basic_bandwidth" : 10,
"elastic_bandwidth" : 200,
"service_bandwidth" : 100,
"clean_bandwidth" : 100,
"policy_num" : 1,
"is_old" : false,
"new_flag" : true,
"create_time" : 1665309611045
} ],
"total" : 1
}
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 |
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.v1.region.AadRegion; import com.huaweicloud.sdk.aad.v1.*; import com.huaweicloud.sdk.aad.v1.model.*; public class ListPackageSolution { 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(); ListPackageRequest request = new ListPackageRequest(); try { ListPackageResponse response = client.listPackage(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkaad.v1.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.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"] credentials = GlobalCredentials(ak, sk) client = AadClient.new_builder() \ .with_credentials(credentials) \ .with_region(AadRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPackageRequest() response = client.list_package(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aad.NewAadClient( aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPackageRequest{} response, err := client.ListPackage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见CNAD错误码。