Taking Services Offline in Batches
Function
Bring offline in batches.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/design/approvals/batch-offline
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
biz_infos |
Yes |
Array of BizInfoVO objects |
Service information list. |
approver_user_id |
Yes |
String |
Approver ID. |
approver_user_name |
Yes |
String |
Approver name. |
|
No |
String |
Email address of the approver. This parameter is set only when the approver is created. |
fast_approval |
No |
Boolean |
Quick approval, which is an informal scenario and is used for quick experience. This function is provided only when the current user has the approval permission. |
schedule_time |
No |
String |
Job scheduling time. For example, 30_18, indicating 18:30. |
env_type |
No |
String |
Type of the development and production environment. Options:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
biz_id |
Yes |
String |
Business ID, which is a string |
biz_type |
Yes |
String |
Business entity type. Options:
|
env_type |
No |
String |
Type of the development and production environment. Options:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
Number of successful batch offline results. |
Parameter |
Type |
Description |
---|---|---|
value |
BatchOperationVO object |
Returned result of the batch offline operation. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Batch approval ID, which is a string |
tenant_id |
String |
Project ID. |
group_id |
String |
Group ID, which is a string |
biz_name |
String |
Service name. |
biz_id |
String |
Business ID, which is a string |
operation_status |
String |
Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options:
|
operation_type |
String |
Indicates the type. |
biz_info |
String |
Service details. |
create_by |
String |
Creator. |
remark |
String |
Indicates the remark information. |
total |
Integer |
Total number. |
success |
Integer |
Number of successful operations. |
failed |
Integer |
Indicates the number of failed operations. |
rate |
String |
Indicates the current progress. |
logs |
String |
Logs. |
groups |
Array of BatchOperationVO objects |
Group information. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Example Requests
Bring physical tables offline in batches based on parameters such as physical table IDs.
POST https://{endpoint}/v2/{project_id}/design/approvals/batch-offline?from=standard { "biz_infos" : [ { "biz_id" : "1229920251379118081", "biz_type" : "TABLE_MODEL" }, { "biz_id" : "1222853173564289024", "biz_type" : "TABLE_MODEL" } ], "approver_user_id" : "0833a573fe80d5401f6dc010a775569a", "approver_user_name" : "test_uesr", "email" : null, "fast_approval" : true }
Example Responses
Status code: 200
This operation succeeds, and the returned data is the BatchOperationVO object. The batch object is in the BatchOperationVO.group attribute.
{ "data" : { "value" : { "id" : null, "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "group_id" : "1230939932055457792", "biz_name" : null, "biz_id" : null, "operation_status" : "SUCCESS", "operation_type" : "OFFLINE", "biz_info" : null, "create_by" : "test_uesr", "remark" : null, "total" : 2, "success" : 2, "failed" : 0, "rate" : "1.00", "logs" : null, "groups" : [ { "id" : "1230939939395489792", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "group_id" : "1230939932055457792", "biz_name" : "test_czh_0416", "biz_id" : "1229920251379118081", "operation_status" : "SUCCESS", "operation_type" : "OFFLINE", "biz_info" : "{}", "create_by" : "test_uesr", "remark" : "PASSED", "total" : 0, "success" : 0, "failed" : 0, "rate" : null, "logs" : null, "groups" : null }, { "id" : "1230939939395489793", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "group_id" : "1230939932055457792", "biz_name" : "test_czh_0328", "biz_id" : "1222853173564289024", "operation_status" : "SUCCESS", "operation_type" : "OFFLINE", "biz_info" : "{}", "create_by" : "test_uesr", "remark" : "PASSED", "total" : 0, "success" : 0, "failed" : 0, "rate" : null, "logs" : null, "groups" : null } ] } } }
Status code: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
Status code: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
Status code: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
Status code: 404
{ "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." }
SDK Sample Code
The SDK sample code is as follows.
Bring physical tables offline in batches based on parameters such as physical table IDs.
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 61 62 63 64 65 66 |
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.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; import java.util.List; import java.util.ArrayList; public class BatchOfflineSolution { 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); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); BatchOfflineRequest request = new BatchOfflineRequest(); ApprovalBatchParam body = new ApprovalBatchParam(); List<BizInfoVO> listbodyBizInfos = new ArrayList<>(); listbodyBizInfos.add( new BizInfoVO() .withBizId("1229920251379118081") .withBizType(BizInfoVO.BizTypeEnum.fromValue("TABLE_MODEL")) ); listbodyBizInfos.add( new BizInfoVO() .withBizId("1222853173564289024") .withBizType(BizInfoVO.BizTypeEnum.fromValue("TABLE_MODEL")) ); body.withFastApproval(true); body.withApproverUserName("test_uesr"); body.withApproverUserId("0833a573fe80d5401f6dc010a775569a"); body.withBizInfos(listbodyBizInfos); request.withBody(body); try { BatchOfflineResponse response = client.batchOffline(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()); } } } |
Bring physical tables offline in batches based on parameters such as physical table IDs.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.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 = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchOfflineRequest() listBizInfosbody = [ BizInfoVO( biz_id="1229920251379118081", biz_type="TABLE_MODEL" ), BizInfoVO( biz_id="1222853173564289024", biz_type="TABLE_MODEL" ) ] request.body = ApprovalBatchParam( fast_approval=True, approver_user_name="test_uesr", approver_user_id="0833a573fe80d5401f6dc010a775569a", biz_infos=listBizInfosbody ) response = client.batch_offline(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Bring physical tables offline in batches based on parameters such as physical table IDs.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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 := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchOfflineRequest{} bizTypeBizInfos:= model.GetBizInfoVoBizTypeEnum().TABLE_MODEL bizTypeBizInfos1:= model.GetBizInfoVoBizTypeEnum().TABLE_MODEL var listBizInfosbody = []model.BizInfoVo{ { BizId: "1229920251379118081", BizType: &bizTypeBizInfos, }, { BizId: "1222853173564289024", BizType: &bizTypeBizInfos1, }, } fastApprovalApprovalBatchParam:= true request.Body = &model.ApprovalBatchParam{ FastApproval: &fastApprovalApprovalBatchParam, ApproverUserName: "test_uesr", ApproverUserId: "0833a573fe80d5401f6dc010a775569a", BizInfos: listBizInfosbody, } response, err := client.BatchOffline(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
This operation succeeds, and the returned data is the BatchOperationVO object. The batch object is in the BatchOperationVO.group attribute. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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