查询审计实例列表
功能介绍
查询审计实例列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/dbss/audit/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
String |
偏移量 |
limit |
否 |
String |
查询记录数 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
servers |
Array of AuditInstanceListBean objects |
实例信息列表 |
total |
Integer |
总数 |
参数 |
参数类型 |
描述 |
---|---|---|
charge_model |
String |
付费模式 Period:包周期 Demand:按需。 |
comment |
String |
备注信息。 |
config_num |
Integer |
配置的数据库总数。 |
connect_ip |
String |
连接地址。 |
connect_ipv6 |
String |
ipv6连接地址。 |
cpu |
Integer |
CPU个数 |
created |
String |
创建时间 |
database_limit |
Integer |
支持的数据库总数 |
effect |
Integer |
1.冻结可释放 2.冻结不可释放 3.冻结后不可续费 |
expired |
String |
过期时间 |
id |
String |
ID |
keep_days |
String |
剩余天数 |
name |
String |
实例别名 |
new_version |
String |
如果有返回,则需要升级,如果没有,则为null |
port_id |
String |
绑定弹性IP的portID |
ram |
Integer |
内存 |
region |
String |
实例所在region |
remain_days |
String |
到期天数 |
resource_id |
String |
资源ID |
resource_spec_code |
String |
实例的规格 |
scene |
String |
场景 |
security_group_id |
String |
安全组 |
specification |
String |
实例规格 |
status |
String |
实例状态: SHUTOFF(已关闭) ACTIVE(运行中,允许任何操作) DELETING(删除中,不允许任何操作) BUILD(创建中,不允许任何操作) DELETED(已删除,不需要展示) ERROR(故障,只允许删除) HAWAIT(等待备机创建成功,不允许任何操作) FROZEN(已冻结,只允许续费、绑定/解绑) UPGRADING(升级中,不允许升级操作) |
subnet_id |
String |
子网ID |
task |
String |
任务状态: powering-on(正在开启,实例可以绑定、解绑) powering-off(正在关闭,实例可以绑定、解绑) rebooting(正在重启,实例可以绑定、解绑) delete_wait(等待删除,集群与实例不允许任何操作) NO_TASK(不展示) |
version |
String |
实例的当前版本 |
vpc_id |
String |
虚拟私有云 |
zone |
String |
可用区 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 |
error_msg |
String |
错误请求返回的错误信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 |
error_msg |
String |
错误请求返回的错误信息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error |
Object |
错误信息返回体。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误请求返回的错误码。 |
error_msg |
String |
错误请求返回的错误信息。 |
请求示例
/v1/{project_id}/dbss/audit/instances
响应示例
状态码: 200
成功
{ "servers" : [ { "name" : "DBSS-Test", "comment" : "", "connect_ipv6" : null, "status" : "ACTIVE", "task" : "NO_TASK", "id" : "8c53ed03-8ed7-4ff2-ad97-7b2d6d1dd364", "specification" : "Low | 3 Proxy", "zone" : "cn-cmcc1a-01", "created" : "2021-04-21 04:37:54", "expired" : null, "subnet_id" : "97ef0bb5-3759-4db4-aa49-0d087ed49ce5", "cpu" : 4, "ram" : 16384, "region" : "cn-cmcc1", "version" : "21.04.16.164614", "charge_model" : "Demand", "remain_days" : null, "config_num" : 1, "effect" : null, "scene" : null, "connect_ip" : "192.168.0.229", "port_id" : "dc4bd420-e01c-4d12-a7ff-814f17c63079", "resource_id" : "062212d8-8e30-4783-9671-43f3f1f3bb1e", "vpc_id" : "76d98391-5abc-46ed-b8a8-f664202cb166", "security_group_id" : "f0fbec06-bcf6-4c7e-99fa-f0ddfbb1d9bd", "resource_spec_code" : "dbss.bypassaudit.low", "keep_days" : null, "new_version" : null, "database_limit" : 3 } ], "total" : 1 }
状态码: 400
失败
{ "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" } }
SDK代码示例
SDK代码示例如下。
Java
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 |
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.dbss.v1.region.DbssRegion; import com.huaweicloud.sdk.dbss.v1.*; import com.huaweicloud.sdk.dbss.v1.model.*; public class ListAuditInstancesSolution { 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); DbssClient client = DbssClient.newBuilder() .withCredential(auth) .withRegion(DbssRegion.valueOf("cn-north-4")) .build(); ListAuditInstancesRequest request = new ListAuditInstancesRequest(); request.withOffset("<offset>"); request.withLimit("<limit>"); try { ListAuditInstancesResponse response = client.listAuditInstances(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()); } } } |
Python
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 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdbss.v1.region.dbss_region import DbssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdbss.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.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DbssClient.new_builder() \ .with_credentials(credentials) \ .with_region(DbssRegion.value_of("cn-north-4")) \ .build() try: request = ListAuditInstancesRequest() request.offset = "<offset>" request.limit = "<limit>" response = client.list_audit_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dbss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dbss.NewDbssClient( dbss.DbssClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) request := &model.ListAuditInstancesRequest{} offsetRequest:= "<offset>" request.Offset = &offsetRequest limitRequest:= "<limit>" request.Limit = &limitRequest response, err := client.ListAuditInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功 |
400 |
失败 |
403 |
认证失败 |
500 |
服务端错误 |
错误码
请参见错误码。