ListProducts - Security Center - Alibaba Cloud Documentation Center

Retrieves a list of products.

Operation description

The `JsonConfig` request parameter is a complex JSON configuration. A supporting tool class is provided that contains configuration examples. For more information, see the Demo.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListProducts

list

*Product

acs:yundun-sas::{#accountId}:product/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region of the Data Management center for threat analysis. Select the region for the Management Hub based on the region where your assets are located. Valid values: cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: Your assets are in regions outside China.	cn-hangzhou
Lang	string	No	The language of the response. Valid values: zh (default): Chinese. en: English.	zh
RoleFor	integer	No	The user ID of the member. An administrator can specify this parameter to switch to the perspective of this member.	173326*******
ProductIds	array	No	The list of product IDs.
	string	No	The product ID.	alibaba_cloud_sas
ProductName	string	No	The product name.	sas
ProductType	string	No	The product type. Valid values: preset custom	preset
VendorId	string	No	The vendor ID.	vd-qlsw5eocx94w9
MaxResults	integer	No	The maximum number of entries to return.	50
NextToken	string	No	The token that is used to start the next query. You do not need to specify this parameter for the first query. For subsequent queries, set this parameter to the `NextToken` value that is returned from the previous API call.	AAAAAUqcj6VO4E3ECWIrFczs****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	6276D891-***-55B2-87B9-74D413F7**
Products	array<object>	The list of products.
	object	The product.
CreateTime	integer	The time when the product was created.	1733269771123
UpdateTime	integer	The time when the product was updated.	1733269771123
ProductId	string	The product ID.	alibaba_cloud_sas
ProductAlias	string	The product alias.	alibaba_cloud_sas
ProductName	string	This parameter is deprecated.	sas
ProductType	string	The product type. Valid values: preset custom	preset
VendorId	string	The vendor ID.	vd-qlsw5eocx94w9
VendorName	string	The vendor name.	111
DataIngestionStatus	boolean	The data ingestion status. Valid values: true: enabled. false: disabled.	enabled
TotalDataIngestionCount	integer	The total number of data ingestion configurations.	10
EnabledDataIngestionCount	integer	The number of enabled data ingestion configurations.	1
AllowAddDataIngestion	boolean	Indicates whether data collection configurations can be added.	true
AbnormalDataIngestionCount	integer	The number of abnormal data ingestion configurations.	2
ActiveTime	integer	The activation time.	1733269771123
MaxResults	integer	The maximum number of entries returned.	50
NextToken	string	The token that is used to retrieve the next page of results. If the value of this parameter is not empty, more results are available. You can use this token in the next request to retrieve the next page of results.	AAAAAUqcj6VO4E3ECWIrFczs****
TotalCount	integer	The total number of entries returned.	57

Examples

Success response

JSON format

{
  "RequestId": "6276D891-*****-55B2-87B9-74D413F7****",
  "Products": [
    {
      "CreateTime": 1733269771123,
      "UpdateTime": 1733269771123,
      "ProductId": "alibaba_cloud_sas",
      "ProductAlias": "alibaba_cloud_sas",
      "ProductName": "sas",
      "ProductType": "preset",
      "VendorId": "vd-qlsw5eocx94w9",
      "VendorName": "111",
      "DataIngestionStatus": true,
      "TotalDataIngestionCount": 10,
      "EnabledDataIngestionCount": 1,
      "AllowAddDataIngestion": true,
      "AbnormalDataIngestionCount": 2,
      "ActiveTime": 1733269771123
    }
  ],
  "MaxResults": 50,
  "NextToken": "AAAAAUqcj6VO4E3ECWIrFczs****",
  "TotalCount": 57
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.