Updating a Layout Module
Function
This API is used to update a layout module.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/modules/{module_id}
|
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 |
|
module_id |
Yes |
String |
Module ID. |
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 |
|---|---|---|---|
|
cloud_pack_id |
No |
String |
Subscription package ID. |
|
cloud_pack_name |
No |
String |
Subscription package name. |
|
cloud_pack_version |
No |
String |
Subscription package version. |
|
description |
No |
String |
Description. |
|
module_json |
No |
String |
Layout module information. |
|
name |
Yes |
String |
Name. |
|
update_time |
No |
String |
Update time. |
|
thumbnail |
No |
String |
Module thumbnail. |
|
module_type |
No |
String |
Module type, which can be tab or section. |
|
metric_ids |
No |
String |
ID of the metric associated with the section module. |
|
data_query |
No |
String |
Data query mode. |
|
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. |
|
message |
String |
Error message. |
|
request_id |
String |
Request id |
|
success |
Boolean |
Request result. |
|
data |
ModuleDetailInfo object |
Module details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
cloud_pack_id |
String |
Subscription package ID. |
|
cloud_pack_name |
String |
Subscription package name. |
|
cloud_pack_version |
String |
Subscription package version. |
|
create_time |
String |
Create time |
|
creator_id |
String |
Creator id value |
|
description |
String |
Description. |
|
en_description |
String |
English description. |
|
id |
String |
IID |
|
module_json |
String |
Module information. When the module is an indicator card, the id field in items is also the indicator ID. |
|
name |
String |
Name. |
|
en_name |
String |
Name in English. |
|
project_id |
String |
Tenant ID. |
|
workspace_id |
String |
Workspace ID. |
|
update_time |
String |
Update time. |
|
thumbnail |
String |
Module thumbnail. |
|
module_type |
String |
Module type, which can be tab or section. |
|
tag |
String |
Module tag. |
|
is_built_in |
Boolean |
Whether the module is a system module. |
|
data_query |
String |
Data query mode. |
|
boa_version |
String |
BOA base version. |
|
version |
String |
SecMaster edition. |
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
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response to the request for updating a module. |
|
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