资源预校验
功能介绍
资源预校验。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/resource-check
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
Content-Type |
是 |
String |
内容类型。 取值:application/json。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
是 |
String |
校验类型。
|
resource |
是 |
CheckResourceInfo object |
资源信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID。action为createInstance时必填。 |
instance_num |
否 |
Integer |
实例数量。action为createInstance时必填。 |
mode |
否 |
String |
实例类型,目前仅支持Cluster。action为createInstance时必填。 |
availability_zone_mode |
否 |
String |
可用区类型,单可用区single或多可用区multi。action为createInstance时必填。 |
node_num |
否 |
Integer |
节点数量。action为createInstance、createReadonlyNode时必填。 |
flavor_ref |
否 |
String |
规格码。action为createInstance、resizeFlavor时必填。 |
availability_zone |
否 |
String |
可用区码。 |
subnet_id |
否 |
String |
子网ID。action为createInstance时必填。 |
instance_id |
否 |
String |
实例ID。action为createReadonlyNode、resizeFlavor时必填。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Boolean |
结果。
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
-
创建实例资源预校验。
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "createInstance", "resource" : { "enterprise_project_id" : 0, "instance_num" : 1, "mode" : "Cluster", "availability_zone_mode" : "single", "node_num" : 2, "flavor_ref" : "gaussdb.mysql.xlarge.x86.4", "availability_zone" : "cn-southwest-244b", "subnet_id" : "1e9f71dd-9192-4c0d-9739-161d8dcca68c" } }
-
添加只读资源预校验。
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "createReadonlyNode", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "node_num" : 1 } }
-
规格变更资源预校验。
POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check { "action" : "resizeFlavor", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "flavor_ref" : "gaussdb.mysql.xlarge.x86.4" } }
响应示例
状态码: 200
Success.
{ "result" : true }
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 49 50 51 52 53 54 55 56 57 58 59 60
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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CheckResourceSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); CheckResourceRequest request = new CheckResourceRequest(); CheckResourceRequestBody body = new CheckResourceRequestBody(); CheckResourceInfo resourcebody = new CheckResourceInfo(); resourcebody.withEnterpriseProjectId("0") .withInstanceNum(1) .withMode("Cluster") .withAvailabilityZoneMode("single") .withNodeNum(2) .withFlavorRef("gaussdb.mysql.xlarge.x86.4") .withAvailabilityZone("cn-southwest-244b") .withSubnetId("1e9f71dd-9192-4c0d-9739-161d8dcca68c"); body.withResource(resourcebody); body.withAction("createInstance"); request.withBody(body); try { CheckResourceResponse response = client.checkResource(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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CheckResourceSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); CheckResourceRequest request = new CheckResourceRequest(); CheckResourceRequestBody body = new CheckResourceRequestBody(); CheckResourceInfo resourcebody = new CheckResourceInfo(); resourcebody.withNodeNum(1) .withInstanceId("376e0847a2224e95afcd3e607eccd544in07"); body.withResource(resourcebody); body.withAction("createReadonlyNode"); request.withBody(body); try { CheckResourceResponse response = client.checkResource(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 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CheckResourceSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); CheckResourceRequest request = new CheckResourceRequest(); CheckResourceRequestBody body = new CheckResourceRequestBody(); CheckResourceInfo resourcebody = new CheckResourceInfo(); resourcebody.withFlavorRef("gaussdb.mysql.xlarge.x86.4") .withInstanceId("376e0847a2224e95afcd3e607eccd544in07"); body.withResource(resourcebody); body.withAction("resizeFlavor"); request.withBody(body); try { CheckResourceResponse response = client.checkResource(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 33 34 35 36 37 38 39 40 41 42 43 44 45
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckResourceRequest() resourcebody = CheckResourceInfo( enterprise_project_id="0", instance_num=1, mode="Cluster", availability_zone_mode="single", node_num=2, flavor_ref="gaussdb.mysql.xlarge.x86.4", availability_zone="cn-southwest-244b", subnet_id="1e9f71dd-9192-4c0d-9739-161d8dcca68c" ) request.body = CheckResourceRequestBody( resource=resourcebody, action="createInstance" ) response = client.check_resource(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 39
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckResourceRequest() resourcebody = CheckResourceInfo( node_num=1, instance_id="376e0847a2224e95afcd3e607eccd544in07" ) request.body = CheckResourceRequestBody( resource=resourcebody, action="createReadonlyNode" ) response = client.check_resource(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 39
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckResourceRequest() resourcebody = CheckResourceInfo( flavor_ref="gaussdb.mysql.xlarge.x86.4", instance_id="376e0847a2224e95afcd3e607eccd544in07" ) request.body = CheckResourceRequestBody( resource=resourcebody, action="resizeFlavor" ) response = client.check_resource(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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckResourceRequest{} enterpriseProjectIdResource:= "0" instanceNumResource:= int32(1) modeResource:= "Cluster" availabilityZoneModeResource:= "single" nodeNumResource:= int32(2) flavorRefResource:= "gaussdb.mysql.xlarge.x86.4" availabilityZoneResource:= "cn-southwest-244b" subnetIdResource:= "1e9f71dd-9192-4c0d-9739-161d8dcca68c" resourcebody := &model.CheckResourceInfo{ EnterpriseProjectId: &enterpriseProjectIdResource, InstanceNum: &instanceNumResource, Mode: &modeResource, AvailabilityZoneMode: &availabilityZoneModeResource, NodeNum: &nodeNumResource, FlavorRef: &flavorRefResource, AvailabilityZone: &availabilityZoneResource, SubnetId: &subnetIdResource, } request.Body = &model.CheckResourceRequestBody{ Resource: resourcebody, Action: "createInstance", } response, err := client.CheckResource(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
添加只读资源预校验。
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckResourceRequest{} nodeNumResource:= int32(1) instanceIdResource:= "376e0847a2224e95afcd3e607eccd544in07" resourcebody := &model.CheckResourceInfo{ NodeNum: &nodeNumResource, InstanceId: &instanceIdResource, } request.Body = &model.CheckResourceRequestBody{ Resource: resourcebody, Action: "createReadonlyNode", } response, err := client.CheckResource(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
规格变更资源预校验。
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckResourceRequest{} flavorRefResource:= "gaussdb.mysql.xlarge.x86.4" instanceIdResource:= "376e0847a2224e95afcd3e607eccd544in07" resourcebody := &model.CheckResourceInfo{ FlavorRef: &flavorRefResource, InstanceId: &instanceIdResource, } request.Body = &model.CheckResourceRequestBody{ Resource: resourcebody, Action: "resizeFlavor", } response, err := client.CheckResource(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。