Changing the Cluster Billing Mode from Pay-per-use to Yearly/Monthly
Function
This API is used to change the cluster billing mode from pay-per-use to yearly/monthly.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/cluster/{cluster_id}/period
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A |
cluster_id |
Yes |
String |
Definition: ID of the cluster that you want to change the billing mode to yearly/monthly. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
period_type |
Yes |
Integer |
Definition: Subscription period type. Constraints: N/A Value range:
Default value: N/A |
period_num |
Yes |
Integer |
Definition: Number of subscription periods. Constraints: N/A Value range:
Default value: N/A |
is_auto_renew |
No |
Integer |
Definition: Whether to automatically renew the subscription. If this parameter is not specified, the subscription is not automatically renewed. Constraints: N/A Value range:
Default value: 0 |
is_auto_pay |
No |
Integer |
Definition: Whether to enable automatic payment from your Huawei Cloud account. Constraints: This parameter takes effect only for yearly/monthly clusters. Value range:
Default value: 0 |
console_url |
No |
String |
Definition: URL of the cloud service console. After the subscription is completed, this URL can be used to switch to the cloud service console page to view the information. (This parameter is used only for manual payment.) Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
orderId |
String |
Definition: Order ID. (The order is a new purchase.) Value range: N/A |
Example Requests
Change the cluster billing mode from pay-per-use to yearly/monthly.
POST https://{Endpoint}/v1.0/{project_id}/cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/period { "period_type" : 2, "period_num" : 1, "is_auto_renew" : 1, "is_auto_pay" : 0, "console_url" : "https://console.xxx.huawei.com/elasticsearch-pre/?locale=zh-cn®ion=xxx#/es/management/elasticsearch" }
Example Responses
Status code: 200
Request succeeded.
{ "orderId" : "CS2112281600EBHKR" }
SDK Sample Code
The SDK sample code is as follows.
Java
Change the cluster billing mode from pay-per-use to yearly/monthly.
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 |
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.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class UpdateOndemandClusterToPeriodSolution { 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); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); UpdateOndemandClusterToPeriodRequest request = new UpdateOndemandClusterToPeriodRequest(); request.withClusterId("{cluster_id}"); PeriodReq body = new PeriodReq(); body.withConsoleUrl("https://console.xxx.huawei.com/elasticsearch-pre/?locale=zh-cn®ion=xxx#/es/management/elasticsearch"); body.withIsAutoPay(0); body.withIsAutoRenew(1); body.withPeriodNum(1); body.withPeriodType(2); request.withBody(body); try { UpdateOndemandClusterToPeriodResponse response = client.updateOndemandClusterToPeriod(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
Change the cluster billing mode from pay-per-use to yearly/monthly.
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 huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.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 = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateOndemandClusterToPeriodRequest() request.cluster_id = "{cluster_id}" request.body = PeriodReq( console_url="https://console.xxx.huawei.com/elasticsearch-pre/?locale=zh-cn®ion=xxx#/es/management/elasticsearch", is_auto_pay=0, is_auto_renew=1, period_num=1, period_type=2 ) response = client.update_ondemand_cluster_to_period(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
Change the cluster billing mode from pay-per-use to yearly/monthly.
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/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 := css.NewCssClient( css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateOndemandClusterToPeriodRequest{} request.ClusterId = "{cluster_id}" consoleUrlPeriodReq:= "https://console.xxx.huawei.com/elasticsearch-pre/?locale=zh-cn®ion=xxx#/es/management/elasticsearch" isAutoPayPeriodReq:= int32(0) isAutoRenewPeriodReq:= int32(1) request.Body = &model.PeriodReq{ ConsoleUrl: &consoleUrlPeriodReq, IsAutoPay: &isAutoPayPeriodReq, IsAutoRenew: &isAutoRenewPeriodReq, PeriodNum: int32(1), PeriodType: int32(2), } response, err := client.UpdateOndemandClusterToPeriod(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Invalid request. Modify the request before retry. |
403 |
Identity authentication failed. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot