Batch Updating Layout Pages
Function
This API is used to update a layout.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/wizards
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
layout_wizard_update_pojo_list |
No |
Array of WizardUpdateRequestPojo objects |
Request body list for updating a layout. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
create_time |
No |
String |
Creation time. |
|
creator_id |
No |
String |
Creator ID. |
|
description |
No |
String |
Description. |
|
id |
No |
String |
Layout ID. |
|
wizard_json |
No |
String |
Layout page information. |
|
name |
No |
String |
Layout name. |
|
update_time |
No |
String |
Update time. |
|
layout_id |
No |
String |
Layout ID. |
|
project_id |
No |
String |
Tenant ID. |
|
workspace_id |
No |
String |
Workspace ID. |
|
is_binding |
No |
Boolean |
Whether the button has been associated. |
|
binding_button |
No |
Array of binding_button objects |
Associated button. |
|
boa_version |
No |
String |
BOA base version. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
data |
Array of WizardDetailInfo objects |
Data list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
String |
Creation time. |
|
creator_id |
String |
Creator ID. |
|
description |
String |
Description. |
|
en_description |
String |
English description. |
|
id |
String |
Layout ID. |
|
wizard_json |
String |
Layout page information. |
|
name |
String |
Layout name. |
|
en_name |
String |
Name in English. |
|
update_time |
String |
Update time. |
|
project_id |
String |
Tenant ID. |
|
workspace_id |
String |
Workspace ID. |
|
is_binding |
Boolean |
Whether the button has been associated. |
|
binding_button |
Array of binding_button objects |
Associated button. |
|
is_built_in |
Boolean |
Whether the page is a system page. |
|
boa_version |
String |
BOA base version. |
|
version |
String |
SecMaster edition. |
|
Parameter |
Type |
Description |
|---|---|---|
|
button_id |
String |
Button ID. |
|
button_name |
String |
Button name. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Request body for updating a layout.
{
"layout_wizard_update_pojo_list" : [ {
"layout_id" : "8f7b3080-e528-440b-99c6-44252f149643",
"is_binding" : true,
"binding_button" : [ {
"button_name" : "test",
"button_id" : "123"
} ],
"workspace_id" : "d7310f19-56d3-4556-b4ea-328a7899a6ba",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"name" : "batchClose",
"boa_version" : "V3",
"id" : "7f058f3a-f954-4506-80ea-c60872000b1b"
} ]
}
Example Responses
Status code: 200
Response to successful layout update.
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"data" : [ {
"id" : "7f058f3a-f954-4506-80ea-c60872000b1b",
"name" : "batchClose",
"workspace_id" : "7f058f3a-f954-4506-80ea-c60872000b1b"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
Request body for updating a layout.
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 67 68 69 70 71 |
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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdateLayoutWizardsSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); UpdateLayoutWizardsRequest request = new UpdateLayoutWizardsRequest(); request.withWorkspaceId("{workspace_id}"); WizardUpdateRequestPojos body = new WizardUpdateRequestPojos(); List<WizardUpdateRequestPojoBindingButton> listLayoutWizardUpdatePojoListBindingButton = new ArrayList<>(); listLayoutWizardUpdatePojoListBindingButton.add( new WizardUpdateRequestPojoBindingButton() .withButtonId("123") .withButtonName("test") ); List<WizardUpdateRequestPojo> listbodyLayoutWizardUpdatePojoList = new ArrayList<>(); listbodyLayoutWizardUpdatePojoList.add( new WizardUpdateRequestPojo() .withId("7f058f3a-f954-4506-80ea-c60872000b1b") .withName("batchClose") .withLayoutId("8f7b3080-e528-440b-99c6-44252f149643") .withProjectId("81fee81ab75a48a7b38e6586868688e7") .withWorkspaceId("d7310f19-56d3-4556-b4ea-328a7899a6ba") .withIsBinding(true) .withBindingButton(listLayoutWizardUpdatePojoListBindingButton) .withBoaVersion("V3") ); body.withLayoutWizardUpdatePojoList(listbodyLayoutWizardUpdatePojoList); request.withBody(body); try { UpdateLayoutWizardsResponse response = client.updateLayoutWizards(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()); } } } |
Request body for updating a layout.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateLayoutWizardsRequest() request.workspace_id = "{workspace_id}" listBindingButtonLayoutWizardUpdatePojoList = [ WizardUpdateRequestPojoBindingButton( button_id="123", button_name="test" ) ] listLayoutWizardUpdatePojoListbody = [ WizardUpdateRequestPojo( id="7f058f3a-f954-4506-80ea-c60872000b1b", name="batchClose", layout_id="8f7b3080-e528-440b-99c6-44252f149643", project_id="81fee81ab75a48a7b38e6586868688e7", workspace_id="d7310f19-56d3-4556-b4ea-328a7899a6ba", is_binding=True, binding_button=listBindingButtonLayoutWizardUpdatePojoList, boa_version="V3" ) ] request.body = WizardUpdateRequestPojos( layout_wizard_update_pojo_list=listLayoutWizardUpdatePojoListbody ) response = client.update_layout_wizards(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Request body for updating a layout.
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 67 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateLayoutWizardsRequest{} request.WorkspaceId = "{workspace_id}" buttonNameBindingButton:= "test" var listBindingButtonLayoutWizardUpdatePojoList = []model.WizardUpdateRequestPojoBindingButton{ { ButtonId: "123", ButtonName: &buttonNameBindingButton, }, } idLayoutWizardUpdatePojoList:= "7f058f3a-f954-4506-80ea-c60872000b1b" nameLayoutWizardUpdatePojoList:= "batchClose" layoutIdLayoutWizardUpdatePojoList:= "8f7b3080-e528-440b-99c6-44252f149643" projectIdLayoutWizardUpdatePojoList:= "81fee81ab75a48a7b38e6586868688e7" workspaceIdLayoutWizardUpdatePojoList:= "d7310f19-56d3-4556-b4ea-328a7899a6ba" isBindingLayoutWizardUpdatePojoList:= true boaVersionLayoutWizardUpdatePojoList:= "V3" var listLayoutWizardUpdatePojoListbody = []model.WizardUpdateRequestPojo{ { Id: &idLayoutWizardUpdatePojoList, Name: &nameLayoutWizardUpdatePojoList, LayoutId: &layoutIdLayoutWizardUpdatePojoList, ProjectId: &projectIdLayoutWizardUpdatePojoList, WorkspaceId: &workspaceIdLayoutWizardUpdatePojoList, IsBinding: &isBindingLayoutWizardUpdatePojoList, BindingButton: &listBindingButtonLayoutWizardUpdatePojoList, BoaVersion: &boaVersionLayoutWizardUpdatePojoList, }, } request.Body = &model.WizardUpdateRequestPojos{ LayoutWizardUpdatePojoList: &listLayoutWizardUpdatePojoListbody, } response, err := client.UpdateLayoutWizards(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 |
Response to successful layout update. |
|
400 |
Error response. |
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