All Products
Document Center

Security Center:DescribeComponentAssetForm

Last Updated:Mar 03, 2024

Queries the metadata of assets in a component. The metadata of an asset refers to the fields that describe the asset.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • acs:yundun-sas::{#accountId}:*

Request parameters


The component name.


The language of the content within the response. Valid values:

  • zh: Chinese (default)
  • en: English

Response parameters


The response parameters.


The request ID.


The metadata of the asset in the component. The value is a JSON array and contains the following fields:

  • name: the parameter name.
  • defaultValue: the default parameter value.
  • description: the parameter description.
  • required: indicates whether the parameter is required. Valid values: true and false.
[ { "defaultValue": "", "description": "assetname", "name": "assetname", "required": true } ]


Sample success responses


  "RequestId": "9D1651AC-31CC-5CC4-A14E-626B3FCC1022",
  "ComponentAssetForm": "[\n    {\n        \"defaultValue\": \"\",\n        \"description\": \"assetname\",\n        \"name\": \"assetname\",\n        \"required\": true\n    }\n]"

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history